Delete Api Key

api_keys.delete() -> APIKeyDeleteResponse

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

api_key_id: str

ReturnsExpand Collapse

class APIKeyDeleteResponse: …

Confirmation that a resource was deleted.

cache_ttl_seconds: int

Maximum seconds until cached information expires

minimum0

success: bool

Whether the resource was deleted

Delete Api Key

import os
from llama_cloud_admin import LlamaCloudAdmin

client = LlamaCloudAdmin(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
api_key = client.api_keys.delete(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(api_key.cache_ttl_seconds)

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

Returns Examples

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