WHMCS System API
System administration and configuration
WHMCS System API is one of 7 APIs that WHMCS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and 4 JSON Schemas.
This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against a single base URL, https://{your-domain}/includes/api.php.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
WHMCS System API declares
1 security scheme
for authenticating requests.
An API key is passed in the query as identifier (ApiCredentials).
By default, every request must be authenticated.
ApiCredentials— WHMCS API credentials. Provide identifier and secret parameters in the POST request body, along with the action parameter.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.
System administration and configuration
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are StatsResponse (16 properties), WhmcsDetailsResponse (9 properties), AuthCredentials (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from WHMCS 6
Other APIs WHMCS publishes across the network.