Skip to Content
Browse documentation

terminatereseller — Reseller API

Terminate a reseller and its accounts through the Reseller API, with request fields, response details, errors and cURL/Python/PHP examples.

POST/api/v1/terminatereseller/Also accepts GET

Permanently removes the reseller and its account tree through the reseller-wide removal command. This is broader than removing one hosting account and has no dry-run or additional confirmation parameter. Review all affected customers and retain tested backups before calling it. The wrapper does not check the CLI exit status; verify the actual removals and server logs even when the API returns success. The selected subreseller must be present in the authenticated reseller accounts list. The operation is dispatched through the reseller task interface; the downstream reseller-wide wrapper still does not validate the CLI exit status.

Request

The selected account must be in the authenticated reseller accounts list and have a hosting-user file. Other resellers’ accounts are rejected with HTTP 400 and JSON status 400; this is an ownership check, not an authentication failure.

PropertyValue
MethodsGET, POST
Versioned path/api/v1/terminatereseller/
Default path/api/terminatereseller/
AuthenticationReseller API credentials.
HeaderRequired value
X-RESELLERThe reseller account owning these API credentials.
X-API-USERYour Reseller API username.
X-API-PASSWORDIts API password.

Parameters

FieldRequiredType and behavior
userYesString. Existing reseller username; required state is described above.

POST reads the JSON/form body; GET reads query parameters. The examples use form-encoded POST. Although GET is supported, use POST for account changes and login-link generation so action fields are not placed in URLs. Authentication remains in the two headers. Undeclared fields are not additional API options.

Replace server.example.com, examplereseller, billing_api and YOUR_API_PASSWORD in each standalone example. Replace operation sample values with your actual target and an existing package where required. Python needs Requests; PHP needs the cURL extension. These examples make real calls when run.

Permanent removal

This request deletes hosting resources. Verify the target and affected account tree and retain tested backups before running an example.

Success response

HTTP 200. Illustrative values; account records and server values vary. Stored account examples show only selected fields.

{
  "data": "Reseller account terminated exampleuser",
  "info": "Hosting reseller account terminated successfully",
  "status": 200
}
FieldTypeMeaning
statusinteger200 on the documented success branch.
infostringOperation description.
datastringSuccess message.

Verify the resulting account state and logs independently: the command wrapper does not validate the CLI exit code.

Errors and demo mode

ConditionActual HTTP statusResponse behavior
Missing credentials with no other authenticated identity403detail: Authentication credentials were not provided.
Rejected password or source IP403detail: Invalid API credentials
Demo server400error: Demo server; info: Api Operations not available in demo server; JSON status: 403.
Invalid/missing operation fields or invalid target state400Field errors in error; JSON status: 400.
Backend reports failure400Operation error in error; JSON status: 500.
Unsupported method405 after authenticationMethod-not-allowed response.

Validation failure description: Unable to terminate reseller hosting account. The data is invalid.

Check both the HTTP status and JSON shape. Authentication failures do not use the operation envelope. Unexpected uncaught server errors are not guaranteed to return the documented JSON shape. Do not automatically retry account creation, password changes, deletions or SSO generation after a timeout: confirm the actual state first.

See Reseller API authentication and connection troubleshooting.