API keys
Revoke an API key
The key stops working at once.
DELETE
/v1/api-keys/{id}TL;DR
| Question | Answer |
|---|---|
| What does it do? | Revoke an API key. |
| What does it need? | An API key or an OAuth access token. |
| What does it take? | id in the path. |
| What does it return? | Status 204 with no body. |
| In the SDK? | flung.apiKeys.revoke() |
| What can go wrong? | 401 Missing, unknown, revoked or expired API key; 403 This key cannot manage API keys; 404 No such live key in this workspace; 422 The request failed validation; 429 Too many requests for this credential; wait for retry-after seconds. Every failure has the same error shape. |
What it does
The key stops working at once. Revoking the key that makes this request is allowed.
Example
bash
curl -X DELETE 'https://api.flung.dev/v1/api-keys/key_aaaaaaaaaaaaaaaaaaaaaaaa' \ --header "Authorization: Bearer $FLUNG_API_KEY"ts
import { Flung } from '@flung.dev/sdk'
const flung = new Flung({ apiKey: process.env.FLUNG_API_KEY! })await flung.apiKeys.revoke({ id: 'key_aaaaaaaaaaaaaaaaaaaaaaaa',})js
const response = await fetch('https://api.flung.dev/v1/api-keys/key_aaaaaaaaaaaaaaaaaaaaaaaa', { method: 'DELETE', headers: { 'Authorization': `Bearer ${process.env.FLUNG_API_KEY}`, },})if (!response.ok) throw new Error((await response.json()).error.message)Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Revoked. | none |
| 401 | Missing, unknown, revoked or expired API key. | Error |
| 403 | This key cannot manage API keys. | Error |
| 404 | No such live key in this workspace. | Error |
| 422 | The request failed validation. | Error |
| 429 | Too many requests for this credential; wait for retry-after seconds. | Error |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint |
| Schemas | Every request and response type |
| Errors | Every error code and what to do about it |