Skip to navigation

Get an API key

Serves one API key of the organisation; any other id is 404. Never the secret or its digest. Needs api-keys:manage.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

The record’s id — a positive 32-bit integer the platform minted.

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:
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

The API key’s row, rendered as the guide’s Reads section describes: the position header and body field, the ETag; never the secret or its digest.

apiKeyIdinteger
Sticky entity key.
capabilitieslist of enums

What the key may do — the bits a member could hold, less what a key is never granted: an approve bit, users:manage, api-keys:manage, risk:propose and transfers:propose (the risk writes name a member, and a transfer’s maker is one) and the platform’s bit. A key granted transfers:propose before the grant was refused keeps it here and can use it nowhere. Stored with the reads its verbs imply. a set (SBE bit-set) served as the array of its scope strings, each a Capability, in declared order; empty = none set, never null; as input a repeated name refuses 400

createdAtNsstringformat: "^-?[0-9]+$"
Platform time the key was issued, epoch nanoseconds. int64 as a decimal JSON string
createdByobject

Who issued the key — the api-keys:manage holder, a member. an actor: an object {kind, id}

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

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

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

When the principal was last seen acting — its last admitted request on this API (one a read replica serves is not recorded), or its open trading socket — epoch nanoseconds at a five-minute grain: a request inside five minutes of the mark need not move it, so read it as active within five minutes of this time. null while no mark is recorded: the principal has not acted since marks were first kept (0.71.0), or ever. A mark beside the row, not a field of it: it moves no version and no ETag.

namestring

The key’s name — unique among the organisation’s live keys. At most 128 bytes; longer refuses INVALID_FIELD.

orgIdinteger

The organisation the key acts in — stamped by the owner from the issuer’s organisation, never client-supplied.

statusenum

UNKNOWN is the unset sentinel: outputs only — as input the field is required, and explicit UNKNOWN refuses 400. A consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict

Allowed values:
versionstringformat: "^-?[0-9]+$"
Monotonic per entity. int64 as a decimal JSON string
rotatedByobject or nullOptional

Who last rotated the key — the api-keys:manage holder its current secret was answered to, a member; null until the first rotation. The member behind what the key proposes from here on: a proposal it makes pins them as its record’s keyHolder, and neither they nor the key’s issuer may approve it (SELF_APPROVAL). an actor: an object {kind, id}; null where none is stated

Errors

400
Get API Keys Request Bad Request Error
401
Get API Keys Request Unauthorized Error
403
Get API Keys Request Forbidden Error
404
Get API Keys Request Not Found Error
503
Get API Keys Request Service Unavailable Error