OperatorAPI request: Difference between revisions
Operator API reference (generated from func=help) |
Operator API reference: multi-line response shape |
||
| Line 18: | Line 18: | ||
== Response == | == Response == | ||
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape: < | Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set): | ||
<pre> | |||
{ | |||
"ok":true, | |||
"data":{ | |||
"status":"sent", | |||
"session_code":s, | |||
"expires_in":n | |||
} | |||
} | |||
</pre> | |||
== Errors == | == Errors == | ||
Latest revision as of 08:28, 19 August 2026
newadmapi (Operator API) function. Available to: Operator, SuperRoot.
Description
Starts an operator login. Send the address; a one-click link is emailed. The answer is ALWAYS "sent", even for an unknown or rate-limited address - that is anti-enumeration and is deliberate. The browser never holds a credential at this point.
Call
GET|POST https://YOUR_HOST:9089/newadm?func=request
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 |
|---|---|---|---|---|
email |
string | Yes | — | The operator login address. |
Example
https://host:port/newadm?func=request
Response
Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape (n = number, s = string, ? = present only when set):
{
"ok":true,
"data":{
"status":"sent",
"session_code":s,
"expires_in":n
}
}
Errors
Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.
Back to OperatorAPI