Skip to content

Commit f186b02

Browse files
committed
[APIM] CORS for dev portal custom domain
1 parent f1e35c8 commit f186b02

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

articles/api-management/configure-custom-domain.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: dlepow
77

88
ms.service: azure-api-management
99
ms.topic: how-to
10-
ms.date: 05/09/2025
10+
ms.date: 05/30/2025
1111
ms.author: danlep
1212
ms.custom: engagement-fy23
1313
---
@@ -48,10 +48,10 @@ There are several API Management endpoints to which you can assign a custom doma
4848
| Endpoint | Default |
4949
| -------- | ----------- |
5050
| **Gateway** | Default is: `<apim-service-name>.azure-api.net`. Gateway is the only endpoint available for configuration in the Consumption tier.<br/><br/>The default Gateway endpoint configuration remains available after a custom Gateway domain is added. |
51-
| **Developer portal** | Default is: `<apim-service-name>.developer.azure-api.net` |
52-
| **Management** | Default is: `<apim-service-name>.management.azure-api.net` |
53-
| **Configuration API (v2)** | Default is: `<apim-service-name>.configuration.azure-api.net` |
54-
| **SCM** | Default is: `<apim-service-name>.scm.azure-api.net` |
51+
| **Developer portal** (all tiers except Consumption) | Default is: `<apim-service-name>.developer.azure-api.net` |
52+
| **Management** (classic tiers only) | Default is: `<apim-service-name>.management.azure-api.net` |
53+
| **Self-hosted gateway configuration API (v2)** | Default is: `<apim-service-name>.configuration.azure-api.net` |
54+
| **SCM** (classic tiers only) | Default is: `<apim-service-name>.scm.azure-api.net` |
5555

5656
### Considerations
5757

@@ -60,6 +60,7 @@ There are several API Management endpoints to which you can assign a custom doma
6060
* Only API Management instance owners can use **Management** and **SCM** endpoints internally. These endpoints are less frequently assigned a custom domain name.
6161
* The **Premium** and **Developer** tiers support setting multiple hostnames for the **Gateway** endpoint.
6262
* Wildcard domain names, like `*.contoso.com`, are supported in all tiers except the Consumption tier. A specific subdomain certificate (for example, api.contoso.com) would take precedence over a wildcard certificate (*.contoso.com) for requests to api.contoso.com.
63+
* When configuing a custom domain for the **Developer portal**, you can [enable CORS](enable-cors-developer-portal.md) on the new domain name. This is needed for developer portal visitors to use the interactive console in the API reference pages.
6364

6465
## Domain certificate options
6566

articles/api-management/enable-cors-developer-portal.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,20 @@ author: dlepow
66

77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 12/22/2023
9+
ms.date: 05/30/2025
1010
ms.author: danlep
1111
---
1212

1313
# Enable CORS for interactive console in the API Management developer portal
14+
15+
[!INCLUDE [premium-dev-standard-basic-premiumv2-standarv2-basicv2.md](../../includes/api-management-availability-premium-dev-standard-basic-premiumv2-standardv2-basicv2.md)]
16+
1417
Cross-origin resource sharing (CORS) is an HTTP-header based mechanism that allows a server to indicate any origins (domain, scheme, or port) other than its own from which a browser should permit loading resources.
1518

1619
To let visitors to the API Management [developer portal](developer-portal-overview.md) use the interactive test console in the API reference pages, enable a [CORS policy](cors-policy.md) for APIs in your API Management instance. If the developer portal's domain name isn't an allowed origin for cross-domain API requests, test console users will see a CORS error.
1720

1821
For certain scenarios, you can configure the developer portal as a CORS proxy instead of enabling a CORS policy for APIs.
1922

20-
[!INCLUDE [premium-dev-standard-basic.md](../../includes/api-management-availability-premium-dev-standard-basic.md)]
21-
2223
## Prerequisites
2324

2425
+ Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md)
@@ -41,6 +42,9 @@ You can enable a setting to configure a CORS policy automatically for all APIs i
4142

4243
![Screenshot that shows where to check status of your CORS policy in the developer portal.](media/enable-cors-developer-portal/cors-azure-portal.png)
4344

45+
> [!TIP]
46+
> When configuring a [custom domain](configure-custom-domain.md) for the developer portal, you can enable a CORS setting for the custom developer portal domain name. This setting is added to the CORS policy configuration for the default developer portal domain name, if you already enabled it.
47+
4448

4549
### Enable CORS policy manually
4650

0 commit comments

Comments
 (0)