Microsoft Azure API Management

Microsoft Azure API Management Health API

The Health API from Microsoft Azure API Management — 2 operation(s) for health.

Documentation GitHub OpenAPI

Documentation

https://learn.microsoft.com/en-us/rest/api/apimanagement/

https://learn.microsoft.com/en-us/rest/api/apimanagement/operation-groups

https://learn.microsoft.com/en-us/azure/api-management/authentication-authorization-overview

https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts

https://learn.microsoft.com/en-us/azure/api-management/api-management-policies

https://learn.microsoft.com/en-us/azure/api-management/import-and-publish

https://learn.microsoft.com/en-us/azure/api-management/self-hosted-gateway-overview

https://learn.microsoft.com/en-us/azure/api-management/how-to-deploy-self-hosted-gateway-azure-kubernetes-service

https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities

https://learn.microsoft.com/en-us/azure/api-management/azure-openai-api-from-specification

https://learn.microsoft.com/en-us/azure/api-management/azure-ai-foundry-api

https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal-customize

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/openapi/microsoft-azure-api-management-health-api-openapi.yml

SDKs

GitHubRepository

https://github.com/Azure/api-management-self-hosted-gateway

GitHubRepository

https://github.com/Azure/api-management-developer-portal

Code Examples

https://github.com/Azure/api-management-self-hosted-gateway-ingress

https://github.com/Azure-Samples/ai-gateway

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-request-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-response-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-request-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-response-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-request-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-response-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-request-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-response-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-request-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-response-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-request-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-response-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-request-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-response-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-request-structure.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-response-structure.json

Other Resources

https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/apimanagement

https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/apimanagement

https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/apimanagement

https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/apimanagement

https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/apimanagement

https://learn.microsoft.com/en-us/azure/api-management/transform-api

https://github.com/Azure/api-management-policy-snippets

https://github.com/Azure/azure-api-management-policy-toolkit

https://github.com/Azure/api-management-self-hosted-gateway/tree/main/helm-charts/azure-api-management-gateway

MCPServerOverview

https://learn.microsoft.com/en-us/azure/api-management/mcp-server-overview

ExportRESTToMCP

https://learn.microsoft.com/en-us/azure/api-management/export-rest-mcp-server

ProxyExistingMCP

https://learn.microsoft.com/en-us/azure/api-management/expose-existing-mcp-server

https://learn.microsoft.com/en-us/azure/api-management/agent-to-agent-api

TokenLimitPolicy

https://learn.microsoft.com/en-us/azure/api-management/llm-token-limit-policy

SemanticCaching

https://learn.microsoft.com/en-us/azure/api-management/azure-openai-enable-semantic-caching

ContentSafetyPolicy

https://learn.microsoft.com/en-us/azure/api-management/llm-content-safety-policy

ReferenceArchitecture

https://github.com/Azure-Samples/ai-hub-gateway-solution-accelerator

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-ld/microsoft-azure-api-management-ai-gateway-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-request-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-response-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-request-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-response-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-request-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-response-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-request-example.json

https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-response-example.json

https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal-customize

OpenAPI Specification

openapi: 3.0.3
info:
  title: Azure API Management Gateway AI Health API
  description: The AI gateway capabilities in Azure API Management provide specialized features for managing, securing, and observing AI backend APIs including Azure OpenAI, OpenAI-compatible LLMs, MCP servers, and A2A agent APIs. Includes token rate limiting, semantic caching, load balancing across AI backends, and content safety enforcement.
  version: '2024-05-01'
  contact:
    name: Microsoft Azure
    url: https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
servers:
- url: https://{service-name}.azure-api.net
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
  /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
components:
  schemas:
    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
    HealthStatus:
      type: object
      properties:
        status:
          type: string
          example: Healthy
        timestamp:
          type: string
          format: date-time
          example: '2024-06-15T12:00:00Z'
externalDocs:
  description: Documentation
  url: https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
x-generated-from: documentation