Skip to Content
Browse documentation

accountsummary — WAP API

Read an account summary through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.

POST/api/v1/accountsummary/Also accepts GET

Reads the stored hosting-account record for one existing user, adding is_suspended and is_reseller as yes/no strings. Resellers also include reseller_data and reseller usage fields. quota_usage and bandwidth_usage are current-month recorded MB values, not a live filesystem scan. The exact stored account fields depend on the server and account configuration. The response is sensitive administrator data; retain only the fields your integration needs.

Request

PropertyValue
MethodsGET, POST
Versioned path/api/v1/accountsummary/
Default path/api/accountsummary/
AuthenticationWAP root administrator API credentials.
HeaderRequired value
X-API-USERYour WAP API username.
X-API-PASSWORDIts API password.

Parameters

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

POST reads the JSON/form body; GET reads query parameters. The examples use form-encoded POST. Authentication remains in the two headers. Undeclared fields are not additional API options.

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": {
    "acct": {
      "user": "exampleuser",
      "domain": "example.com",
      "is_suspended": "no",
      "is_reseller": "no",
      "quota_usage": 128,
      "bandwidth_usage": 512
    }
  },
  "info": "Hosting account summary of user exampleuser",
  "status": 200
}
FieldTypeMeaning
statusinteger200 on the documented success branch.
infostringOperation description.
dataobjectOperation data described below.
data.acctobjectStored account object with flags and recorded usage; optional reseller fields appear for reseller accounts.

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.

is_suspended and is_reseller are strings (yes/no), not booleans. quota_usage and bandwidth_usage are recorded current-month MB values; reseller records also contain quota_usage_reseller and bandwidth_usage_reseller.

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 read hosting account summary. 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 WAP API authentication and connection troubleshooting.