You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/configure-custom-domain.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ author: dlepow
7
7
8
8
ms.service: azure-api-management
9
9
ms.topic: how-to
10
-
ms.date: 05/09/2025
10
+
ms.date: 05/30/2025
11
11
ms.author: danlep
12
12
ms.custom:
13
13
- engagement-fy23
@@ -50,10 +50,10 @@ There are several API Management endpoints to which you can assign a custom doma
50
50
| Endpoint | Default |
51
51
| -------- | ----------- |
52
52
|**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. |
53
-
|**Developer portal**| Default is: `<apim-service-name>.developer.azure-api.net`|
54
-
|**Management**| Default is: `<apim-service-name>.management.azure-api.net`|
55
-
|**Configuration API (v2)**| Default is: `<apim-service-name>.configuration.azure-api.net`|
56
-
|**SCM**| Default is: `<apim-service-name>.scm.azure-api.net`|
53
+
|**Developer portal**(all tiers except Consumption) | Default is: `<apim-service-name>.developer.azure-api.net`|
54
+
|**Management**(classic tiers only) | Default is: `<apim-service-name>.management.azure-api.net`|
55
+
|**Self-hosted gateway configuration API (v2)**| Default is: `<apim-service-name>.configuration.azure-api.net`|
56
+
|**SCM**(classic tiers only) | Default is: `<apim-service-name>.scm.azure-api.net`|
57
57
58
58
### Considerations
59
59
@@ -62,6 +62,7 @@ There are several API Management endpoints to which you can assign a custom doma
62
62
* Only API Management instance owners can use **Management** and **SCM** endpoints internally. These endpoints are less frequently assigned a custom domain name.
63
63
* The **Premium** and **Developer** tiers support setting multiple hostnames for the **Gateway** endpoint.
64
64
* 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.
65
+
* When configuing a custom domain for the **Developer portal**, you can [enable CORS](enable-cors-developer-portal.md) for the new domain name. This is needed for developer portal visitors to use the interactive console in the API reference pages.
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.
15
18
16
19
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.
17
20
18
21
For certain scenarios, you can configure the developer portal as a CORS proxy instead of enabling a CORS policy for APIs.
+ Complete the following quickstart: [Create an Azure API Management instance](get-started-create-service-instance.md)
@@ -41,7 +42,6 @@ You can enable a setting to configure a CORS policy automatically for all APIs i
41
42
42
43

43
44
44
-
45
45
### Enable CORS policy manually
46
46
47
47
1. Select the **Manually apply it on the global level** link to see the generated policy code.
@@ -57,6 +57,12 @@ You can enable a setting to configure a CORS policy automatically for all APIs i
57
57
>
58
58
> As a workaround, you can pass the subscription key in a query parameter.
59
59
60
+
## CORS configuration for custom domain name
61
+
62
+
If you configure a [custom domain](configure-custom-domain.md) for the developer portal and want visitors to use the test console on API reference pages, ensure that you enable CORS for the custom developer portal domain name.
63
+
64
+
When configuring the custom domain, you can enable a setting to add an origin for your custom developer portal domain in the CORS policy. If CORS was already enabled for the default domain, both origins will be included in the CORS policy. You can change the CORS policy settings anytime.
65
+
60
66
## CORS proxy option
61
67
62
68
For some scenarios (for example, if the API Management gateway is network isolated), you can choose to configure the developer portal as a CORS proxy itself, instead of enabling a CORS policy for your APIs. The CORS proxy routes the interactive console's API calls through the portal's backend in your API Management instance.
@@ -84,4 +90,4 @@ If you [self-host](developer-portal-self-host.md) the developer portal, the foll
84
90
## Related content
85
91
86
92
* For more information about configuring a policy, see [Set or edit policies](set-edit-policies.md).
87
-
* For details about the CORS policy, see the [cors](cors-policy.md) policy reference.
93
+
* For details about the CORS policy, see the [cors](cors-policy.md) policy reference.
0 commit comments