Readiness check

GET

/readyz

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://localhost:8080/readyz"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

const url = 'http://localhost:8080/readyz';
const options = {method: 'GET'};

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

curl --request GET \
  --url http://localhost:8080/readyz

Available inEmbeddedBundledCluster

AuthPublic no credentials needed

200 when this process can serve requests. In Bundled and Cluster mode that includes a database check bounded by 2 seconds; a database that does not answer in time, or at all, makes it 503 until it answers again.

Responses

200

The process is ready

application/json

object

status

required

string

Allowed values: UP

Example

{
  "status": "UP"
}

503

Backpressure or dependency unavailable

application/problem+json

object

type

required

string

/^urn:bpm:error:/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

instance

required

The request path.

string

mode

Present only on mode-not-supported. It names the engine’s mode.

string

Example

{
  "type": "urn:bpm:error:unavailable",
  "title": "Service Unavailable",
  "status": 503,
  "detail": "The required engine service is not ready",
  "instance": "/readyz"
}