The Apps API is in beta. Its endpoints and responses may change.
Add domains in the editor, manage them here
This API doesn’t add domains to an app. There’s no create endpoint, so a domain has to exist on the app before any of these calls apply to it. Add one in the Base44 online app editor first: Everything after that is automatable. Linking a domain, watching it verify, taking it out of service, and removing it are all API calls.The domain lifecycle
A domain moves through three stages, and only the last one serves your app. You drive the first move. The second happens on its own.1
Added
The domain exists on the app but isn’t attached to Base44’s hosting, so it doesn’t serve anything yet. Call Link custom domain to move it on.
2
Linked
The domain is attached and the hosting provider is checking its DNS records. Nothing here needs a call from you. It finishes when the records propagate, which happens outside Base44 and can take as long as the nameservers do, so poll Get custom domain status to watch for the change.
3
Verified
The provider has confirmed the records point at Base44, and the domain now serves your app.
Email needs its own DNS
Sending mail from a domain is a second setup on top of the domain setup, not part of it. The DNS records that make a domain serve your app and the DNS records that let it send mail are separate sets, and the domain has to reach Verified before you can start on email at all. Email setup follows the same pattern as the domain lifecycle. You make one call, then the mail provider works through the rest on its own.1
Records published
Call Enable email sending for a domain. Base44 publishes the DNS records itself when it controls the domain’s DNS. Otherwise it returns them in
dns_records for you to publish.2
Verifying
The mail provider checks that the records resolve, without anything further from you. Poll List email domains to watch for the change, and if setup stalls, Retry email domain setup picks it up from wherever it stopped.
3
Active
The app sends from your address. Nothing sends before this point, so treat
configuration_status reading active as the signal that email works.URL redirects
A redirect sends visitors from one path on your published site to another with a 301, which search engines treat as permanent. Start at Create URL redirect, which carries the rules a rule has to satisfy.Endpoints
Custom domains
- List custom domains: List every domain attached to the app, at any stage.
- Add custom domain: Attach a domain you own to the app.
- Get custom domain: Read one domain from Base44’s stored copy.
- Get custom domain DNS records: Get the DNS records to create so the domain points at the app.
- Check domain availability: Check whether a domain can be registered through Base44.
- Get domain purchase provider: See which provider sells the workspace a new domain.
- Create domain checkout link: Create a one-time checkout link for buying a domain.
- List domain registrations: List the domains bought through Base44, with expiry and renewal.
- Link custom domain: Attach the domain to Base44’s hosting and start DNS verification.
- Get custom domain status: Ask the hosting provider whether the domain’s DNS is verified.
- Verify custom domain: Ask the provider to check the domain’s DNS now.
- Set custom domain redirect: Send every visitor of this domain to another of the app’s domains.
- Unlink custom domain: Stop serving the domain and keep it attached to the app.
- Delete custom domain: Remove the domain from the app.
Email domains
- List email domains: List the app’s email domains and where each is in setup.
- Enable email sending for a domain: Send the app’s email from your own address.
- Update email sender details: Change the name or address mail is sent from.
- Replace the email domain: Move email sending to a different domain the app owns.
- Retry email domain setup: Retry setup for a domain that stalled.
- Disable email sending for a domain: Turn off email sending and keep the domain connected.
URL redirects
- List URL redirects: List the redirects on the app’s published site.
- Create URL redirect: Add a 301 redirect.
- Update URL redirect: Replace a redirect’s source, target, and match type.
- Delete URL redirect: Remove a redirect.