Delete External Key

beta.organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse

DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

The request is rejected if any workspace still references this config.

Parameters

external_key_id: String

ID of the External Key.

maxLength2048

Returns

class ExternalKeyDeleteResponse { id, type }

id: String

ID of the deleted External Key.

type: :external_key_deleted

Delete External Key

require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

external_key = anthropic.beta.organization.external_keys.delete("external_key_id")

puts(external_key)

{
  "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv",
  "type": "external_key_deleted"
}

Returns Examples

{
  "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv",
  "type": "external_key_deleted"
}