Delete External Key

ExternalKeyDeleteResponse Beta.Organization.ExternalKeys.Delete(parameters, cancellationToken = default)

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

ExternalKeyDeleteParams parameters

required string externalKeyID

ID of the External Key.

maxLength2048

Returns

class ExternalKeyDeleteResponse { Type = "external_key_deleted"; ID; }

JsonElement Type = "external_key_deleted"

required string ID

ID of the deleted External Key.

Delete External Key

ExternalKeyDeleteParams parameters = new()
{
    ExternalKeyID = "external_key_id"
};

var externalKey = await client.Beta.Organization.ExternalKeys.Delete(parameters);

Console.WriteLine(externalKey);

Response 200

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

Returns Examples

Response 200

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