Revoke a child API key | Saperly Docs

const url = 'https://saperly.com/api/v1/keys/id';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "key": {
    "id": "string",
    "key_prefix": "sk_live_abc",
    "environment": "live",
    "name": "string",
    "agent_label": "string",
    "line_id": "string",
    "permissions": "full",
    "monthly_cap_cents": 1,
    "monthly_spend_cents": 1,
    "created_at": "2024-01-15T09:30:00Z",
    "revoked_at": "2024-01-15T09:30:00Z",
    "last_used_at": "2024-01-15T09:30:00Z",
    "rotated_from": "string",
    "created_by_service_key_id": "string"
  }
}

Soft-revokes a child API key. The key cuts over IMMEDIATELY at data-plane endpoints (`/v1/calls`, `/v1/messages`, etc.) — there is no 60-second grace window for child keys. Subsequent requests with the revoked key return `invalid_api_key`. The returned row carries `revoked_at` populated; calling DELETE again returns 404 (idempotent at the user-visible level).

const url = 'https://saperly.com/api/v1/keys/id';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "key": {
    "id": "string",
    "key_prefix": "sk_live_abc",
    "environment": "live",
    "name": "string",
    "agent_label": "string",
    "line_id": "string",
    "permissions": "full",
    "monthly_cap_cents": 1,
    "monthly_spend_cents": 1,
    "created_at": "2024-01-15T09:30:00Z",
    "revoked_at": "2024-01-15T09:30:00Z",
    "last_used_at": "2024-01-15T09:30:00Z",
    "rotated_from": "string",
    "created_by_service_key_id": "string"
  }
}

Soft-revokes a child API key. The key cuts over IMMEDIATELY at data-plane endpoints (/v1/calls, /v1/messages, etc.) — there is no 60-second grace window for child keys. Subsequent requests with the revoked key return invalid_api_key. The returned row carries revoked_at populated; calling DELETE again returns 404 (idempotent at the user-visible level).

Authentication

AuthorizationBearer

Service keys (sk_svc_*) authenticate the /v1/keys/* management plane. Send as Authorization: Bearer <service-key>. Service keys are minted only from the portal (Settings → Service Keys); there is no API path to mint another service key.

Path parameters

idstringRequiredformat: "uuid"

Child API key ID

Response

Child API key revoked

keyobject

A child API key (sk_test_* / sk_live_*). Minted via the portal (UI) or programmatically via POST /v1/keys when authenticated as a service key.

Errors

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://saperly.com/api/v1/keys/id';
2	const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}

1	{
2	"key": {
3	"id": "string",
4	"key_prefix": "sk_live_abc",
5	"environment": "live",
6	"name": "string",
7	"agent_label": "string",
8	"line_id": "string",
9	"permissions": "full",
10	"monthly_cap_cents": 1,
11	"monthly_spend_cents": 1,
12	"created_at": "2024-01-15T09:30:00Z",
13	"revoked_at": "2024-01-15T09:30:00Z",
14	"last_used_at": "2024-01-15T09:30:00Z",
15	"rotated_from": "string",
16	"created_by_service_key_id": "string"
17	}
18	}