Aleph Alpha Operations API

Health checks and operational endpoints.

OpenAPI Specification

aleph-alpha-operations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Stateful Responses Operations API
  version: 0.4.23
  description: Health checks and operational endpoints.
servers:
- url: '{host}'
  variables:
    host:
      default: https://api.pharia.example.com
tags:
- name: Operations
  description: Health checks and operational endpoints.
paths:
  /health:
    get:
      tags:
      - Operations
      summary: Health Check
      description: Health check endpoint with optional broker connectivity check.
      operationId: health_check_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /:
    get:
      tags:
      - Operations
      summary: Root
      description: Root endpoint.
      operationId: root__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties:
                  type: string
                type: object
                title: Response Root  Get
components:
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer