githubEdit

globe-wwwCustom Domain

Verify custom domain DNS

get

Checks the DNS status of a custom domain in real time.

Authorizations
api-tokenstringRequired
Path parameters
domainNamestringRequired

Custom domain to verify

Responses
chevron-right
200

DNS status returned successfully

application/json
statusstringOptional
get
/customdomain/{domainName}/verify

Remove custom domain

delete

Removes a custom domain from the user and unlinks it from the app.

Authorizations
api-tokenstringRequired
Path parameters
domainNamestringRequired

Custom domain to remove

Responses
chevron-right
200

Custom domain removed successfully

application/json
statusstringOptional
messagestringOptional
domainstringOptional
delete
/customdomain/{domainName}/remove

Edit custom domain link

put

Moves a custom domain to another app.

Authorizations
api-tokenstringRequired
Path parameters
domainNamestringRequired

Custom domain to move

Body
newAppIDstringRequired

New app ID

Responses
chevron-right
200

Custom domain edited successfully

application/json
statusstringOptional
messagestringOptional
migratedbooleanOptional
domainstringOptional
put
/customdomain/{domainName}/edit

List custom domains

get

Returns all custom domains of the authenticated user.

Authorizations
api-tokenstringRequired
Responses
chevron-right
200

List of custom domains returned successfully

application/json
anyOptional
get
/customdomain/all

Create custom domain

post

Creates a new custom domain and links it to an app.

Authorizations
api-tokenstringRequired
Body
domainNamestringRequired

Desired custom domain name

appIDstringRequired

App ID to link

Responses
chevron-right
200

Custom domain created successfully

application/json
anyOptional
post
/customdomain/create

Last updated