Organisations
Revoke an organisation API key
Stops the key working at once.
DELETE
/orgs/{org}/keys/{id}TL;DR
| Question | Answer |
|---|---|
| What does it do? | Revoke an organisation API key. |
| What does it take? | org, id in the path. |
| What does it return? | Status 204 with no body. |
| What can go wrong? | 401 not signed in; 403 a member may not revoke 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; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Stops the key working at once. A key that is not this organisation's, or is already revoked, is a 404.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Revoked. | none |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member may not revoke 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 |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
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 |