---
title: "Check API availability"
method: GET
path: "/health"
tags: ["System"]
---

# Check API availability

`GET /health`

## Request

- Base URL: `https://codeatlas.com.br/api/v1`
- URL: `https://codeatlas.com.br/api/v1/health`
- Auth: none required

Returns a public liveness response without exposing infrastructure details.

## Response `200`

API is available.

- HealthResponse
  - `status` 'ok', required
  - `service` 'codeatlas-api', required
  - `version` string, required

## Other responses

- `405`: The HTTP method is not supported.
- `429`: Rate limit exceeded. Wait Retry-After seconds.
- `default`: Unexpected error. Same shape as every other error.

---

[API](https://skmtc.dev/codeatlas/apis/codeatlas-public-api.md) · [All operations](https://skmtc.dev/codeatlas/apis/codeatlas-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/codeatlas/apis/codeatlas-public-api/revisions/fdb5ace63542?raw)