Health & Status

GET

api

status

Read service status and uptime

curl --request GET \
  --url https://api.alexxweb.com/api/v1/status

{
  "service": "AlexWeb API",
  "version": "1.2.0",
  "status": "operational",
  "uptime_seconds": 1,
  "timestamp": "2023-11-07T05:31:56Z",
  "checks": {
    "storage": {
      "status": "ok",
      "latency_ms": 1
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "service": "AlexWeb API",
  "version": "1.2.0",
  "status": "operational",
  "uptime_seconds": 1,
  "timestamp": "2023-11-07T05:31:56Z",
  "checks": {
    "storage": {
      "status": "ok",
      "latency_ms": 1
    }
  }
}

Service monitoring

Use health checks to decide whether a service can handle work. Use status to understand its readiness and uptime at the time of your request.

These requests are public. They do not require an API key, and the responses contain no private account data or internal infrastructure addresses.

Open live status Open developer console

Try it

Send the request in this page’s interactive panel, or use cURL:

curl -i https://api.alexxweb.com/api/v1/status

const response = await fetch("https://api.alexxweb.com/api/v1/status");
const status = await response.json();
console.log(response.status, status.status);

What you’ll see

This is an illustrative response; uptime and timings change with each request.

{
  "service": "AlexWeb API",
  "version": "1.2.0",
  "status": "operational",
  "uptime_seconds": 86400,
  "timestamp": "2026-10-18T12:00:00.000Z",
  "checks": {
    "storage": {
      "status": "ok",
      "latency_ms": 0.45
    }
  }
}

Field	Meaning
`service`	The service name, AlexWeb API.
`version`	The software version serving the request.
`status`	`operational` when storage is ready; `degraded` when it is unavailable.
`uptime_seconds`	Seconds since this API process started. A restart resets this number.
`timestamp`	The time of this check in UTC.
`checks.storage.status`	Whether a lightweight storage read succeeded.
`checks.storage.latency_ms`	Time spent on that storage check, in milliseconds.

The status response checks the API process and its storage. It does not test every webhook receiver, OAuth callback, or connected Home Assistant instance.

Health checks

Readiness

GET /api/v1/health verifies a storage read. Use this when deciding whether the API is ready to serve requests.

Liveness

GET /health confirms that the API process can answer HTTP. It remains available for existing monitors.

A successful readiness response is:

{ "status": "ok" }

If the storage check fails, /api/v1/health returns HTTP 503 and:

{ "status": "unavailable" }

/api/v1/status also returns 503 when degraded. Use the HTTP status code in your monitor, and inspect the JSON to understand the result. A liveness response alone does not prove storage is ready.

Understand the timing

Storage latency is one small operation inside the API. It excludes the time spent reaching the service over the internet. Client response time includes the network path and the time it takes to receive a response. You can measure it with cURL:

curl -s -o /dev/null -w 'HTTP %{http_code}; total %{time_total}s\n' https://api.alexxweb.com/api/v1/status

The developer console displays a browser measurement when it loads status. Your account’s usage analytics measures server response time for authenticated requests. These measure different parts of a request and should not be expected to match.

Use it in a monitor

Point your monitor at https://api.alexxweb.com/api/v1/health.
Treat HTTP 200 as ready and 503 as unavailable.
Use a reasonable interval, such as once per minute, and confirm repeated failures before alerting.
Keep the X-Request-Id header from failed checks when requesting help.

Status and health are point-in-time checks. This API does not promise a historical uptime percentage or a service-level agreement.

Other requests

Request	Purpose
`GET /health`	Process liveness, compatible with existing monitors.
`GET /api/v1/health`	Storage readiness.
`GET /api/v1/status`	Readiness, uptime, version, and storage timing.
`GET /api/v1/capabilities`	Supported features and configured limits.

For request counts, error rates, and latency statistics belonging to your account, use Usage & Limits.

Response

Success

service

string

required

Allowed value: "AlexWeb API"

version

string

required

Allowed value: "1.2.0"

status

enum<string>

required

Available options:

operational,

degraded

uptime_seconds

integer

required

Required range: x >= 0

timestamp

string<date-time>

required

checks

object

required

Show child attributes

Read service status and uptime

curl --request GET \
  --url https://api.alexxweb.com/api/v1/status

{
  "service": "AlexWeb API",
  "version": "1.2.0",
  "status": "operational",
  "uptime_seconds": 1,
  "timestamp": "2023-11-07T05:31:56Z",
  "checks": {
    "storage": {
      "status": "ok",
      "latency_ms": 1
    }
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "service": "AlexWeb API",
  "version": "1.2.0",
  "status": "operational",
  "uptime_seconds": 1,
  "timestamp": "2023-11-07T05:31:56Z",
  "checks": {
    "storage": {
      "status": "ok",
      "latency_ms": 1
    }
  }
}

Get Started

API Usage

Health & Status

Try it

What you’ll see

Health checks

Readiness

Liveness

Understand the timing

Use it in a monitor

Other requests

Response

​Try it

​What you’ll see

​Health checks

Readiness

Liveness

​Understand the timing

​Use it in a monitor

​Other requests

Response

Try it

What you’ll see

Health checks

Understand the timing

Use it in a monitor

Other requests