Delete project API key | Sample

2 parameters

project_idstringrequired

The ID of the project.

api_key_idstringrequired

The ID of the API key.

2 status codes

200Project API key deleted successfully.

objectstringrequired

Allowed:organization.project.api_key.deleted

idstringrequired

deletedbooleanrequired

400Error response for various conditions.

errorobjectrequired

Error handling

A 400 is returned: Error response for various conditions.

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.apiKeys.delete({
  projectId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  apiKeyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "object": "organization.project.api_key.deleted",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "deleted": true
}

Request

Response

Errors