Jump to

• Request
• Response

Readiness Check

get

/ready

Basic uptime/readiness check.

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

Service is up.

Body ()

Root Schema : ReadyResponse

Type: object

Show Source

• message(required): string
  Example: OK

{
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "example":"OK"
        }
    }
}

500 Response

Internal server error.

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
  Example: bad_request
• details: array details
• message(required): string
  Example: The request could not be processed.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "example":"bad_request"
        },
        "message":{
            "type":"string",
            "example":"The request could not be processed."
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top