> For the complete documentation index, see [llms.txt](https://docs.apexsolutions.lol/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apexsolutions.lol/api-reference/health.md).

# Health

Protected liveness check for the platform.

Liveness check. It is protected like every other endpoint (a valid API key is required) so an external monitor can confirm the service is alive.

### What it checks

The endpoint responds with `ok` when the platform is up. It does not expose any internal state — just that the service answers.

### Errors

A missing or invalid API key returns `401 invalid_api_key`.

## Liveness check

> Protected liveness check. Responds with \`ok\` when the platform is up.\
> Requires a valid API key.<br>

```json
{"openapi":"3.0.3","info":{"title":"Apex Platform","version":"1.0.0"},"tags":[{"name":"Health","description":"Liveness check. It is protected like every other endpoint (a valid API\nkey is required) so an external monitor can confirm the service is\nalive.\n\n## What it checks\n\nThe endpoint responds with `ok` when the platform is up. It does not\nexpose any internal state — just that the service answers.\n\n## Errors\n\nA missing or invalid API key returns `401 invalid_api_key`.\n"}],"servers":[{"url":"https://api.apexsolutions.lol"}],"paths":{"/health/live":{"get":{"tags":["Health"],"summary":"Liveness check","description":"Protected liveness check. Responds with `ok` when the platform is up.\nRequires a valid API key.\n","parameters":[{"name":"Authorization","in":"header","required":true,"description":"Your API key for authentication.","schema":{"type":"string"}}],"responses":{"200":{"description":"The platform is alive.","content":{"text/plain":{"schema":{"type":"string"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code."},"message":{"type":"string","description":"Human-readable error message."}}}}}}}}
```