ListComputeReinstallOptions
List operating systems and optional application recipes allowed for reinstalling an owned active VPS.
Endpoint: https://sive.host/modules/addons/shapi/sh-api.php
Method: POST using application/x-www-form-urlencoded.
Read-only action. Access is limited to directly owned records or explicitly assigned Partner-managed client services after both relationships are verified.
Important behavior
- The reinstall action validates that the selected template is synchronized to the VM current node before deleting anything.
- Apps are shown only for Ubuntu 24.04 (tested), Ubuntu 26.04 (unverified), and Debian 12/13 (unverified). Other OS selections return no apps.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
action | string | Yes | Exact SHAPI action name shown in this article. |
api_key | string | Yes | Client API key generated in the Sive.Host SHAPI page. |
api_secret | string | Yes | Secret paired with the API key. Send it only in the POST body. |
serviceid | positive integer | Yes | Active WHMCS service ID owned by the authenticated client. |
os_template | OS template, alias, name, or option ID | No | Selected OS. Omit first to list choices, then call again with the choice for compatible apps. |
search | string | No | Filter operating-system and application names. |
offset | non-negative integer | No | Application pagination offset; default 0. |
limit | integer 1-100 | No | Application page size; default 50. |
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=ListComputeReinstallOptions" \
--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 "offset=0" \
--data-urlencode "limit=50"Response
SHAPI always returns JSON. Check result; panel responses can vary by the server module and DirectAdmin version.
{
"result": "success",
"serviceid": 12345,
"operating_systems": [
{
"template": "ubuntu24.04lts",
"name": "Ubuntu 24.04 LTS",
"optionid": 316
}
],
"applications": [
{
"app_option_id": 340,
"name": "None"
}
],
"applications_total": 1
}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.
