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

# Check API availability

> Public liveness check. It returns service status only and never exposes directory data.



## OpenAPI

````yaml /openapi.yaml get /health
openapi: 3.1.0
info:
  title: HFSAA Public API
  version: 1.2.2
  description: >
    API-key protected access to HFSAA-certified restaurants, meat markets, and
    dining halls.

    Every directory-data route in the `/v1` namespace requires an API key; there
    are no

    anonymous data endpoints. Public health and developer-onboarding routes are
    explicitly

    marked with `security: []` and do not expose directory data.

    Developers can request test access without creating an account. Test keys do
    not

    expire automatically, but they are restricted to the test environment and
    quota.

    Successful data responses may be cached privately for no more than one hour.
  contact:
    name: HFSAA
servers:
  - url: https://api.hfsaa.org
    description: Production
  - url: https://hfsaa-public-api-staging.idris-ocasio.workers.dev
    description: Test
security:
  - ApiKeyAuth: []
paths:
  /health:
    get:
      tags:
        - Operations
      summary: Check API availability
      description: >-
        Public liveness check. It returns service status only and never exposes
        directory data.
      operationId: getHealth
      responses:
        '200':
          description: The Worker is reachable.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - status
                  - api_version
                  - environment
                properties:
                  status:
                    type: string
                    const: ok
                  api_version:
                    type: string
                    const: v1
                  environment:
                    type: string
                    enum:
                      - staging
                      - production
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: hfsaa_test_... or hfsaa_live_...
      description: 'Use the API key as `Authorization: Bearer <api-key>`.'

````