Skip to main content
Version: 0.1.0

Control API

The console talks to one HTTP API on the control port. It is the same API an operator can use by hand, and it is how the console avoids holding any AWS secret: a route performs the signed call itself, as the account root, and answers with what it read.

Two callers, two credentials​

CallerCredentialReaches
A person in the browserthe console session cookietheir own account only
The deploymenta bearer token minted inside the container (python /app/api_token.py)every account

A request with neither is refused. A request for an account the session does not belong to is 403, except for the bearer token, which is the one cross-tenant principal.

Answers​

Every route answers JSON: ok for "the read or write happened", plus the data it read. A failure answers a non-2xx status and {"error": "…"} with the emulator's own sentence where there is one — the console shows that sentence rather than inventing a friendlier one.

The groups​

  • Sign-in — /api/auth/*: password, MFA, remember, switch identity.
  • Identity — /api/meta, /api/me, /api/accounts/me: who is signed in, which account, which regions.
  • Accounts and people — /api/accounts, /api/users, /api/regions, /api/credentials: create accounts, manage users, enable regions, mint and revoke access keys.
  • Reading the emulator — /api/browse, /api/counts, /api/services, /api/actions, /api/nodes, /api/refresh: what the emulator holds, what the console serves, and which node answers for which region.
  • Acting on it — /api/exec: one catalogue action, run as the account root.
  • The S3 pages — /api/s3/*: buckets, objects, documents, settings, the three access point kinds, and the Multi-Region asynchronous operations. These do the work the console page claims, and nothing the page does not show.

Every route​

This table is generated from the control's own route table, so it cannot list a route that does not exist or miss one that does. Regenerate it with:

npm run api # reads the control checkout named by CONTROL_SRC
PathMethods
/api/accountsPOST
/api/accounts/([0-9]{12})DELETE
/api/accounts/([0-9]{12})/disabledPOST
/api/accounts/meGET
/api/actionsGET
/api/auth/loginPOST
/api/auth/mfaPOST
/api/auth/rememberPOST
/api/auth/switchPOST
/api/browseGET
/api/bucketsGET
/api/buckets/([^/]+)DELETE
/api/countsGET
/api/credentialsGET, POST
/api/execPOST
/api/mePOST
/api/metaGET
/api/nodesGET
/api/nodes/([^/]+)/resetPOST
/api/refreshPOST
/api/regionsPOST
/api/reservePOST
/api/s3GET
/api/s3/access-point-deletePOST
/api/s3/access-point-detailGET
/api/s3/access-point-policyGET
/api/s3/access-point-policy-editPOST
/api/s3/access-pointsGET, POST
/api/s3/bucket-documentPOST
/api/s3/bucket-documentsGET
/api/s3/bucket-headGET
/api/s3/bucket-settingsGET
/api/s3/bucket-settings-editPOST
/api/s3/bucketsPOST
/api/s3/emptyPOST
/api/s3/file-systemsGET
/api/s3/mrapPOST
/api/s3/mrap-deletePOST
/api/s3/mrap-policyPOST
/api/s3/mrap-routesPOST
/api/s3/objectGET, POST
/api/s3/object-annotationGET
/api/s3/object-copyPOST
/api/s3/object-downloadGET
/api/s3/object-metaGET
/api/s3/object-uploadPOST
/api/s3/objectsGET
/api/s3/table-bucketsGET
/api/servicesGET
/api/settingsGET
/api/usersGET, POST

55 route/method pairs, 51 paths.