BuyComputePrivateNetwork

Buy and provision the one managed private internal network available to an eligible VPS.

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

The setup fee is one-time. Provisioning runs after payment and is idempotent if a request is repeated.
Only eligible QEMU products configured for the managed zambezi SDN can purchase this resource, with a maximum of one per VM.

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.
`quantity`	integer 1	Yes	Exactly one private network.
`expected_total`	number	Yes	Exact numeric total from a fresh QuoteComputeResource response.
`confirm_purchase`	true	Yes	Must be true after explicit confirmation of target and price.

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=BuyComputePrivateNetwork" \
  --data-urlencode "api_key=${SHAPI_API_KEY}" \
  --data-urlencode "api_secret=${SHAPI_API_SECRET}" \
  --data-urlencode "serviceid=12345" \
  --data-urlencode "quantity=1" \
  --data-urlencode "expected_total=995.00" \
  --data-urlencode "confirm_purchase=true"

Response

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

{
    "result": "success",
    "message": {
        "action": "BuyComputePrivateNetwork",
        "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.

מאגר מידע

קטגוריות

קטגוריות

ענן תגיות

פניות ומידע