Skip to Content
Browse documentation

WAP API — Root Administrator API

Understand the Eenos WAP root administrator API, its HTTPS base URLs, authentication headers, request formats and response handling.

The WAP API provides root administrator access for server integrations. Create credentials in WAP → Preferences → API Manager. The API username/password are separate from the operating-system root credentials.

Administrator-level credentials

WAP API credentials authenticate as a root administrator API identity. API Manager does not offer per-endpoint permission scopes. Keep credentials on a trusted backend and restrict source IPs where possible; do not embed them in browser JavaScript.

Base URLs

Replace server.example.com with your server's HTTPS hostname.

Base URLMeaning
https://server.example.com:5555/api/Default WAP API routes.
https://server.example.com:5555/api/v1/Explicit v1 routes used in this reference.

Both currently route to the installed v1 handlers. Keep the trailing slash in examples and use the direct HTTPS hostname with a valid certificate. The port is the WAP HTTPS port; RAPP and UAPP login ports are not interchangeable API destinations.

Authentication headers

Send these on every API request:

HeaderValue
X-API-USERThe username created in WAP API Manager.
X-API-PASSWORDThat API account's password.

Authentication verifies the stored password hash and, for restricted accounts, the configured source-IP allowlist. A correct password alone does not bypass that restriction.

Legacy requests can supply apiuser and apiauth in the body or query string. Headers are preferred; keep passwords out of URLs. Nonempty headers take precedence over the legacy fields, so remove stale credentials instead of sending conflicting values.

Existing browser sessions and other configured authentication classes can affect a request made from a signed-in browser. The examples use an independent client with API headers and no panel-session cookies, so they test the integration's API credentials.

Requests and responses

All 25 current WAP operations accept GET and POST. Use the fields documented for each endpoint: POST reads the body and GET reads query parameters. The current API supports JSON, form and multipart parsing where a handler needs request data. The examples use POST; use it for changes and SSO generation to keep action fields out of URLs. Do not assume every operation accepts the same fields.

Operation responses commonly contain data, info and a numeric status. Read the actual HTTP status as well as the JSON: some failures return an HTTP code different from the body's status. Authentication/permission errors can instead contain a detail field. The API-root login response uses its own username/auth shape.

Calling the API root verifies an identity; it does not issue a bearer token or create a persistent API login. Continue sending the headers on later calls.

Start the connection sequence

Begin with Create API Logins, then Connect and Test API Login. The first operation reference is test_connection.

Operation directory

All 25 current WAP operations are documented. Each reference includes headers, fields, response details, errors and standalone cURL/Python/PHP examples.

OperationPurpose
test_connectionTest authenticated operation access.
load-averageRead 1, 5 and 15 minute load averages.
versionRead the installed version.
createacctCreate a hosting account.
passwdChange a hosting password.
editquotaChange disk quota.
changepackageApply a hosting package.
changecontactemailUpdate the contact email.
suspendacctSuspend one account.
unsuspendacctUnsuspend one account.
removeacctPermanently remove one account.
setupresellerEnable reseller privileges.
uappssoGenerate a hosting-user login link.
wapssoGenerate an administrator login link.
rappssoGenerate a reseller login link.
suspendresellerSuspend a reseller and its account tree.
unsuspendresellerUnsuspend a reseller and its account tree.
terminateresellerPermanently remove a reseller and its account tree.
get_current_users_countCount hosting accounts.
get_current_reseller_countCount reseller accounts.
listsuspendedRead suspension records.
accountsummaryRead one account and its recorded usage.
listacctsList stored hosting-account records.
listpackagesRead available package names.
usagestatisticsRead recorded current-month account usage.