Microsoft Azure

Azure API Management: Apigateway

Use these REST APIs to manage Azure API Management gateway deployments.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Use these REST APIs to manage Azure API Management gateway deployments.

Endpoints 7

ApiGateway

  • GETApiGateway_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/gateways/:gatewayNameGets an API Management gateway resource description.
  • PUTApiGateway_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/gateways/:gatewayNameCreates or updates an API Management gateway. This is long running operation and could take several minutes to complete.
  • DELETEApiGateway_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/gateways/:gatewayNameDeletes an existing API Management gateway.
  • PATCHApiGateway_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/gateways/:gatewayNameUpdates an existing API Management gateway.
  • GETApiGateway_ListByResourceGroup/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/gatewaysList all API Management gateways within a resource group.
  • GETApiGateway_List/subscriptions/:subscriptionId/providers/Microsoft.ApiManagement/gatewaysList all API Management gateways within a subscription.

ApiManagementGatewaySkus

  • GETGets available SKUs for API Management gateway/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/gateways/:gatewayName/skusGets all available SKU for a given API Management gateway

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
7 operations on 4 pathsGET 4PUT 1PATCH 1DELETE 1
Main resources
ApiGateway 6ApiManagementGatewaySkus 1
Response formats
application/json
Description format
Swagger 2.0, API version 2024-05-01

How to test the Azure API Management: Apigateway in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure API Management: Apigateway collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “ApiGateway_Get” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/gateways/:gatewayName), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure API Management: Apigateway?

Use these REST APIs to manage Azure API Management gateway deployments. It is listed under Developer tools and has 7 endpoints.

Who publishes the Azure API Management: Apigateway?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure API Management: Apigateway?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure API Management: Apigateway?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure API Management: Apigateway have?

7 operations on 4 paths (4 GET, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are ApiGateway, ApiManagementGatewaySkus.

Is forking the Azure API Management: Apigateway free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.