Delete logging destination

DELETE

/api/admin/destinations/{id}

Code sample: Shell / cURL

curl --request DELETE \
  --url https://auth.example.com/api/admin/destinations/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "confirmation": "DELETE DESTINATION security-http-sink", "expected_version": 1 }'

Soft-deletes a logging destination. The request must include confirmation text in the format DELETE DESTINATION {name}.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Destination ID.

Request Body ^required

Media type application/json

object

confirmation

required

string

expected_version

integer

key

additional properties

Example

{
  "confirmation": "DELETE DESTINATION security-http-sink",
  "expected_version": 1
}

Responses

200

Logging destination mutation result.

Media type application/json

object

item

required

object

key

additional properties

audit_id

One of:

string

string

null

null

version

integer

key

additional properties

Example

{
  "item": {
    "id": "dest_123",
    "version": 2,
    "updated_at": 1770000000000
  },
  "audit_id": "audit_123"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

default

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}