Aggregated queue health across the platform (platform admin)

GET

/admin/health

const url = 'http://localhost:3000/admin/health';
const options = {method: 'GET', headers: {'X-Admin-Key': '<X-Admin-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/admin/health \
  --header 'X-Admin-Key: <X-Admin-Key>'

Authorizations

adminKey

Responses

200

Fan-out and notify DLQ depths.

application/json

object

fanout

required

object

status

required

string

Allowed values: ok degraded unreachable

dlqDepth

required

integer | null

notify

required

object

status

required

string

Allowed values: ok degraded unreachable

dlqDepth

required

integer | null

Example

{
  "fanout": {
    "status": "ok"
  },
  "notify": {
    "status": "ok"
  }
}

403

Authenticated but not permitted.

application/json

object

error

required

object

code

required

string

Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL

message

required

string

requestId

required

string

fields

Present only for VALIDATION_FAILED.

Array<object>

object

path

string

message

string

Example

{
  "error": {
    "code": "VALIDATION_FAILED"
  }
}