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
- Open the admin dashboard, pick your app, then open Domains under Configure.
- Step 1, Domain: enter the parent name and click Continue. Use
yourdomain.comto getapi.yourdomain.com, ortrade.yourdomain.comto getapi.trade.yourdomain.com. - 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. Ifdocs.<your domain>already hosts your own docs, type another name in the box, such asdevelopers(your domain is added for you, givingdevelopers.<your domain>). It must be a single name, notapiorws. Set your logo and colors on the Docs page. - 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.
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.
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: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 toapi.agg.market and ws.agg.market first,
then delete the DNS records.