Liveness and readiness probe

GET

/health

const url = 'https://api.aetherpush.com/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 https://api.aetherpush.com/health

Reports the health of the API and its dependencies (PostgreSQL, Redis, blob storage). Returns 200 with status: UP when all configured dependencies are healthy; 503 with status: DOWN otherwise.

Suitable for use as a Railway / Kubernetes liveness probe.

Responses

200

All dependencies healthy.

application/json

object

status

required

string

Allowed values: UP DOWN

version

required

string

uptime

required

Process uptime in seconds.

number

details

required

Per-dependency health (PostgreSQL, Redis, blob storage).

object

key

additional properties

string

Example

{
  "status": "UP",
  "version": "0.1.0",
  "uptime": 12345.67,
  "details": {
    "postgres": "UP",
    "redis": "UP",
    "blobStorage": "UP",
    "responseTime": "42ms"
  }
}

503

One or more dependencies are unhealthy or unreachable.

application/json

object

status

required

string

Allowed values: UP DOWN

version

required

string

uptime

required

Process uptime in seconds.

number

details

required

Per-dependency health (PostgreSQL, Redis, blob storage).

object

key

additional properties

string

Example

{
  "status": "UP",
  "version": "0.1.0"
}