Skip to Content
Browse documentation

get_current_users_count — WAP API

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

POST/api/v1/get_current_users_count/Also accepts GET

Counts matching entries in the hosting-user registry. The result includes hosting accounts regardless of suspension state and is not the number of websites, domains or active sessions. The helper counts the registry glob without filtering entries further.

Request

PropertyValue
MethodsGET, POST
Versioned path/api/v1/get_current_users_count/
Default path/api/get_current_users_count/
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": {
    "users": 12
  },
  "info": "Total number of eenos hosting accounts",
  "status": 200
}
FieldTypeMeaning
statusinteger200 on the documented success branch.
infostringOperation description.
dataobjectOperation data described below.
data.usersintegerNumber of matching hosting-account registry entries.

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.