api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

すべての api-keys エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

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

パラメータ

名前タイプ必須これがその内容です
apiKeyId (path)UuidはいThe API key's id.

返信

名前タイプ必須これがその内容です
idUuidはいUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringはい
prefixstringはいThe key's public lookup id (the middle segment of the token).
scopesstring[]はいThe RBAC permission keys this key may exercise.
sandboxbooleanはいA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectいいえWhen the key last authenticated a request; null if never used.
revoked_atobjectいいえAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringはい

このエンドポイントが返すエラー

401 · 403 · 404 · 429