> ## Documentation Index
> Fetch the complete documentation index at: https://docs.series.hr/llms.txt
> Use this file to discover all available pages before exploring further.

# Health Check

> Check if the API is online and healthy

Simple endpoint to verify the API is running and accessible. No authentication required.

## Request

```bash theme={null}
curl https://api.series.hr/basic/health
```

## Response

<ResponseField status={200} name="200">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "status": "healthy",
      "timestamp": "2024-01-05T12:00:00Z",
      "uptime": 864000
    }
  }
  ```
</ResponseField>

## Use Cases

* Monitoring API availability
* Load balancer health checks
* Initial connectivity testing
* Uptime monitoring


## OpenAPI

````yaml GET /basic/health
openapi: 3.0.0
info:
  title: Series API
  version: 1.0.0
  description: >-
    Series API — a free REST API by Sailboat Games, LLC that lets Roblox
    communities programmatically manage workspaces, staff, sessions, time-off
    and activity data.
  contact:
    name: Sailboat Games, LLC.
    email: admin@sailboatgames.com
servers:
  - url: https://api.series.hr
    description: Production API
security:
  - ApiKeyAuth: []
paths:
  /basic/health:
    get:
      tags:
        - Basic
      summary: Health Check
      description: Check if the API is running
      responses:
        '200':
          description: API is healthy
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Pass your API key in the `apikey` header. Alternatively, the `x-api-key`
        header is also accepted.

````