listsuspended — WAP API
List suspended accounts through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.
/api/v1/listsuspended/Also accepts GETReturns suspended-account registry records keyed by username, only where a corresponding hosting-user file exists. The inner record comes from stored suspension data and can vary; an empty result is an empty object. No pagination or filter fields are declared.
Request
| Property | Value |
|---|---|
| Methods | GET, POST |
| Versioned path | /api/v1/listsuspended/ |
| Default path | /api/listsuspended/ |
| Authentication | WAP root administrator API credentials. |
| Header | Required value |
|---|---|
X-API-USER | Your WAP API username. |
X-API-PASSWORD | Its API password. |
No endpoint-specific query or body fields are required.
Replace server.example.com, 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
}| Field | Type | Meaning |
|---|---|---|
status | integer | 200 on the documented success branch. |
info | string | Operation description. |
data | object | Operation data described below. |
data.accounts | object | Object keyed by hosting username; an empty collection is {}. |
Errors and demo mode
| Condition | Actual HTTP status | Response behavior |
|---|---|---|
| Missing credentials with no other authenticated identity | 403 | detail: Authentication credentials were not provided. |
| Rejected password or source IP | 403 | detail: Invalid API credentials |
| Demo server | 400 | error: Demo server; info: Api Operations not available in demo server; JSON status: 403. |
| Caught backend exception | 400 | Exception text in error; JSON status: 500. |
| Unsupported method | 405 after authentication | Method-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.