ListComputeOrderOptions
List product-linked operating systems and, after an OS is selected, only the compatible application recipes.
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
- Ubuntu 24.04 is tested and recommended for application recipes.
- Ubuntu 26.04 and Debian 12/13 application recipes are unverified; the response includes this disclaimer.
- All other operating systems return no application choices.
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. |
pid | product alias | Yes | Supported compute product alias from Product Codes. |
os | OS template, alias, name, or option ID | No | Selected OS. Omit first to list OS choices, then call again with the choice to list 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=ListComputeOrderOptions" \
--data-urlencode "api_key=${SHAPI_API_KEY}" \
--data-urlencode "api_secret=${SHAPI_API_SECRET}" \
--data-urlencode "pid=benueriver" \
--data-urlencode "os=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",
"message": {
"action": "ListComputeOrderOptions",
"data": "Panel- or action-specific response"
}
}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.
