Skip to content

Commit b11ee0c

Browse files
committed
API Doc: Clarify some admin API privs and rename satellite section.
1 parent 54f1568 commit b11ee0c

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5066,15 +5066,15 @@ In addition to the [Standard Response Format](#standard-response-format), this i
50665066

50675067
## Administrative
50685068

5069-
Administrative APIs provide system-wide maintenance and export/import utilities intended for administrators. Use them to bulk import/export data, manage configuration, and perform maintenance tasks. These endpoints are admin-only and all operations are audited in the activity log.
5069+
Administrative APIs provide system-wide maintenance and export/import utilities intended for administrators. Use them to bulk import/export data, manage configuration, and perform maintenance tasks. These endpoints are admin-only (unless otherwise specified) and all write operations are audited in the activity log.
50705070

50715071
### get_servers
50725072

50735073
```
50745074
GET /api/app/get_servers/v1
50755075
```
50765076

5077-
Fetch a live snapshot of all connected worker servers and conductor/peer servers. Admin only.
5077+
Fetch a live snapshot of all connected worker servers and conductor/peer servers. Requires a valid user session or API key.
50785078

50795079
No input parameters.
50805080

@@ -5103,7 +5103,7 @@ Example response:
51035103
GET /api/app/get_global_state/v1
51045104
```
51055105

5106-
Fetch the in-memory conductor [State](data.md#state) object. This includes runtime flags (e.g., scheduler enabled), watches, and other internal state used by the conductor. Admin session or API Key is required.
5106+
Fetch the in-memory conductor [State](data.md#state) object. This includes runtime flags (e.g., scheduler enabled), watches, and other internal state used by the conductor. Requires a valid user session or API key.
51075107

51085108
No input parameters.
51095109

@@ -5737,7 +5737,7 @@ Example response:
57375737

57385738

57395739

5740-
## xyOps Satellite
5740+
## Satellite
57415741

57425742
These APIs handle xySat bootstrap, install, upgrade, and release discovery. Unlike most xyOps APIs, the `satellite` endpoint family serves plain-text scripts, tarballs, and JSON config files rather than the standard JSON response envelope on success.
57435743

0 commit comments

Comments
 (0)