Jump to

• Request
• Response

Get Service Health

get

/health

The endpoint returns the service's liveness status and indicates whether the deployment configures the MCP URL and enables IDCS authentication.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was completed successfully. If the system throws a runtime error, the response code 200 is returned alongside the error message in the response body.

Body ()

Root Schema : HealthResponse

Type: object

Show Source

• idcs_enabled(required): boolean
• mcp_url_configured(required): boolean
• status(required): string

{
    "type":"object",
    "required":[
        "status",
        "mcp_url_configured",
        "idcs_enabled"
    ],
    "properties":{
        "status":{
            "type":"string",
            "const":"ok"
        },
        "mcp_url_configured":{
            "type":"boolean"
        },
        "idcs_enabled":{
            "type":"boolean"
        }
    }
}

Back to Top