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

# Get public API health



## OpenAPI

````yaml /openapi.yaml get /api/public/v1/status
openapi: 3.1.0
info:
  title: PunchPlay Platform API
  version: 1.0.0-beta.5
  description: >-
    Beta contract for the Platform API and stable v1 contract for the read-only
    Public API. OAuth access tokens use explicit per-operation scopes.
servers:
  - url: https://punchplay.tv
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Authentication
  - name: Profile
  - name: Titles
  - name: History
  - name: Ratings
  - name: Lists
  - name: Collection
  - name: Playback
  - name: Calendar
  - name: Community
  - name: Notifications
  - name: Trophies
  - name: Sync
  - name: Public Catalog
  - name: Public Users
  - name: Public API
paths:
  /api/public/v1/status:
    get:
      tags:
        - Public API
      summary: Get public API health
      operationId: getPublicStatus
      responses:
        '200':
          $ref: '#/components/responses/PublicStatusSuccess'
        '503':
          $ref: '#/components/responses/PublicStatusDegraded'
      security: []
components:
  responses:
    PublicStatusSuccess:
      description: Public API health status
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicStatus'
    PublicStatusDegraded:
      description: Public API health status when the database is unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicStatus'
  schemas:
    PublicStatus:
      type: object
      additionalProperties: false
      required:
        - status
        - checkedAt
        - components
      properties:
        status:
          type: string
          enum:
            - operational
            - degraded
        checkedAt:
          type: string
          format: date-time
        components:
          type: object
          additionalProperties: false
          required:
            - api
            - database
          properties:
            api:
              type: string
              const: operational
            database:
              type: string
              enum:
                - operational
                - unavailable

````