Microsoft Azure

Azure API Management: Apimgateways

Use these REST APIs for performing operations on Gateway entity in Azure API Management deployment.

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 for performing operations on Gateway entity in Azure API Management deployment.

Endpoints 26

Gateway

  • GETGateway_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways?$filter=stringLists a collection of gateways registered with service instance.
  • GETGateway_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayIdGets the details of the Gateway specified by its identifier.
  • PUTGateway_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayIdCreates or updates a Gateway to be used in Api Management instance.
  • DELETEGateway_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayIdDeletes specific Gateway.
  • HEADGateway_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayIdGets the entity state (Etag) version of the Gateway specified by its identifier.
  • PATCHGateway_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayIdUpdates the details of the gateway specified by its identifier.

GatewayListKeys

  • POSTGateway_ListKeys/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/listKeysRetrieves gateway keys.

GatewayRegenerateKey

  • POSTGateway_RegenerateKey/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/regenerateKeyRegenerates specified gateway key invalidating any tokens created with it.

GatewayGenerateToken

  • POSTGateway_GenerateToken/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/generateTokenGets the Shared Access Authorization Token for the gateway.

GatewayHostnameConfiguration

  • GETGatewayHostnameConfiguration_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/hostnameConfigurations?$filter=stringLists the collection of hostname configurations for the specified gateway.
  • GETGatewayHostnameConfiguration_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/hostnameConfigurations/:hcIdGet details of a hostname configuration
  • PUTGatewayHostnameConfiguration_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/hostnameConfigurations/:hcIdCreates of updates hostname configuration for a Gateway.
  • DELETEGatewayHostnameConfiguration_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/hostnameConfigurations/:hcIdDeletes the specified hostname configuration from the specified Gateway.
  • HEADGatewayHostnameConfiguration_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/hostnameConfigurations/:hcIdChecks that hostname configuration entity specified by identifier exists for specified Gateway entity.

GatewayApi

  • GETGatewayApi_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/apis?$filter=stringLists a collection of the APIs associated with a gateway.
  • PUTGatewayApi_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/apis/:apiIdAdds an API to the specified Gateway.
  • DELETEGatewayApi_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/apis/:apiIdDeletes the specified API from the specified Gateway.
  • HEADGatewayApi_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/apis/:apiIdChecks that API entity specified by identifier is associated with the Gateway entity.

GatewayCertificateAuthority

  • GETGatewayCertificateAuthority_ListByService/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/certificateAuthorities?$filter=stringLists the collection of Certificate Authorities for the specified Gateway entity.
  • GETGatewayCertificateAuthority_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/certificateAuthorities/:certificateIdGet assigned Gateway Certificate Authority details.
  • PUTGatewayCertificateAuthority_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/certificateAuthorities/:certificateIdAssign Certificate entity to Gateway entity as Certificate Authority.
  • DELETEGatewayCertificateAuthority_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/certificateAuthorities/:certificateIdRemove relationship between Certificate Authority and Gateway entity.
  • HEADGatewayCertificateAuthority_GetEntityTag/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/certificateAuthorities/:certificateIdChecks if Certificate entity is assigned to Gateway entity as Certificate Authority.

GatewayInvalidateDebugCredentials

  • POSTGateway_InvalidateDebugCredentials/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/invalidateDebugCredentialsAction is invalidating all debug credentials issued for gateway.

GatewayListDebugCredentials

  • POSTGateway_ListDebugCredentials/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/listDebugCredentialsCreate new debug credentials for gateway.

GatewayListTrace

  • POSTGateway_ListTrace/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways/:gatewayId/listTraceFetches trace collected by gateway.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
26 operations on 14 pathsGET 7POST 6PUT 4HEAD 4DELETE 4PATCH 1
Main resources
Gateway 6GatewayCertificateAuthority 5GatewayHostnameConfiguration 5GatewayApi 4GatewayGenerateToken 1GatewayInvalidateDebugCredentials 1GatewayListDebugCredentials 1GatewayListKeys 1GatewayListTrace 1GatewayRegenerateKey 1
Response formats
application/json
Description format
Swagger 2.0, API version 2024-05-01

How to test the Azure API Management: Apimgateways 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: Apimgateways 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 “Gateway_ListByService” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ApiManagement/service/:serviceName/gateways?$filter=string), 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: Apimgateways?

Use these REST APIs for performing operations on Gateway entity in Azure API Management deployment. It is listed under Developer tools and has 26 endpoints.

Who publishes the Azure API Management: Apimgateways?

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: Apimgateways?

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

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

With OAuth 2.0 (implicit flow) with 1 scope.

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

26 operations on 14 paths (7 GET, 6 POST, 4 PUT, 4 HEAD, 4 DELETE, 1 PATCH). The largest groups are Gateway, GatewayCertificateAuthority, GatewayHostnameConfiguration, GatewayApi.

Is forking the Azure API Management: Apimgateways 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.