Microsoft Azure API Management Health API

openapi: 3.2.0
info:
  title: Microsoft Azure Api Management Health API
  version: '1.0'
  description: 'Operations tagged Health across 2 of this provider''s published API definitions: microsoft-azure-api-management-gateway-openapi.yaml, microsoft-azure-api-management-self-hosted-gateway-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{service-name}.azure-api.net
  variables:
    service-name:
      default: contoso-apim
      description: The name of the API Management service instance
- url: https://{gateway-hostname}
  variables:
    gateway-hostname:
      default: apim-gateway.contoso.com
      description: The hostname of the self-hosted gateway instance
tags:
- name: Health
paths:
  /status-0123456789abcdef:
    get:
      summary: Gateway health check
      operationId: Gateway_HealthCheck
      tags:
      - Health
      description: Returns gateway health status.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Gateway is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
              examples:
                HealthyExample:
                  summary: Healthy gateway
                  value:
                    status: Healthy
                    timestamp: '2024-06-15T12:00:00Z'
              x-microcks-default:
                status: Healthy
    servers:
    - url: https://{service-name}.azure-api.net
      variables:
        service-name:
          default: contoso-apim
          description: The name of the API Management service instance
  /internal/status:
    get:
      summary: Internal status endpoint
      operationId: SelfHostedGateway_InternalStatus
      tags:
      - Health
      description: Returns detailed internal status of the self-hosted gateway container.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Internal status details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalStatus'
              examples:
                InternalStatusExample:
                  summary: Internal status details
                  value:
                    status: Running
                    version: 2.6.0
                    configurationStatus: Synced
                    lastConfigurationUpdate: '2024-06-15T11:55:00Z'
                    connectedToManagementPlane: true
                    uptimeSeconds: 86400
              x-microcks-default:
                status: Running
                version: 2.6.0
                configurationStatus: Synced
    servers:
    - url: https://{gateway-hostname}
      variables:
        gateway-hostname:
          default: apim-gateway.contoso.com
          description: The hostname of the self-hosted gateway instance
components:
  schemas:
    HealthStatus:
      type: object
      properties:
        status:
          type: string
          example: Healthy
        timestamp:
          type: string
          format: date-time
          example: '2024-06-15T12:00:00Z'
    InternalStatus:
      type: object
      properties:
        status:
          type: string
          example: Running
        version:
          type: string
          example: 2.6.0
        configurationStatus:
          type: string
          example: Synced
        lastConfigurationUpdate:
          type: string
          format: date-time
          example: '2024-06-15T11:55:00Z'
        connectedToManagementPlane:
          type: boolean
          example: true
        uptimeSeconds:
          type: integer
          example: 86400
x-refined-from:
- microsoft-azure-api-management-gateway-openapi.yaml
- microsoft-azure-api-management-self-hosted-gateway-openapi.yaml