Skip to content

Readiness probe (store reachable AND this node is the active writer); 503 on a standby or when the store is down

GET
/readyz
curl --request GET \
--url https://example.com/readyz

Answers 200 when the store is reachable AND this node is the active writer, so a load balancer drains a standby or a wedged instance. The store ping carries a short timeout, and a pending first-run setup is reported without failing readiness.

  • None

OK

Media type application/json
object
status
string
Example generated
{
"status": "example"
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}