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

# Health Check

> Lightweight health response for uptime checks. Also includes endpoint sections used by docs grouping.



## OpenAPI

````yaml GET /api/health
openapi: 3.0.3
info:
  title: Bila UiTM Cuti API
  version: '1'
  description: >-
    Unofficial API for UiTM academic calendar and Malaysian public holidays. Not
    affiliated with UiTM; verify important dates before production use.


    Rate limits (production): 500 requests per 60s per IP (CF-Connecting-IP) per
    endpoint; heavy calendar/meta modes (60 per 60s additional). GET /api/health
    is excluded. Cacheable successes expose RateLimit-Policy; 429 includes
    X-RateLimit-* / RateLimit / Retry-After. Optional remaining peek: GET
    /api/v1/rate-limit.
servers:
  - url: https://api.bilauitmcuti.com
security: []
paths:
  /api/health:
    get:
      summary: Health Check
      description: >-
        Lightweight health response for uptime checks. Also includes endpoint
        sections used by docs grouping.
      responses:
        '200':
          description: Health Check with grouped endpoint listing.
          headers:
            RateLimit-Policy:
              description: Published policies (RFC 9457).
              schema:
                type: string
                example: '"endpoint";q=500;w=60, "heavy";q=60;w=60'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '304':
          description: >-
            Not Modified. Empty body when If-None-Match matches the current
            ETag; Cache-Control and ETag headers are still sent.
          headers:
            RateLimit-Policy:
              description: Published policies (RFC 9457).
              schema:
                type: string
                example: '"endpoint";q=500;w=60, "heavy";q=60;w=60'
            ETag:
              description: Weak entity tag for this representation.
              schema:
                type: string
            Cache-Control:
              description: Caching policy for successful API responses.
              schema:
                type: string
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - status
        - apiVersion
        - sections
        - endpoints
      properties:
        status:
          type: string
          enum:
            - ok
        apiVersion:
          type: string
        sections:
          type: array
          items:
            $ref: '#/components/schemas/HealthSectionItem'
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/EndpointListItem'
    HealthSectionItem:
      type: object
      required:
        - id
        - label
        - endpoints
      properties:
        id:
          type: string
        label:
          type: string
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/EndpointListItem'
    EndpointListItem:
      type: object
      required:
        - method
        - path
        - title
      properties:
        method:
          type: string
          enum:
            - GET
        path:
          type: string
        title:
          type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.