api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Všechny koncové body api-keys

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

NázevTypPožadovánoCo to je
apiKeyId (path)UuidAnoThe API key's id.

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringAno
prefixstringAnoThe key's public lookup id (the middle segment of the token).
scopesstring[]AnoThe RBAC permission keys this key may exercise.
sandboxbooleanAnoA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectNeWhen the key last authenticated a request; null if never used.
revoked_atobjectNeAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringAno

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429