Skip to content
Authrim

Run logging destination health check

POST
/api/admin/destinations/{id}/health-check
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/destinations/example/health-check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "check_type": "quick" }'

Runs a quick, adaptive, or deep health check and records a health event and audit log.

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
check_type
string
Allowed values: quick deep adaptive
key
additional properties
Example 
{
  "check_type": "quick"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Destination health check result.

Media type application/json
object
item
required
object
key
additional properties
audit_id
One of:
string
version
integer
key
additional properties
Example 
{
  "item": {
    "destination_id": "dest_123",
    "checked_at": 1770000000000,
    "check_type": "quick",
    "previous_health_status": "configured",
    "next_health_status": "healthy",
    "result": "success",
    "error_class": null,
    "latency_ms": 25,
    "metadata": {}
  },
  "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"
}