# Custom Domain
Route Workato API endpoints through your own domain. You can expose Workato API endpoints under your own subdomain. For example, modify the endpoint to reflect your company's subdomain.
Original API URL: https://apim.workato.com/boltco/sales-api/get-invoice
Custom domain URL: https://api.boltcompany.com/sales-api/get-invoice
TIP
Custom domains in Workato are not case sensitive.
| Steps | Description |
|---|---|
| 1. | Prepare a registered domain and subdomain name. For more information on domain names, see the ICANN documentation (opens new window). For example, blog.boltcompany.com. |
| 2. | Navigate to Tools > API Platform > Settings tab > Custom domain on the left menu. Register custom domain |
| 3. | Provide your subdomain name. Register a domain |
| 4. | Once you have configured the custom domain on Workato. It is time to create a record in your domain host. Copy apim-custom.workato.com to be used in the DNS host record. Pending verification |
| 5. | Register a new CNAME record with your domain host. See here. |
| 6. | Once the verification process succeeds. Your custom setup is complete. Completed custom domain setup |
Depending on the domain host, it may take up to an hour for the new CNAME record to propagate. After verifiying your custom domain's DNS, Workato will start generating a TLS certificate. It can take up to an hour for the certificate to be issued and ready for use. Refresh the custom domains page to check on the status.
TIP
The original API endpoint will continue to work in parallel with your custom domain.
# Configuring CNAME record
For this example, let's register the subdomain api.boltcompany.com hosted by Cloudflare.com (opens new window).
Create CNAME record with Cloudflare
| Steps | Description |
|---|---|
| 1. | Select Add record. |
| 2. | Select type as CNAME. |
| 3. | Provide the subdomain name. In this example, we are creating a subdomain api to boltcompany.com. |
| 4. | Provide the target. Paste the value which was provided in the custom domain configuration earlier: apim-custom.workato.com. |
| 5. | Save your settings. It may take up to an hour for the settings to propagate through the global domain name system. |
NOTE: Requests to custom domains are routed to a specific set of IP addresses.
# Certificate for TLS
When you use Workato’s API platform, the default domain is workato.com (opens new window). If you add a custom domain, Workato manages certificates for your APIs to enable HTTPS for your custom domain. New certificates are created automatically when you add a custom domain. These certificates will automatically renew one month before they expire. Workato uses Let’s Encrypt (opens new window) to create and manage certificates for your APIs.
CAA record
If you restrict the CAs that are allowed to issue certificates for your site, the custom domain workflow will fail when trying to issue a certificate for your custom domain. Add a CAA record for Let's Encrypt's domain name letsencrypt.org to resolve this. Find out more (opens new window).
# How to remove custom domain configuration
You may have to remove the current custom domain configuration if you would like to reconfigure your API platform to a different custom domain. To do this, simply click the Remove button on the top-right of the screen.
| Steps | Description |
|---|---|
| 1. | Select Remove button on the top-right of the screen.Custom domain page |
| 2. | Read the notes on the remove custom domain wizard. Tick the checkbox and select Remove Domain. Remove custom domain |
Now your APIs will default to apim.workato.com. Next, inform the existing users of this API collection, if you have not already done so.