Custom Domains

Info: Configuring custom domains is an optional step.

You can bind a custom domain name to allow API calls. Custom domain example:

{
 "metadata": {},
 "properties": {
 "name": "APIGateway-1",
 "logs": false,
 "metrics": false,
 "customDomains": [
 {
 "name": "api.example.com",
 "certificateId": "5a029f4a-72e5-11ec-90d6-0242ac120003"
 }
 ]
 }
}

Using custom domains in API Gateway is possible in the following ways:

• If you don't need to use the custom domain, you don't need to provide anything for customDomains. In the IONOS API Gateway, a public endpoint is automatically provided for your API instance upon creation.

• If you want to use the custom domain but with the IONOS TLS, you only need to provide the name in customDomains and make a CNAME record of your custom domain (name) to the given API Gateway public endpoint.

• If you want to use the custom domain and your own TLS certificate, you must provide the name and certificateId. This certificateId is the ID of the certificate that you have created at IONOS Certificate Manager Service API (1.0) or Certificate Manager Service API (2.0).

Note: You can create up to five custom domains only.