Skip to main content
Your users can reach AGG on hostnames under your own domain instead of agg.market: You add DNS records once. AGG issues and renews the TLS certificates. Nothing changes in how requests are authenticated: the same x-app-id, API keys and sessions work on both hostnames.

1. Set the domain in the admin dashboard

  1. Open the admin dashboard, pick your app, then open Domains under Configure.
  2. Step 1, Domain: enter the parent name and click Continue. Use yourdomain.com to get api.yourdomain.com, or trade.yourdomain.com to get api.trade.yourdomain.com.
  3. Step 2, Developer docs: choose Yes for branded docs at docs.<your domain>, or No for API and WebSocket only. Yes adds a third record. If docs.<your domain> already hosts your own docs, type another name in the box, such as developers (your domain is added for you, giving developers.<your domain>). It must be a single name, not api or ws. Set your logo and colors on the Docs page.
  4. Step 3, DNS records: the dashboard lists the exact records to add, each with a copy button and a found or missing mark from the last check.
Finished steps fold into a summary. Use Edit on a step to change it later.

2. Add the DNS records

Add these at your DNS provider. The admin dashboard shows the same values for your app. For Cloudflare, GoDaddy, IONOS, Squarespace and Namecheap, the provider buttons in step 3 can help you add the records. Choose Your DNS provider for anything else, and add them by hand.
The records must point straight at AGG.
  • Cloudflare: set each record to DNS only (grey cloud). A proxied (orange cloud) record stops the certificate from being issued.
  • CAA records: if your domain has any, add one that allows amazon.com. Otherwise the certificate request is refused.
  • No other records on those names. Remove any existing A, AAAA or CNAME on api., ws. or your docs hostname before adding these.

Prove ownership (TXT record)

You only need the TXT record when the hostname is already set on another AGG app, for example when you move a domain from a test app to your production app. The dashboard then shows Prove ownership with the TXT value. Add it, then click Check now.

3. Wait for Active

Click Check now after adding the records. The status moves through these steps:

4. Point your app at your hostnames

Once the status is Active, switch your client to your hostnames:
The cURL call is a quick check that your API hostname answers: Get the per-app UI config. Your website’s own origin (for example https://yourdomain.com) still has to be in Approved domains on the same page. Browser calls from an origin that isn’t listed are rejected, whichever API hostname they use. If you want the docs playground to send requests, add https://docs.<your domain> there too. A custom hostname only serves the app it was set on. A request to api.yourdomain.com with another app’s x-app-id is rejected.

Remove a domain

Click Remove custom domain under the steps. AGG stops serving your hostnames and releases their certificates. Switch your app back to api.agg.market and ws.agg.market first, then delete the DNS records.