Skip to main content
GET
/
resources
/
health
Get Resource Health
curl --request GET \
  --url https://api.example.com/resources/health
{
  "status": "<string>",
  "message": "<string>",
  "details": {}
}

Query Parameters

provider
string
required

Provider name

resource
string
required

Resource type

name
string
required

Resource name

Response

Successful Response

Health status of a resource reported by its provider.

Attributes: status: Health state (healthy, unhealthy, degraded). message: Optional human-readable description. details: Optional provider-specific health check details.

status
string
required
message
string | null
details
Details · object