Atlas
Admin — Plugins

Plugin health check

Triggers a health check for a specific plugin. Platform admin only.

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

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3001/api/v1/admin/plugins/bigquery/health"
{
  "healthy": true,
  "message": "string",
  "latencyMs": 0,
  "status": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
Edit on GitHub

Last updated on