Skip to Content
Browse documentation

load-average — WAP API

Server load average through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.

POST/api/v1/load-average/Also accepts GET

Returns the operating-system load averages for the last 1, 5 and 15 minutes, in that order. These are scheduler load values, not CPU percentages. This handler has no demo-mode wrapper and no custom exception envelope.

Request

PropertyValue
MethodsGET, POST
Versioned path/api/v1/load-average/
Default path/api/load-average/
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": {
    "load_average": "0.25 0.4 0.3"
  },
  "info": "Current server load",
  "status": 200
}
FieldTypeMeaning
statusinteger200 on the documented success branch.
infostringOperation description.
dataobjectOperation data described below.
data.load_averagestringString containing 1, 5 and 15 minute load averages separated by spaces.

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
Unsupported method405 after authenticationMethod-not-allowed response.

This operation is not wrapped by the API demo restriction. Other authenticated operations can still be blocked on a demo server.

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.