domainsAdd
Add a domain or subdomain to an owned hosting service.
Endpoint: https://sive.host/modules/addons/shapi/sh-api.php
Method: POST using application/x-www-form-urlencoded.
Changes account or service state. Access is limited to directly owned records or explicitly assigned Partner-managed client services after both relationships are verified.
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. |
type | domain|subdomain | No | Defaults to domain. |
name | domain name | Yes | Domain or subdomain to add. |
path | path | No | Optional document root. |
autossl | 0|1 | No | Request automatic SSL; default 1. |
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=domainsAdd" \
--data-urlencode "api_key=${SHAPI_API_KEY}" \
--data-urlencode "api_secret=${SHAPI_API_SECRET}" \
--data-urlencode "serviceid=12345" \
--data-urlencode "type=domain" \
--data-urlencode "name=site.example.com" \
--data-urlencode "path=/public_html/site" \
--data-urlencode "autossl=1"Response
SHAPI always returns JSON. Check result; panel responses can vary by the server module and DirectAdmin version.
{
"result": "success",
"message": {
"action": "domainsAdd",
"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.
