https://wiki.7kas.com/index.php?action=history&feed=atom&title=OperatorAPI_helpOperatorAPI help - Revision history2026-09-06T23:52:34ZRevision history for this page on the wikiMediaWiki 1.43.9https://wiki.7kas.com/index.php?title=OperatorAPI_help&diff=967&oldid=prevMaintenance script: Operator API reference (generated from func=help)2026-08-19T08:17:31Z<p>Operator API reference (generated from func=help)</p>
<p><b>New page</b></p><div>{{Note|1=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.}}<br />
<br />
''newadmapi (Operator API) function. Available to: '''Operator, SuperRoot'''.''<br />
<br />
== Description ==<br />
Lists the API functions this key's role may call, with parameters, an example and the response shape.<br />
<br />
== Call ==<br />
GET|POST https://YOUR_HOST:9089/newadm?func=help<br />
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).<br />
<br />
== Parameters ==<br />
{| class="wikitable sortable"<br />
! Parameter !! Type !! Required !! Default !! Meaning<br />
|-<br />
| <code>name</code> || string || No || &mdash; || Return only this function.<br />
|}<br />
== Example ==<br />
<nowiki>https://host:port/newadm?func=help</nowiki><br />
<br />
== Response ==<br />
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape: <code>catalogue</code>.<br />
<br />
== Errors ==<br />
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].<br />
<br />
----<br />
Back to [[OperatorAPI]]<br />
[[Category:OperatorAPI]]</div>Maintenance script