Get tenant plugin health.

GET

/api/admin/plugins/{id}/health

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/plugins/example/health \
  --header 'Authorization: Bearer <token>'

Return cached health information for a plugin, or unknown when the plugin has no recent health check.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Plugin identifier.

Responses

200

Plugin health response.

Media type application/json

object

pluginId

required

string

health

required

object

status

string

timestamp

integer format: int64

message

string

key

additional properties

key

additional properties

Example ^generated

{
  "pluginId": "example",
  "health": {
    "status": "example",
    "timestamp": 1,
    "message": "example"
  }
}

401

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"
}

403

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"
}

404

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"
}

500

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"
}