Check liveness

GET/healthz

Check liveness

curl 'http://127.0.0.1:8080/healthz'

const response = await fetch("http://127.0.0.1:8080/healthz");
const answer = await response.json();

import requests

answer = requests.get("http://127.0.0.1:8080/healthz").json()

GET

/healthz

const url = 'http://127.0.0.1:8080/healthz';
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://127.0.0.1:8080/healthz

Returns 200 while the server is running, even before the Pack is loaded. Use /readyz to check that it can geocode. The body is empty.

Responses

200

The server is running.

Headers

X-Request-Id

string

<= 128 characters

ID the request is logged under: the request’s own X-Request-Id when it sent one. Include it in bug reports.

405

Method not allowed. The route accepts GET only.

application/problem+json

Problem

Error response, an RFC 9457 problem document.

object

detail

Human-readable explanation. Absent on 500 errors.

string

error_code

required

Stable error code. Branch on this.

string

Allowed values: invalid_query invalid_coordinate limit_too_large malformed_parameter not_found method_not_allowed internal_error

invalid_params

Rejected parameters. Present only when the error is about parameters.

Array<object>

A rejected parameter.

object

name

required

Parameter name.

string

reason

required

Why it was rejected.

string

request_id

ID the request is logged under. Include it in bug reports.

string

status

required

integer format: int32

>= 400 <= 599

title

required

Name of the HTTP status. Do not branch on it.

string

type

required

URI identifying the problem type. Currently always about:blank.

string

Example

{
  "detail": "q must not be empty",
  "error_code": "invalid_query",
  "invalid_params": [
    {
      "name": "limit",
      "reason": "must be at most 50"
    }
  ],
  "request_id": "01JA7Q2K3M4N5P6Q7R8S9T0V1W",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Headers

Allow

string

Example

GET

Methods the route accepts.

X-Request-Id

string

<= 128 characters

ID the request is logged under: the request’s own X-Request-Id when it sent one. Include it in bug reports.