Microsoft Azure API Management Gateway API

The Gateway API from Microsoft Azure API Management — 3 operation(s) for gateway.

Operations 10

GET /{api-path} Proxy GET request to backend API #
POST /{api-path} Proxy POST request to backend API #
PUT /{api-path} Proxy PUT request to backend API #
DELETE /{api-path} Proxy DELETE request to backend API #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways Microsoft Azure API Management Gateway_ListByService #
HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Microsoft Azure API Management Gateway_GetEntityTag #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Microsoft Azure API Management Gateway_Get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Microsoft Azure API Management Gateway_CreateOrUpdate #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Microsoft Azure API Management Gateway_Update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Microsoft Azure API Management Gateway_Delete #

Documentation

Specifications

SDKs

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-chat-completion-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-completion-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-embedding-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-schema/ai-gateway-mcp-response-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-chat-completion-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-completion-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-embedding-response-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-request-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-structure/ai-gateway-mcp-response-structure.json

Other Resources

🔗
SDKs
https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/apimanagement
🔗
SDKs
https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/apimanagement
🔗
Tutorials
https://learn.microsoft.com/en-us/azure/api-management/transform-api
🔗
PolicySnippets
https://github.com/Azure/api-management-policy-snippets
🔗
Tools
https://github.com/Azure/azure-api-management-policy-toolkit
🔗
HelmChart
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
🔗
A2AAgentAPI
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
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/json-ld/microsoft-azure-api-management-ai-gateway-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-chat-completion-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-completion-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-embedding-response-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-request-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/microsoft-azure-api-management/refs/heads/main/examples/ai-gateway-mcp-response-example.json
🔗
Tutorials
https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-developer-portal-customize

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-api-management-gateway-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-api-management-gateway-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Microsoft Azure Api Management Gateway API
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Gateway across 3 of this provider''s published API definitions: microsoft-azure-api-management-gateway-openapi.yaml, microsoft-azure-api-management-rest-api-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://management.azure.com
- url: https://{gateway-hostname}
  variables:
    gateway-hostname:
      default: apim-gateway.contoso.com
      description: The hostname of the self-hosted gateway instance
tags:
- name: Gateway
paths:
  /{api-path}:
    get:
      summary: Proxy GET request to backend API
      operationId: Gateway_ProxyGet
      tags:
      - Gateway
      description: Routes GET request through the gateway, applying configured policies.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: api-path
        in: path
        required: true
        schema:
          type: string
        example: petstore/v1/pets
      responses:
        '200':
          description: Response from backend API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResponse'
              examples:
                ProxyGetExample:
                  summary: Proxied GET response
                  value:
                    statusCode: 200
                    headers:
                      x-apim-request-id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                      x-ms-request-id: req-001
                    body:
                      message: Response from backend service
              x-microcks-default:
                statusCode: 200
                headers:
                  x-apim-request-id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
    post:
      summary: Proxy POST request to backend API
      operationId: Gateway_ProxyPost
      tags:
      - Gateway
      description: Routes POST request through the gateway, applying configured policies.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: api-path
        in: path
        required: true
        schema:
          type: string
        example: petstore/v1/pets
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              ProxyPostExample:
                summary: Proxied POST request body
                value:
                  name: Fluffy
                  species: cat
      responses:
        '200':
          description: Response from backend API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResponse'
              examples:
                ProxyPostExample:
                  summary: Proxied POST response
                  value:
                    statusCode: 201
                    headers:
                      x-apim-request-id: b2c3d4e5-f6a7-8901-bcde-f12345678901
                    body:
                      id: pet-123
                      name: Fluffy
                      species: cat
              x-microcks-default:
                statusCode: 201
    put:
      summary: Proxy PUT request to backend API
      operationId: Gateway_ProxyPut
      tags:
      - Gateway
      description: Routes PUT request through the gateway, applying configured policies.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: api-path
        in: path
        required: true
        schema:
          type: string
        example: petstore/v1/pets/pet-123
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              ProxyPutExample:
                summary: Proxied PUT request body
                value:
                  name: Fluffy Updated
                  species: cat
      responses:
        '200':
          description: Response from backend API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResponse'
              examples:
                ProxyPutExample:
                  summary: Proxied PUT response
                  value:
                    statusCode: 200
                    headers:
                      x-apim-request-id: c3d4e5f6-a7b8-9012-cdef-123456789012
                    body:
                      id: pet-123
                      name: Fluffy Updated
                      species: cat
              x-microcks-default:
                statusCode: 200
    delete:
      summary: Proxy DELETE request to backend API
      operationId: Gateway_ProxyDelete
      tags:
      - Gateway
      description: Routes DELETE request through the gateway, applying configured policies.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: api-path
        in: path
        required: true
        schema:
          type: string
        example: petstore/v1/pets/pet-123
      responses:
        '200':
          description: Response from backend API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayResponse'
              examples:
                ProxyDeleteExample:
                  summary: Proxied DELETE response
                  value:
                    statusCode: 204
                    headers:
                      x-apim-request-id: d4e5f6a7-b8c9-0123-defa-234567890123
                    body: {}
              x-microcks-default:
                statusCode: 204
    servers:
    - url: https://{service-name}.azure-api.net
      variables:
        service-name:
          default: contoso-apim
          description: The name of the API Management service instance
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways
  : get:
      summary: Microsoft Azure API Management Gateway_ListByService
      operationId: Gateway_ListByService
      description: Lists a collection of gateways registered with service instance.
      responses:
        '200':
          description: Success
      tags:
      - Gateway
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}
  : head:
      summary: Microsoft Azure API Management Gateway_GetEntityTag
      operationId: Gateway_GetEntityTag
      description: Gets the entity state (Etag) version of the Gateway specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Gateway
      security:
      - azure_auth:
        - user_impersonation
    get:
      summary: Microsoft Azure API Management Gateway_Get
      operationId: Gateway_Get
      description: Gets the details of the Gateway specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Gateway
      security:
      - azure_auth:
        - user_impersonation
    put:
      summary: Microsoft Azure API Management Gateway_CreateOrUpdate
      operationId: Gateway_CreateOrUpdate
      description: Creates or updates a Gateway to be used in Api Management instance.
      responses:
        '200':
          description: Success
      tags:
      - Gateway
      security:
      - azure_auth:
        - user_impersonation
    patch:
      summary: Microsoft Azure API Management Gateway_Update
      operationId: Gateway_Update
      description: Updates the details of the gateway specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Gateway
      security:
      - azure_auth:
        - user_impersonation
    delete:
      summary: Microsoft Azure API Management Gateway_Delete
      operationId: Gateway_Delete
      description: Deletes specific Gateway.
      responses:
        '200':
          description: Success
      tags:
      - Gateway
      security:
      - azure_auth:
        - user_impersonation
    servers:
    - url: https://management.azure.com
components:
  schemas:
    GatewayResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 200
        headers:
          type: object
          properties:
            x-apim-request-id:
              type: string
              example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
            x-ms-request-id:
              type: string
              example: req-001
        body:
          type: object
    GatewayResponse_2:
      type: object
      properties:
        statusCode:
          type: integer
          example: 200
        headers:
          type: object
          properties:
            x-apim-request-id:
              type: string
              example: f1e2d3c4-b5a6-7890-fedc-ba0987654321
        body:
          type: object
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
x-refined-from:
- microsoft-azure-api-management-gateway-openapi.yaml
- microsoft-azure-api-management-rest-api-openapi.yaml
- microsoft-azure-api-management-self-hosted-gateway-openapi.yaml
x-generated-from: documentation