Skip to main content
API Explorer|API Explorer
SLO & Service Quality/Health Check
GETHealthSince 1.0SynchronousAuth Required

CheckHealth

Check the overall health status of the service including all dependencies. No authentication required.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • statusString

    Current health status of the service

    Example: ok

  • serviceString

    Name of the service being checked

    Example: federation

Endpoint

GET/health

/health

Operation ID

CheckHealth

Permalink

Request Example

curl -X GET '{host}/health'

Response Example

200
{
  "status": "ok",
  "service": "federation"
}

Change History

This API has no change history records yet.

View all change history