OperatorAPI poll: Difference between revisions

Latest revision as of 08:28, 19 August 2026

newadmapi (Operator API) function. Available to: Operator, SuperRoot.

Description

Polls a login started with func=request. Returns pending, ok, expired or consumed. On the FIRST ok it returns a SHORT, server-revocable session token - never the permanent key.

Call

GET|POST https://YOUR_HOST:9089/newadm?func=poll

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
`session_code`	string	Yes	—	From func=request.

Example

https://host:port/newadm?func=poll&session_code=CODE

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":s,
    "session":s?
  }
}

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

Back to OperatorAPI

@@ Line 18: / Line 18: @@
 == Response ==
-Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape: <code>{"ok":true,"data":{"status":s,"session":s?}}</code>.
+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":s,
+    "session":s?
+  }
+}
+</pre>
 == Errors ==