Get the answers to common questions about Azure API Management.
What does it mean when a feature is in preview?
When a feature is in preview, it means that we're actively seeking feedback on how the feature is working for you. A feature in preview is functionally complete, but it's possible that we'll make a breaking change in response to customer feedback. We recommend that you don't depend on a feature that is in preview in your production environment.
How do I find out about updates and changes to API Management?
Subscribe to update announcements published in these locations:
How can I secure the connection between the API Management gateway and my backend services?
You have several options to secure the connection between the API Management gateway and your backend services, including:
- Use subscription key authentication. On its own, a subscription key isn't a strong form of authentication, but is often used along with another method. For more information, see Authentication and authorization in API Management.
- Use TLS mutual authentication as described in How to secure back-end services by using client certificate authentication in Azure API Management.
- Use IP filtering on your back-end service. In all tiers of API Management except the Consumption tier, the IP address of the gateway remains constant. For more information, see IP addresses of Azure API Management.
- Connect your API Management instance to an Azure virtual network.
- Configure OAuth 2.0 authorization. For more information, see Authentication and authorization in API Management.
How do I copy my API Management service instance to a new instance?
You have several options, including:
- Use the backup and restore functionality in API Management.
- Create your own backup and restore feature by using the API Management REST API to save and restore the entities from the service instance that you want.
- Download the service configuration by using Git, and then upload it to a new instance.
Can I move an API Management instance from one subscription to another?
Yes. To learn how, see Move resources to a new resource group or subscription.
Can I manage my API Management instance programmatically?
Yes, you can manage API Management programmatically by using a variety of tools, including:
- The API Management REST API
- Azure PowerShell and Azure CLI
- Azure Resource Manager and Bicep templates. See example quickstart templates.
How do I add a user to the Administrators group?
Administrators group is an immutable system group that includes Azure subscription administrators. You can't add a user to this group. For more information, see How to create and use groups to manage developer accounts in Azure API Management.
Why is the policy that I want to add unavailable in the policy editor?
If the policy that you want to add appears greyed or shaded in the policy editor, be sure that you are in the correct scope for the policy. Each policy statement is designed for use in specific scopes and policy sections. To review the policy sections and scopes for a policy, see the policy's Usage section in the policy reference.
How do I set up multiple environments in a single API?
To set up multiple environments, for example, a test environment and a production environment, in a single API, you have two options. You can:
- Host different APIs on the same API Management instance.
- Host the same APIs on different instances.
Does API Management only support REST API backends?
API Management supports REST APIs as well as passthrough to SOAP, WebSocket, and GraphQL APIs. API Management also supports synthetic GraphQL APIs.
API Management also integrates with Azure compute offerings commonly used for building and hosting APIs on Azure, including Functions, Logic Apps, Container Apps, and Web Apps.
Are there restrictions on importing my API?
See API import restrictions and known issues for OpenAPI (Swagger), WSDL, and WADL formats.
Can I use CI/CD for API development?
Yes. For more information, see Use DevOps and CI/CD to publish APIs.
For architectural guidance, see Azure API Management landing zone accelerator.
What routing method does API Management use in deployments to multiple geographic locations?
API Management uses the performance traffic routing method (lowest latency) in deployments to multiple geographic locations. For more information, see Deploy an Azure API Management instance to multiple Azure regions.
Does API Management work with Azure ExpressRoute?
What is the minimum subnet size needed when deploying API Management into a VNet?
The minimum subnet size needed to deploy API Management is /29. Learn more about using API Management in virtual networks.
Does API Management provide a web application firewall (WAF)?
While API Management doesn't include a WAF component, deploying a WAF upstream (in front) of the API Management instance is recommended. For example, use Azure Application Gateway or Azure Front Door.
What are the differences between the managed gateway and the self-hosted gateway?
For information, see API gateway in API Management and the Self-hosted gateway overview.
How does API Management handle trailing slashes when calling backend services?
Historically and by convention a URL ending with a trailing slash is treated as a directory, for example
https://contoso.com/sample/ whereas the same URL without the trailing slash
https://contoso.com/sample would indicate a file. This isn't mandated; some systems consider those two URLs unique, others consider them the same. API Management doesn’t make a distinction, thus a single operation
resource will accept either
resource/. However, the distinction may matter to the backend host. Some web servers will automatically redirect a URL not ending with a trailing slash, to the same URL ending in a trailing slash. As API Management is the client to the backend (server), an automatic redirect isn't always desirable. If needed, create a Rewrite URL policy to ensure a trailing slash is always added to the outbound backend call.