Provider Keys
8 operations in the Provider Keys group.
5 of 8 operations on this page are generated contract stubs: the routes are real, the schemas are placeholders pending the owning subsystem's contract pass.
GET /api/provider-keys
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiProviderKeys
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/provider-keys
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiProviderKeys
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/provider-keys/{providerKey}
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: getApiProviderKeysProviderKey
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
providerKey | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
DELETE /api/provider-keys/{providerKey}
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: deleteApiProviderKeysProviderKey
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
providerKey | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 204 | No content | — |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
POST /api/provider-keys/{providerKey}/rotate
Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.
Operation ID: postApiProviderKeysProviderKeyRotate
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
providerKey | path | yes | string |
Request body — application/json · object
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Successful response | GenericApiResponse |
| 201 | Successful response | GenericApiResponse |
| 401 | Authentication is required | ErrorEnvelope |
| 403 | Permission denied | ErrorEnvelope |
| 422 | Validation failed | ErrorEnvelope |
| 500 | Server error | ErrorEnvelope |
GET /api/resources/{workspace}/provider-keys
Operation ID: listProviderKeys
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Provider keys. | ProviderKeyCollectionResponse |
POST /api/resources/{workspace}/provider-keys
Operation ID: createProviderKey
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string |
Request body — application/json · CreateProviderKeyRequest (required)
| Field | Type | Required |
|---|---|---|
provider | enum(anthropic, openai, google, other) | yes |
mode | enum(managed_byok, managed_pass_through) | yes |
team_id | `integer | null` |
key_ref | `string | null` |
secret | string | no |
Responses
| Status | Description | Schema |
|---|---|---|
| 201 | Created provider key. | ProviderKeyResponse |
POST /api/resources/{workspace}/provider-keys/{providerKey}/rotate
Operation ID: rotateProviderKey
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
workspace | path | yes | string | |
providerKey | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | Rotated provider key. | ProviderKeyResponse |