Skip to navigation

List API keys

Lists the organisation’s API keys — its machine principals, each with its grant, its standing and who issued it; never a secret or its digest. Deleted keys are hidden unless include=deleted. Ordered by apiKeyId, ascending. Needs api-keys:manage.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Request-IdstringOptional

Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.

Query parameters

viewenumOptionalDefaults to latest

latest (the default) shows a row’s pending proposal where one exists; approved shows what the platform enforces. Resources without proposals serve the same rows for both.

Allowed values:
apiKeyIdintegerOptional>=1

Only rows whose apiKeyId is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not a positive 32-bit integer) refuses 400 MALFORMED_REQUEST; a value naming no row yields an empty collection.

statusenumOptional

Only rows whose status is one of these; repeat the parameter or comma-separate, at most 100 values. A value the row cannot carry (not one of the values listed) refuses 400 MALFORMED_REQUEST; a value naming no row yields an empty collection.

Allowed values:
sortstringOptionalDefaults to apiKeyId

Comma-separated apiKeyId, status, createdAtNs or name; prefix - for descending. Default apiKeyId.

limitintegerOptional>=1

Page size, 1-100; larger values are clamped. Without it the whole collection is served as one page.

cursorstringOptional<=2048 characters

nextCursor or prevCursor from a previous page, sent with the same filters and the same sort. One that does not decode, or that came from another query, is refused 400 INVALID_CURSOR: drop it and fetch the first page.

includeenumOptional

total adds the exact number of rows matching the filters — the set served. deleted (0.39.0) serves the deleted rows among the live ones: without it, and without a status filter, the list leaves out the rows its terminal state has reached; a by-id read serves them as ever. deleted binds into the cursor as a filter does; total never did.

Allowed values:
minGlobalSequencestringOptionalformat: "^[0-9]{1,19}$"

A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.

Response

A page of the rows inside the principal’s org, in the operation’s order, or the one sort asks — all of them unless limit is sent; the position it was read at rides the body and the headers.

asOfSeqTsNsstring or nullformat: "^[0-9]+$"

The sequencer timestamp (epoch-ns) the data is complete through; also sent as X-Immix-As-Of-Seq-Ts. Null when unknown.

globalSequencestringformat: "^[0-9]+$"

The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.

itemslist of objects
nextCursorstring or null

Pass as cursor for the next page. Null on the last page.

prevCursorstring or null

Pass as cursor for the previous page. Null on the first page.

totalinteger or null

Exact count matching the filter. Null unless include=total.

Errors

400
List API Keys Request Bad Request Error
401
List API Keys Request Unauthorized Error
403
List API Keys Request Forbidden Error
503
List API Keys Request Service Unavailable Error