Skip to Content
Browse documentation

listsuspended — Reseller API

List suspended accounts through the Reseller API, with request fields, response details, errors and cURL/Python/PHP examples.

POST/api/v1/listsuspended/Also accepts GET

Returns suspension records for entries in the authenticated reseller accounts list. Entries need a suspension file; unreadable suspension records are skipped. Missing, unreadable or incorrectly shaped reseller registry data returns an empty object. No pagination or filter fields are declared.

Request

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

No endpoint-specific query or body fields are required.

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.

Success response

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

{
  "data": {
    "accounts": {}
  },
  "info": "Suspend hosting accounts",
  "status": 200
}
FieldTypeMeaning
statusinteger200 on the documented success branch.
infostringOperation description.
dataobjectOperation data described below.
data.accountsobjectObject keyed by hosting username; an empty collection is {}.

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.
Caught backend exception400Exception text in error; JSON status: 500.
Unsupported method405 after authenticationMethod-not-allowed response.

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.