Management Key

API 키 조회

호출자가 볼 수 있는 범위에서 API 키 하나를 조회합니다. 조직 Management Key를 사용하면 ID가 해당 키의 조직에 속해야 하며, 소유자의 개인 키나 다른 조직의 키는 존재 여부를 노출하지 않고 모두 404를 반환합니다. 응답 형식은 { data: <key>, key: <key> }이고 두 필드의 객체는 같습니다. <key>에는 limit, limit_remaining, limit_reset, usage, usage_daily/weekly/monthly, requests, requests_daily/weekly/monthly, usage_scope: key가 포함됩니다. 사용량은 해당 키로 GET /v1/key를 호출했을 때와 일치합니다. limit_remaining은 재설정 기간의 해당 키 사용액을 뺀 한도이며, 개별 한도가 없으면 키가 사용하는 계정 또는 조직 잔액입니다. 원본 비밀값은 반환하지 않습니다.

GET/v1/keys/:id

인증

Authorization필수

string · header

Authorization 헤더에 Bearer 토큰으로 API 키를 전달합니다.

경로 파라미터

id필수

string

조회할 API 키의 ID입니다.

GET /v1/keys/:id

1
2
curl https://api.bazaarlink.ai/v1/keys/key_demo_01 \
  -H "Authorization: Bearer $BAZAARLINK_MANAGEMENT_KEY"

응답 예시

성공. data와 key는 같은 키 객체를 담고 usage_scope는 항상 key입니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "data": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  },
  "key": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  }
}