Organisations
Reveal an organisation API key
Shows the full value of one of the organisation's keys again, to the owner or an admin.
POST
/orgs/{org}/keys/{id}/revealTL;DR
| Question | Answer |
|---|---|
| What does it do? | Reveal an organisation API key. |
| What does it take? | org, id in the path. |
| What does it return? | Status 200 with a body of type RevealedApiKey. |
| What can go wrong? | 401 not signed in; 403 a member may not reveal keys (orgs.forbidden), or the request came from an origin that may not make changes; 404 no such organisation or key, or the caller is not a member of the organisation; 409 this key has no sealed copy to show; 429 too many requests; 503 revealing keys is not set up on this server, or organisations are not. Every failure uses the one error envelope. |
What it does
Shows the full value of one of the organisation's keys again, to the owner or an admin. Only a key with a sealed copy can be revealed. Audited by key id, never by value.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The key, with its full value. | RevealedApiKey |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member may not reveal keys (orgs.forbidden), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation or key, or the caller is not a member of the organisation. | ErrorResponse |
| 409 | This key has no sealed copy to show. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Revealing keys is not set up on this server, or organisations are not. | ErrorResponse |
Response body
A 200 answer has the type RevealedApiKey.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
key | string | yes | The full key. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |