Microsoft Azure API Management Subscriptions API

The Subscriptions API from Microsoft Azure API Management — 4 operation(s) for subscriptions.

Documentation GitHub OpenAPI

Operations 12

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}/apis List all APIs in an API Management service · Microsoft Azure API Management Api_ListByService #

Ask an LLM

“What APIs are published in my API Management instance?”

“Can I get a list of every API across the whole service, not just one workspace?”

Tell an agent

List all APIs in my API Management service.

Show every API registered at the service level.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Check a service-level API's ETag · Microsoft Azure API Management Api_GetEntityTag #

Ask an LLM

“How do I fetch an API's current ETag before I update it?”

“Can I confirm a service-level API exists with a HEAD request?”

Tell an agent

Get the entity tag version of this API.

Check the ETag for the service-level API.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Get a service-level API's details · Microsoft Azure API Management Api_Get #

Ask an LLM

“How do I see the path, protocols and settings of one API in APIM?”

“Where can I look up a single API's configuration by its identifier?”

Tell an agent

Get the details of this API in my API Management service.

Show the service-level API definition by its ID.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Create or replace an API in the service · Microsoft Azure API Management Api_CreateOrUpdate #

Ask an LLM

“How do I add a new API to my API Management instance?”

“Can I import or overwrite an existing API definition at the service level?”

Tell an agent

Create an API in my API Management service with {properties}.

Create or replace this service-level API.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Update an existing API in the service · Microsoft Azure API Management Api_Update #

Ask an LLM

“Can I change only a few properties on an API that already exists in APIM?”

“Is there a way to patch an API's display name or path without redefining it?”

Tell an agent

Update my existing service-level API with {properties}.

Patch the settings of this API in the API Management service.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId} Delete an API from the service · Microsoft Azure API Management Api_Delete #

Ask an LLM

“Can I remove an API from API Management once it's retired?”

“Does deleting a service-level API also remove its operations?”

Tell an agent destructive · confirm first

Delete this API from my API Management service.

Remove the retired service-level API.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis List the APIs in a workspace · Microsoft Azure API Management WorkspaceApi_ListByService #

Ask an LLM

“Which APIs belong to one workspace in my API Management instance?”

“Can I scope the API list to a single workspace team?”

Tell an agent

List the APIs in this workspace.

Show the APIs a workspace owns.

HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Check a workspace API's ETag · Microsoft Azure API Management WorkspaceApi_GetEntityTag #

Ask an LLM

“How do I read the ETag of an API in a workspace?”

“Is there a quick existence check for a workspace-scoped API?”

Tell an agent

Get the entity tag of this workspace API.

Check whether the workspace API exists and return its ETag.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Get an API inside a workspace · Microsoft Azure API Management WorkspaceApi_Get #

Ask an LLM

“How do I view the details of an API that lives in a workspace?”

“What configuration does a workspace-scoped API have?”

Tell an agent

Get this workspace API by its identifier.

Show me the API definition from the workspace.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Create or replace an API in a workspace · Microsoft Azure API Management WorkspaceApi_CreateOrUpdate #

Ask an LLM

“Can a workspace team publish its own API in API Management?”

“How do I add an API that only belongs to one workspace?”

Tell an agent

Create a new API inside my workspace.

Create or overwrite this API at workspace scope.

PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Update an API in a workspace · Microsoft Azure API Management WorkspaceApi_Update #

Ask an LLM

“Can I patch a few fields on an API owned by a workspace?”

“Is a partial update supported for workspace APIs?”

Tell an agent

Update the workspace API's settings.

Patch this API inside my APIM workspace.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId} Delete an API from a workspace · Microsoft Azure API Management WorkspaceApi_Delete #

Ask an LLM

“Can I delete an API that belongs to a workspace?”

“Will removing a workspace API affect APIs at the service level?”

Tell an agent destructive · confirm first

Delete this API from the workspace.

Remove the workspace-scoped API.

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-subscriptions-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: Azure API Management REST Subscriptions API
  description: REST APIs for managing Azure API Management service instances and their entities including APIs, products, subscriptions, users, groups, policies, gateways, backends, certificates, and workspaces. Uses Azure Resource Manager conventions.
  version: '2024-05-01'
  contact:
    name: Microsoft Azure
    url: https://learn.microsoft.com/en-us/rest/api/apimanagement/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  x-source: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/apimanagement/resource-manager/Microsoft.ApiManagement/ApiManagement/stable/2024-05-01
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: Subscriptions
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis
  : get:
      summary: Microsoft Azure API Management Api_ListByService
      operationId: Api_ListByService
      description: Lists all APIs of the API Management service instance.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCollection'
              examples:
                ApiListExample:
                  summary: List of APIs
                  value:
                    value:
                    - id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                      name: petstore-api
                      type: Microsoft.ApiManagement/service/apis
                      properties:
                        displayName: Petstore API
                        description: A sample API for managing pets.
                        serviceUrl: https://petstore.example.com/v1
                        path: petstore
                        protocols:
                        - https
                        subscriptionRequired: true
                        apiRevision: '1'
                    count: 1
                    nextLink: ''
              x-microcks-default:
                value: []
                count: 0
                nextLink: ''
      tags:
      - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
  : head:
      summary: Microsoft Azure API Management Api_GetEntityTag
      operationId: Api_GetEntityTag
      description: Gets the entity state (Etag) version of the API specified by its identifier.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
      tags:
      - Subscriptions
    get:
      summary: Microsoft Azure API Management Api_Get
      operationId: Api_Get
      description: Gets the details of the API specified by its identifier.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiContract'
              examples:
                ApiGetExample:
                  summary: Get API details
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                    name: petstore-api
                    type: Microsoft.ApiManagement/service/apis
                    properties:
                      displayName: Petstore API
                      description: A sample API for managing pets.
                      serviceUrl: https://petstore.example.com/v1
                      path: petstore
                      protocols:
                      - https
                      subscriptionRequired: true
                      apiRevision: '1'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                name: petstore-api
      tags:
      - Subscriptions
    put:
      summary: Microsoft Azure API Management Api_CreateOrUpdate
      operationId: Api_CreateOrUpdate
      description: Creates new or updates existing specified API of the API Management service instance.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCreateOrUpdateParameter'
            examples:
              CreateApiExample:
                summary: Create a new API
                value:
                  properties:
                    displayName: Petstore API
                    description: A sample API for managing pets.
                    serviceUrl: https://petstore.example.com/v1
                    path: petstore
                    protocols:
                    - https
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiContract'
              examples:
                CreateApiExample:
                  summary: Created API
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                    name: petstore-api
                    type: Microsoft.ApiManagement/service/apis
                    properties:
                      displayName: Petstore API
                      description: A sample API for managing pets.
                      serviceUrl: https://petstore.example.com/v1
                      path: petstore
                      protocols:
                      - https
                      subscriptionRequired: true
                      apiRevision: '1'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                name: petstore-api
      tags:
      - Subscriptions
    patch:
      summary: Microsoft Azure API Management Api_Update
      operationId: Api_Update
      description: Updates the specified API of the API Management service instance.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiCreateOrUpdateParameter'
            examples:
              UpdateApiExample:
                summary: Update API description
                value:
                  properties:
                    description: Updated API description for managing pets and inventory.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiContract'
              examples:
                UpdateApiExample:
                  summary: Updated API
                  value:
                    id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                    name: petstore-api
                    type: Microsoft.ApiManagement/service/apis
                    properties:
                      displayName: Petstore API
                      description: Updated API description for managing pets and inventory.
                      serviceUrl: https://petstore.example.com/v1
                      path: petstore
                      protocols:
                      - https
                      subscriptionRequired: true
                      apiRevision: '1'
              x-microcks-default:
                id: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
                name: petstore-api
      tags:
      - Subscriptions
    delete:
      summary: Microsoft Azure API Management Api_Delete
      operationId: Api_Delete
      description: Deletes the specified API of the API Management service instance.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: Success
      tags:
      - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis
  : get:
      summary: Microsoft Azure API Management WorkspaceApi_ListByService
      operationId: WorkspaceApi_ListByService
      description: Lists all APIs of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Subscriptions
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/apis/{apiId}
  : head:
      summary: Microsoft Azure API Management WorkspaceApi_GetEntityTag
      operationId: WorkspaceApi_GetEntityTag
      description: Gets the entity state (Etag) version of the API specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Subscriptions
    get:
      summary: Microsoft Azure API Management WorkspaceApi_Get
      operationId: WorkspaceApi_Get
      description: Gets the details of the API specified by its identifier.
      responses:
        '200':
          description: Success
      tags:
      - Subscriptions
    put:
      summary: Microsoft Azure API Management WorkspaceApi_CreateOrUpdate
      operationId: WorkspaceApi_CreateOrUpdate
      description: Creates new or updates existing specified API of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Subscriptions
    patch:
      summary: Microsoft Azure API Management WorkspaceApi_Update
      operationId: WorkspaceApi_Update
      description: Updates the specified API of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Subscriptions
    delete:
      summary: Microsoft Azure API Management WorkspaceApi_Delete
      operationId: WorkspaceApi_Delete
      description: Deletes the specified API of the workspace in an API Management service instance.
      responses:
        '200':
          description: Success
      tags:
      - Subscriptions
components:
  schemas:
    ApiContract:
      type: object
      properties:
        id:
          type: string
          example: /subscriptions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/contoso-apim/apis/petstore-api
        name:
          type: string
          example: petstore-api
        type:
          type: string
          example: Microsoft.ApiManagement/service/apis
        properties:
          type: object
          properties:
            displayName:
              type: string
              example: Petstore API
            description:
              type: string
              example: A sample API for managing pets.
            serviceUrl:
              type: string
              example: https://petstore.example.com/v1
            path:
              type: string
              example: petstore
            protocols:
              type: array
              items:
                type: string
              example:
              - https
            subscriptionRequired:
              type: boolean
              example: true
            apiRevision:
              type: string
              example: '1'
    ApiCollection:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ApiContract'
        count:
          type: integer
          example: 2
        nextLink:
          type: string
          example: ''
    ApiCreateOrUpdateParameter:
      type: object
      properties:
        properties:
          type: object
          properties:
            displayName:
              type: string
              example: Petstore API
            description:
              type: string
              example: A sample API for managing pets.
            serviceUrl:
              type: string
              example: https://petstore.example.com/v1
            path:
              type: string
              example: petstore
            protocols:
              type: array
              items:
                type: string
              example:
              - https
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account
externalDocs:
  description: Azure API Management REST API Reference
  url: https://learn.microsoft.com/en-us/rest/api/apimanagement/

Microsoft Azure API Management Subscriptions API

Operations 12

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