api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Tous les points de terminaison api-keys

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Paramètres

NomTypeObligatoireQu'est-ce que c'est
apiKeyId (path)UuidOuiThe API key's id.

Réponse

NomTypeObligatoireQu'est-ce que c'est
idUuidOuiUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringOui
prefixstringOuiThe key's public lookup id (the middle segment of the token).
scopesstring[]OuiThe RBAC permission keys this key may exercise.
sandboxbooleanOuiA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectNonWhen the key last authenticated a request; null if never used.
revoked_atobjectNonAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringOui

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 429