Skip to Content
Browse documentation

listaccts — WAP API

List hosting accounts through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.

POST/api/v1/listaccts/Also accepts GET

Returns stored hosting accounts keyed by username, with is_suspended and is_reseller as yes/no strings; reseller records include reseller_data. Individual unreadable records are skipped, so a successful response can be incomplete. There are no declared pagination, search or sort parameters; helper processing follows sorted registry filenames. This endpoint does not add the current usage fields provided by accountsummary/usagestatistics.

Request

PropertyValue
MethodsGET, POST
Versioned path/api/v1/listaccts/
Default path/api/listaccts/
AuthenticationWAP root administrator API credentials.
HeaderRequired value
X-API-USERYour WAP API username.
X-API-PASSWORDIts 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": {
      "exampleuser": {
        "user": "exampleuser",
        "domain": "example.com",
        "is_suspended": "no",
        "is_reseller": "no"
      }
    }
  },
  "info": "Return eenos 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 {}.

Account record contents are not a fixed public schema. Fields such as user/domain and nested limits depend on account configuration; reseller_data appears only where the handler adds it. Do not expose entire administrator responses to an end-user browser.

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 WAP API authentication and connection troubleshooting.