Delete Api Key

client.apiKeys.delete(, ?): APIKeyDeleteResponse { cache_ttl_seconds, success }

DELETE/api/v1/beta/api-keys/{api_key_id}

Revoke an API key.

Revoking a project key takes access away from everyone using it, so it needs key-management permission on that project. Your own unscoped keys need only that you own them. A project-scoped key revokes only within its own project, unscoped keys included.

ParametersExpand Collapse

apiKeyID: string

ReturnsExpand Collapse

APIKeyDeleteResponse { cache_ttl_seconds, success }

Confirmation that a resource was deleted.

cache_ttl_seconds: number

Maximum seconds until cached information expires

minimum0

success: boolean

Whether the resource was deleted

Delete Api Key

import LlamaCloudAdmin from '@llamaindex/llama-cloud-admin';

const client = new LlamaCloudAdmin({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const apiKey = await client.apiKeys.delete('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(apiKey.cache_ttl_seconds);

{
  "cache_ttl_seconds": 0,
  "success": true
}

Returns Examples

{
  "cache_ttl_seconds": 0,
  "success": true
}