Issues with custom domains in APIM Standard V2

Question

Issues with custom domains in APIM Standard V2

Steve 45

Hi,

We are facing problems with custom domains in APIM Standard V2:

Custom domains configured for the APIM gateway are not displayed in the API documentation of the developer portal. Instead, the default MS provided domain is always shown.
I am unable to set up a custom domain for the developer portal. The only option available in the custom domains blade is for setting up a gateway custom domain.

I understand that this tier is currently in preview, but are there any known workarounds?

Thanks,

Steve Harper

Answer accepted by question author

3 additional answers

Your answer

Answer 1

JananiRamesh-MSFT 29,356 Moderator

@Steve Thanks for reaching out. The custom domain for developer portal has been implemented recently, it will be included in the current/next release. Also, azure portal needs to be changed to support adding custom domain for developer portal.

I would recommend you track update in https://github.com/Azure/API-Management/releases. Unfortunately, there is no workaround available.

We apologize for the inconvenience caused by the issue. Feel free to add a comment if any questions.

Please 'Accept as answer' and ‘Upvote’ if it helped so that it can help others in the community looking for help on similar topics.

Steve 45 Reputation points

2024-03-12T18:43:05.4866667+00:00

@JananiRamesh-MSFT thanks for the update. That explains why I am having problems setting up a custom domain for the developer portal but what about the bug where the APIM gateway custom domain does not show in the developer portal API documentation? Is this something your team are aware of and will it also be fixed in the next release?

Thanks,

Steve Harper
JananiRamesh-MSFT 29,356 Reputation points Moderator

2024-03-13T17:12:24.18+00:00

Hi Steve Thanks for getting back, do you mean you were not able to see the custom domain configured for gateway endpoint is not listed in the APIM developer portal's hostname drop down? If not please help me with the screen shot.
Steve 45 Reputation points

2024-03-15T16:46:12.0433333+00:00

Sure,

In the Azure Portal the custom domain I have setup for the APIM gateway shows on the APIM dashboard:

However in the APIM Developer Portal I see the default domain:

When I would expect to see:

https://api.evo-group.co.uk/vow/despatches?AccountNumber={AccountNumber}&OrderNumber={OrderNumber}

Hope this helps to clarify the issue.

Thanks,

Steve Harper
JananiRamesh-MSFT 29,356 Reputation points Moderator

2024-03-18T15:08:42.72+00:00

Hi Steve Thanks for the information, this seems to be a bug and will create a work item for the same. apologize for any inconvenience caused on this.

Please accept as Yes if the answer provided is useful, so that you can help others in the community looking for remediation for similar issues.
Steve 45 Reputation points

2024-03-18T18:40:09.6366667+00:00

Hi, thanks for getting back to me.. i hope these issues are resolved soon.
Steve 45 Reputation points

2024-06-03T16:16:13.5466667+00:00

Hi, I am still having problems setting up a custom domain for the APIM developer portal. When adding a domain the "service is being updated" message displays and then disappears a few minuets later. Afterwards the domain I added does not show in the list of custom domains and the developer portal cannot be accessed using the domain. Any ideas?
JananiRamesh-MSFT 29,356 Reputation points Moderator

2024-06-13T03:49:54.1133333+00:00

Steve Thanks for getting back, There is also a known issue that you can't use the same wildcard certificate for multiple endpoints in v2 (i.e, cannot use the same certificate/thumbprint for different type of custom domain in skuv2). Please try to add a custom domain for devPortal using a different thumbprint.

do let me know incase of further queries, I would be happy to assist you.
valentino r 0 Reputation points

2024-10-20T10:25:40.6066667+00:00

Is there a fix for now? I added a custom domain via managed. Added txt and cname record. Save it. After updating suddenly the added custom domain is gone.
Andreas Rehmann 20 Reputation points

2024-10-27T12:17:46.57+00:00

@JananiRamesh-MSFT Is there an update regarding the custom domain name of the gateway not being used in the Developer Portal? You wrote that this is a bug and that there will be a work item for this.

I still see this behaviour, which causes some trouble on our side. We see API consumers using the default domain name - which is not good. We had to change the APIM service name recently, which now causes trouble.
Andreas Rehmann 20 Reputation points

2024-10-27T12:18:40.8333333+00:00

@JananiRamesh-MSFT Is there an update regarding the custom domain name of the gateway not being used in the Developer Portal? You wrote that this is a bug and that there will be a work item for this.

I still see this behaviour, which causes some trouble on our side. We see API consumers using the default domain name - which is not good. We had to change the APIM service name recently, which now causes trouble.
Wilko van de Velde 2,236 Reputation points

2024-12-10T09:50:18.4466667+00:00

Can someone please give an update about this issue?
Jesse Amundsen 6 Reputation points

2025-02-25T17:17:04.4+00:00

Add another vote to this. I was very surprised to not see the developer portal reflect or give me the option to reflect our custom domain. I assume there is no workaround. We are using the Standard V2 tier.

Answer 2

Jonathan Nathanson 1

This is still a problem - the custom domain for the API endpoints is configured but is not used in the Developer Portal documentation for the API.

This issue is only happenign with v2 deployments, the Developer tier for example does not have the same bug.

When can we expect a fix? Not displaying the custom domain in the developer portal API documentation looks extremely unprofessional.

Answer 3

Tobias Bauer 0

Facing the same issue. Classic tiers correctly show custom domains, v2 instances still display the default gateway domains on developer portal.

Answer 4

Cato Van Wezel 20

We are also experiencing this issue, but on Basic v2.

Our gateway custom domain is correctly configured and healthy, but the Developer Portal still displays the default *.azure-api.net URL in the API documentation and “Try it” console. This continues after republishing the portal and clearing cache/service worker. This suggests the problem is not limited to Standard v2 but also affects Basic v2. Could Microsoft please confirm and provide an ETA for the fix?

Share via

Issues with custom domains in APIM Standard V2

3 additional answers

Your answer