Microsoft Azure API Management Gateway API

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

Documentation GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways List self-hosted gateways in the service · Microsoft Azure API Management Gateway_ListByService #

Ask an LLM

“Which gateways are registered with my API Management instance?”

“Can I see all the self-hosted gateways attached to the service?”

Tell an agent

List the gateways registered with my {serviceName} API Management service.

Show every gateway resource in this APIM instance.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Check a gateway's ETag · Microsoft Azure API Management Gateway_GetEntityTag #

Ask an LLM

“How do I get the ETag of a gateway before editing it?”

“Can I check that a gateway exists without fetching its body?”

Tell an agent

Get the current ETag of gateway {gatewayId} on service {serviceName}.

Check the gateway's current ETag.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Get a gateway's details · Microsoft Azure API Management Gateway_Get #

Ask an LLM

“How do I look up the location and description of one gateway?”

“What configuration does a registered gateway have?”

Tell an agent

Get the details of gateway {gatewayId} in {serviceName}.

Show the gateway resource by its identifier.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Create or replace a gateway · Microsoft Azure API Management Gateway_CreateOrUpdate #

Ask an LLM

“How do I register a new self-hosted gateway with API Management?”

“Can I overwrite a gateway definition that already exists?”

Tell an agent

Register or replace gateway {gatewayId} in my {serviceName} service.

Create or replace this gateway resource.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Update a gateway's details · Microsoft Azure API Management Gateway_Update #

Ask an LLM

“Can I change the description or location info of an existing gateway?”

“Is a partial update supported on gateway resources?”

Tell an agent

Patch the location metadata of existing gateway {gatewayId} in {serviceName}.

Patch the existing gateway's location metadata.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId} Delete a gateway · Microsoft Azure API Management Gateway_Delete #

Ask an LLM

“Can I unregister a gateway I've decommissioned?”

“What happens to a self-hosted gateway once its resource is deleted?”

Tell an agent destructive · confirm first

Delete gateway {gatewayId} from service {serviceName}.

Remove the decommissioned gateway resource.

GET /{api-path} Send a GET through the gateway to a backend · Proxy GET request to backend API #

Ask an LLM

“How do I call a backend API through the API Management gateway with GET?”

“Are gateway policies applied when I fetch data through the proxy?”

Tell an agent

Send a GET request through the gateway to {api_path}.

Fetch {api_path} via the API Management gateway.

POST /{api-path} Send a POST through the gateway to a backend · Proxy POST request to backend API #

Ask an LLM

“How do I submit data to a backend API through the gateway with POST?”

“Will a POST routed through API Management go through my inbound policies?”

Tell an agent

Send a POST request through the gateway to {api_path}.

Post a payload to {api_path} via the API Management gateway.

PUT /{api-path} Send a PUT through the gateway to a backend · Proxy PUT request to backend API #

Ask an LLM

“Can I replace a resource on my backend by sending a PUT via the gateway?”

“Does the gateway apply its configured policies to PUT calls?”

Tell an agent

Send a PUT request through the gateway to {api_path}.

Replace the backend resource at {api_path} via a proxied PUT.

DELETE /{api-path} Send a DELETE through the gateway to a backend · Proxy DELETE request to backend API #

Ask an LLM

“Can I delete a backend resource by routing a DELETE through the gateway?”

“Are policies enforced on DELETE calls passing through API Management?”

Tell an agent destructive · confirm first

Send a DELETE request through the gateway to {api_path}.

Delete the backend resource at {api_path} via the gateway.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

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-rest-api-openapi.yaml, 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://management.azure.com
- 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: Gateway
paths:
  ? /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
  /{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
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-rest-api-openapi.yaml
- microsoft-azure-api-management-gateway-openapi.yaml
- microsoft-azure-api-management-self-hosted-gateway-openapi.yaml

Microsoft Azure API Management Gateway API

Operations 10

Documentation

Specifications

SDKs

Code Examples

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification