Jump to

• Request
• Response

Get Service Readiness

get

/ready

The endpoint returns the service's readiness status after application startup completes.

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 : ReadyResponse

Type: object

Show Source

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

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

503 Response

The service is unavailable because application startup has not completed.

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• detail(required): string

{
    "type":"object",
    "required":[
        "detail"
    ],
    "properties":{
        "detail":{
            "type":"string"
        }
    }
}

Back to Top