Баримт бичиг / API лавлах
API түлхүүр
Ажлын орчны түлхүүр үүсгэх, хүчингүй болгох.
GET/v1/workspaces/{workspaceId}/api-keys
List the workspace's API keys (masked, never the secret), newest first.
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
page | query | integer (int32) | | |
pageSize | query | integer (int32) | | |
Хариу: 200 ApiKeyDto[]
POST/v1/workspaces/{workspaceId}/api-keys
Create a key. The secret is in the response once.
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (NewApiKey)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | тийм | 1-100 characters. |
kind | null | KeyKindDto | | |
role | null | KeyRoleDto | | |
permissionMode | null | PermissionModeDto | | |
scopes | string[] | | Required for `restricted`: `<resource>.read|write`. |
expiresAt | string (date-time) | | |
Хариу: 201 ApiKeyCreated
PATCH/v1/workspaces/{workspaceId}/api-keys/{keyId}
Rename a key, change its role, permission mode, scopes or expiry. The secret and the kind never change.
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
keyId | path | string | тийм | |
Хүсэлтийн бие (UpdateApiKey)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | | |
role | null | KeyRoleDto | | |
permissionMode | null | PermissionModeDto | | |
scopes | array | | Replaces the scope list (only with `restricted`). |
expiresAt | string | | `null` removes the expiry. |
Хариу: 200 ApiKeyDto
DELETE/v1/workspaces/{workspaceId}/api-keys/{keyId}
Delete (revoke) a key; its next use fails with 401.
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
keyId | path | string | тийм | |
Хариу: 204
GET/v1/workspaces/{workspaceId}/publishable-keys
List publishable keys (revoked ones included, newest first).
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 PublishableKeyDto[]
POST/v1/workspaces/{workspaceId}/publishable-keys
Create a publishable key (az_pk_...).
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (NewPublishableKey)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
environment | string | | `live` (default) or `test`. |
Хариу: 201 PublishableKeyDto
GET/v1/workspaces/{workspaceId}/publishable-keys/allowed-hosts
The hostnames publishable keys may be used from.
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 AllowedHosts
PUT/v1/workspaces/{workspaceId}/publishable-keys/allowed-hosts
Replace the allow-list.
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (AllowedHosts)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
hosts | string[] | тийм | `example.com` matches only that host; `*.example.com` matches its subdomains but not the apex; `localhost` is allowed for development. |
Хариу: 200 AllowedHosts
DELETE/v1/workspaces/{workspaceId}/publishable-keys/{keyId}
Revoke a publishable key; browsers using it are rejected immediately.
Шаардлагатай API түлхүүрийн хамрах хүрээ: api_keys.manage
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
keyId | path | string | тийм | |
Хариу: 204