---
title: "Health"
method: GET
path: "/health"
tags: ["health"]
---

# Health

`GET /health`

## Request

- Base URL: `http://localhost:8080`
- URL: `http://localhost:8080/health`
- Auth: none declared
- TypeScript: <https://skmtc.dev/atomaai/apis/atoma-service/docs/health/get.ts> (a function with typed inputs; its response is checked against the schema)

This function is used to verify that the server is running and responsive.
It's typically used by load balancers or monitoring systems to check the
health status of the service.

# Returns

Returns a static string "OK" to indicate that the server is healthy and
functioning properly.

# Examples

This function is usually mapped to a GET endpoint, for example:

```rust,ignore
app.route("/health", get(health_check))
```

## Response `200`

Service is healthy

- unknown

---

[API](https://skmtc.dev/atomaai/apis/atoma-service.md) - [All operations](https://skmtc.dev/atomaai/apis/atoma-service/llms.txt) - [OpenAPI document](https://skmtc.dev/atomaai/apis/atoma-service/revisions/a3d329cb3125?raw)