API Gateway - Custom domain stuck in an updating status

Question

Hello.

Since last week, one of the custom domains configured in the API Gateway service has been in a continuous "updating" status. The custom domain was set up several weeks ago, and no changes have been made to it since then.
Upon executing the SAW runbook, everything appears to be properly configured, apart from the "updating" status itself. (The data was modified to mask the genuine details)

{
  "Result": "The custom domain name is configured correctly",
  "DomainDetails": {
    "DomainName": "device-manager.dafasf.com",
    "APIGatewayDomainName": "dsfasdfasdf.execute-api.eu-west-1.amazonaws.com",
    "Status": "UPDATING",
    "EndpointType": "REGIONAL"
  },
  "MappingDetails": [
    {
      "API": "asfasdfasdf",
      "MappingId": "adsfasdfas",
      "MappingKey": "",
      "Stage": "v1",
      "Status": "ApiHasMappings"
    }
  ],
  "DNSDetails": {
    "CNAME": [
      "asdfasdfasdf.execute-api.eu-west-1.amazonaws.com"
    ],
    "A": [
    ...
    ]
  }

The problem is that I am unable to either edit or remove the custom domain, whether through the AWS console or the AWS CLI.

"What steps could I take to resolve this issue?"

re:Post Agent · Answer

When a custom domain name in API Gateway is stuck in the "UPDATING" state, this can be a challenging issue to resolve. Here are some steps you can take:

1. Wait for the process to complete: API Gateway typically takes about 15 minutes to provision or update a custom domain name. If it's been significantly longer than this (which seems to be the case since it's been a week), then there's likely an underlying issue.

2. Check for certificate issues: If you're using an ACM certificate, verify that it's still valid and hasn't expired. Certificate updates can also take about 15 minutes to complete.

3. Contact AWS Support: Since you're unable to edit or remove the custom domain through both the AWS console and AWS CLI, this suggests there might be an underlying service issue. AWS Support would have the tools to investigate and potentially resolve this on the backend.

4. Check domain verification: One possible cause could be related to domain verification. If you purchased the domain through Route 53, ensure that it has been properly verified. Domains can be suspended if they fail verification within 15 days of purchase.

5. Try API Gateway API directly: As a last resort, you could try using the API Gateway API directly (not just through the CLI) to update or delete the domain name. The UpdateDomainName operation might provide more detailed error information.

Remember that attempting to delete and recreate the custom domain might be necessary once you regain control, but this should only be done after ensuring that it won't disrupt your services.  
**Sources**  
[Custom Domain & API Gateway Connection suddenly disconnected. | AWS re:Post](https://repost.aws/questions/QUin468pqjS0GSuNq3OcsCdg/custom-domain-api-gateway-connection-suddenly-disconnected)  
[Custom domain names for private APIs in API Gateway - Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)  
[DomainName - Amazon API Gateway](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/domainnames-domainname.html)

API Gateway - Custom domain stuck in an updating status

Add your answer

Relevant content