Check readiness

Reports whether the engine can serve traffic, including write and read readiness and any pressure conditions.

GET /ready

Decide whether traffic can be servedA process can be alive while reads or writes are not ready.

Select the readiness requirementCheck the workload you plan to send.
Inspect read and write readinessEvaluate the relevant readiness flags.
Read pressure detailsInvestigate reported storage or pressure restrictions.

Before you start

No bearer credential declared by the contract.

Query parameters

Field	Type	Required
`require`	`string`	Optional

Read the result

Use read_ready and write_ready for the traffic you plan to send. pressure and storage state explain readiness restrictions; a live process alone does not establish read or write readiness.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/ready"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "status": "ready",
  "read_ready": true,
  "write_ready": true,
  "rss_mib": 128,
  "pressure": [],
  "storage": {
    "state": "ok"
  }
}

Illustrative healthy process; readiness is deployment-specific.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Query parametersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Query parameters

Read the result

Response statuses