Management Keys

Einen API-Schlüssel abrufen

Ruft einen API-Schlüssel innerhalb des für den Aufrufer sichtbaren Bereichs ab. Bei einem Management Key einer Organisation muss die ID zu genau dieser Organisation gehören; persönliche Schlüssel des Besitzers und Schlüssel anderer Organisationen liefern beide 404, ohne ihre Existenz zu verraten. Die Antwort hat die Form { data: <key>, key: <key> }; beide Felder enthalten dasselbe Objekt. <key> enthält limit, limit_remaining, limit_reset, usage, usage_daily/weekly/monthly, requests, requests_daily/weekly/monthly und usage_scope: key. Die Nutzungswerte entsprechen GET /v1/key mit diesem Schlüssel. limit_remaining ist das Limit abzüglich der Ausgaben dieses Schlüssels im Rücksetzzeitraum oder ohne eigenes Limit das Konto- bzw. Organisationsguthaben. Das rohe Geheimnis wird nicht zurückgegeben.

GET/v1/keys/:id

Autorisierung

Authorizationerforderlich

string · header

API-Schlüssel als Bearer-Token im Authorization-Header.

Pfadparameter

iderforderlich

string

Die ID des abzurufenden API-Schlüssels.

GET /v1/keys/:id

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

Antwortbeispiele

Erfolg. data und key enthalten dasselbe Schlüsselobjekt; usage_scope ist immer 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
  }
}