OperatorAPI help
ℹ This is the self-discovery endpoint. It returns the functions your key's role may call, each documented. THIS WHOLE OperatorAPI reference is generated from it, so it never drifts from the running service.
newadmapi (Operator API) function. Available to: Operator, SuperRoot.
Description
Lists the API functions this key's role may call, with parameters, an example and the response shape.
Call
GET|POST https://YOUR_HOST:9089/newadm?func=help
Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
name |
string | No | — | Return only this function. |
Example
https://host:port/newadm?func=help
Response
Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape: catalogue.
Errors
Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.
Back to OperatorAPI