BuyShared
Order one supported shared-hosting product.
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. The authenticated client may only address services and records owned by that client.
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 shared-hosting alias from Product Codes. |
domain | domain name | Yes | Domain for the hosting account. |
billingcycle | string | Yes | Supported billing cycle. |
domaintype | register|transfer|owndomain|empty | No | How WHMCS should treat the domain. |
regperiod | integer 1-10 | No | Domain period when registering/transferring. |
eppcode | string | No | EPP code for a transfer. |
nameserver1 | domain name | No | First nameserver. |
nameserver2 | domain name | No | Second nameserver. |
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=BuyShared" \
--data-urlencode "api_key=${SHAPI_API_KEY}" \
--data-urlencode "api_secret=${SHAPI_API_SECRET}" \
--data-urlencode "pid=aruwimiriver" \
--data-urlencode "domain=example.com" \
--data-urlencode "billingcycle=monthly" \
--data-urlencode "domaintype=owndomain"Response
SHAPI always returns JSON. Check result; panel responses can vary by the server module and DirectAdmin version.
{
"result": "success",
"message": {
"action": "BuyShared",
"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.
