api-keys
Get an API key request's status
GET /v1/api-key-requests/{id}
Auth required
api.api_keys.request
The request's status — pending, approved, denied, claimed or
lapsed — and what was approved. Never returns a secret. Only the
credential that made the request can read it; any other caller gets
404. Once approved, claim it within an hour (claim_expires_at).
Path parameters
id string<uuid> required The API key request's id, as returned when it was made.
Responses
Errors follow the RFC 7807 problem format — see the error reference.
200 The request application/json
id string<uuid> required status string enum required One of: pending, approved, denied, claimed, lapsed
name string required environment string enum required One of: live, test
scopes array<string> required The scopes requested.
approved_scopes array<string> | null required The scopes approved, which may be narrower. Null until approved.
expires_in_days integer required The lifetime requested.
approved_expires_in_days integer | null required The lifetime approved, which may be shorter. Null until approved.
reason string required deny_reason string | null required request_expires_at string<date-time> required claim_expires_at string<date-time> | null required The end of the one-hour claim window, once approved.
created_at string<date-time> required decided_at string<date-time> | null required 401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
422 A query parameter, path value or body field failed validation.
The body is a
validation_failed Problem. When the refusal is about a
reference — a segment key, template slug, topic or attribute name the
organization does not have — it additionally carries validation_code,
field, line/column, missing, candidates and next_step, so a
client can correct the call without a second round of guessing. See
ValidationProblem.
application/problem+json 429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The
code is internal_error. The
request_id field can be quoted to SendOps support to investigate.
application/problem+json