api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Alle api-keys Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X GET https://api.zinndigital.com/v1/api-keys/{apiKeyId} \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Returns one non-revoked key's metadata (never the secret). RBAC + RLS scoped.

Parameter

NameTypErforderlichWas es ist
apiKeyId (path)UuidJaThe API key's id.

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringJa
prefixstringJaThe key's public lookup id (the middle segment of the token).
scopesstring[]JaThe RBAC permission keys this key may exercise.
sandboxbooleanJaA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectNeinWhen the key last authenticated a request; null if never used.
revoked_atobjectNeinAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringJa

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 429