Skip to content
Primary navigation

Delete admin API key

admin.organization.admin_api_keys.delete(key_id) -> AdminAPIKeyDeleteResponse { id, deleted, object }
DELETE/organization/admin_api_keys/{key_id}

Delete an organization admin API key

ParametersExpand Collapse
key_id: String

The ID of the API key to be deleted.

ReturnsExpand Collapse
class AdminAPIKeyDeleteResponse { id, deleted, object }
id: String
deleted: bool
object: :"organization.admin_api_key.deleted"

Delete admin API key

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

admin_api_key = openai.admin.organization.admin_api_keys.delete("key_id")

puts(admin_api_key)
{
  "id": "key_abc",
  "object": "organization.admin_api_key.deleted",
  "deleted": true
}
Returns Examples
{
  "id": "key_abc",
  "object": "organization.admin_api_key.deleted",
  "deleted": true
}