Delete an organization admin API key

1 parameter

key_idstringrequired

The identifier of the organization API key to delete.

1 status code

200Returns a deletion confirmation containing the API key `id`, the deleted object type, and a boolean `deleted` value.

idstringrequired

objectstringrequired

Allowed:organization.admin_api_key.deleted

deletedbooleanrequired

Error handling

key_id must identify the organization API key you want to delete. The response confirms deletion through the key identifier, deleted object type, and deleted status.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.adminApiKeys.delete({ keyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": "key_abc",
  "object": "organization.admin_api_key.deleted",
  "deleted": true
}

Request

Response

Errors