Liveness probe and graph schema version

GET

/v1/health

const url = 'http://localhost:8090/v1/health';
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:8090/v1/health

Responses

200

Healthy

application/json

object

status

string

schema_version

On-disk graph format version

integer

release_version

Backend release semver

string

database

Whether the backend can reach its database (1.0.33+). Absent on older backends

string

Allowed values: reachable unreachable

Example

{
  "database": "reachable"
}

503

The backend is up but cannot reach its database (status degraded, database unreachable)

application/json

object

status

string

schema_version

On-disk graph format version

integer

release_version

Backend release semver

string

database

Whether the backend can reach its database (1.0.33+). Absent on older backends

string

Allowed values: reachable unreachable

Example

{
  "database": "reachable"
}