Readyz

GET

/readyz

const url = 'https://api.vocapable.com/readyz';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vocapable.com/readyz \
  --header 'Authorization: Bearer <token>'

Ready means the database answers and both isolation checks still hold.

The admin verification runs only when the admin plane is wired: an unwired plane is a stated condition, not unreadiness (ADR-0016 §8).

Authorizations

bearerAuth

Responses

200

Successful Response

application/json

Response Readyz Readyz Get

object

key

additional properties

string

Example^generated

{
  "additionalProperty": "example"
}

Readyz

Authorizations

Responses

200

Examplegenerated

Example^generated