load-average — WAP API
Server load average through the WAP root administrator API, with request fields, response details, errors and cURL/Python/PHP examples.
/api/v1/load-average/Also accepts GETReturns 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
| Property | Value |
|---|---|
| Methods | GET, POST |
| Versioned path | /api/v1/load-average/ |
| Default path | /api/load-average/ |
| 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": {
"load_average": "0.25 0.4 0.3"
},
"info": "Current server load",
"status": 200
}| Field | Type | Meaning |
|---|---|---|
status | integer | 200 on the documented success branch. |
info | string | Operation description. |
data | object | Operation data described below. |
data.load_average | string | String containing 1, 5 and 15 minute load averages separated by spaces. |
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 |
| Unsupported method | 405 after authentication | Method-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.