---
title: "Health check endpoint"
url: "https://sg-dev-1.scripture.sh/apis/animal-facts-api-1/versions/cb120a4d-754c-446d-bfae-b856ae097070/operations/getHealth"
---

> Full API specification: https://sg-dev-1.scripture.sh/apis/animal-facts-api-1/versions/cb120a4d-754c-446d-bfae-b856ae097070.md

# Health check endpoint

`GET` `/v1/health`

Operation ID: `getHealth`

Returns the health status of the API.

## Responses

- `200` - API is healthy

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Animal Facts API
  version: 1.0.0
servers:
  - url: https://api.example.com
    description: Production server
paths:
  /v1/health:
    get:
      summary: Health check endpoint
      description: Returns the health status of the API.
      operationId: getHealth
      tags:
        - Health
      responses:
        "200":
          description: API is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: The status of the API.
                    example: healthy
```