Skip to content
Authrim

Disable logging destination

POST
/api/admin/destinations/{id}/disable
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/destinations/example/disable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "confirmation": "FORCE DISABLE security-http-sink" }'

Force-disables a logging destination. The request must include confirmation text in the format FORCE DISABLE {name}.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Destination ID.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
confirmation
required
string
key
additional properties
Example 
{
  "confirmation": "FORCE DISABLE security-http-sink"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Logging destination mutation result.

Media type application/json
object
item
required
object
key
additional properties
audit_id
One of:
string
version
integer
key
additional properties
Example 
{
  "item": {
    "id": "dest_123",
    "version": 2,
    "updated_at": 1770000000000
  },
  "audit_id": "audit_123"
}

default

Section titled “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"
}