ReinstallCompute Print

  • 0

ReinstallCompute

Erase and reinstall an owned active Proxmox VPS with an allowed operating system and optional application recipe.

Endpoint: https://sive.host/modules/addons/shapi/sh-api.php

Method: POST using application/x-www-form-urlencoded.

Consequential action: may purchase, delete, replace credentials, or remove data. Access is limited to directly owned records or explicitly assigned Partner-managed client services after both relationships are verified.

Important behavior

  • This operation permanently erases the primary server data.
  • The hardened Proxmox module checks ownership, active status, product permission, template allowlist and current-node availability, VM locks, duplicate jobs, and disk/storage capacity before queueing deletion.
  • Firewall rules and valid additional disks are preserved by the reinstall workflow.
  • SHAPI rejects app_option_id for any incompatible OS before the Proxmox module is called.
  • The existing WHMCS service username and password are preserved; this action accepts no credential replacement fields.

Request parameters

ParameterTypeRequiredDescription
actionstringYesExact SHAPI action name shown in this article.
api_keystringYesClient API key generated in the Sive.Host SHAPI page.
api_secretstringYesSecret paired with the API key. Send it only in the POST body.
serviceidpositive integerYesActive WHMCS service ID owned by the authenticated client.
os_templatestringYesTemplate value returned by ListComputeReinstallOptions.
app_option_idpositive integerNoOptional application ID returned by ListComputeReinstallOptions; omit to select None.
confirm_data_losstrueYesMust be true after explicit confirmation that all server data will be erased.

Example request

Set the four environment variables from the authenticated SHAPI page. Do not put credentials in source control or URLs.

curl --request POST 'https://sive.host/modules/addons/shapi/sh-api.php' \
  --user "${SHAPI_HTTP_USER}:${SHAPI_HTTP_PASSWORD}" \
  --header 'Accept: application/json' \
  --data-urlencode "action=ReinstallCompute" \
  --data-urlencode "api_key=${SHAPI_API_KEY}" \
  --data-urlencode "api_secret=${SHAPI_API_SECRET}" \
  --data-urlencode "serviceid=12345" \
  --data-urlencode "os_template=ubuntu24.04lts" \
  --data-urlencode "confirm_data_loss=true"

Response

SHAPI always returns JSON. Check result; panel responses can vary by the server module and DirectAdmin version.

{
    "result": "success",
    "serviceid": 12345,
    "status": "queued",
    "os_template": "ubuntu24.04lts"
}

Common errors

  • Unauthorized access!: source IP or HTTP Basic authentication failed.
  • Invalid API Key or secret.: the customer key is wrong, disabled, or deleted.
  • Unable to retrieve an active service owned by this client.: the service is inactive or belongs to another client.
  • Missing required parameters.: one or more required fields were omitted.

SHAPI documentation version 2.0 — generated from the current endpoint contract.


Was this answer helpful?
Back