Domains

Add a custom domain

post/domains

Request

  • Base URL: https://api.warplink.app/v1
  • URL: https://api.warplink.app/v1/domains
  • Auth: HTTP bearer

Request body

domainstring required

Must be a subdomain such as links.yourapp.com. Root domains, IP addresses and reserved domains (aplnk.to, warplink.app) are not allowed.

Example request

{
  "domain": "links.myapp.com"
}

Response

Domain created

idstring uuid
org_idstring uuid
domainstring
verifiedboolean
ssl_statusstring
verification_tokenstring
verified_atstring date-time nullable
claimed_atstring date-time nullable

Set when this organization proved DNS control and won the exclusive claim on this domain. Null for a pending, unproven claim.

serving_state'active' | 'grace' | 'inactive'

Computed from the plan and any trial grace window.

grace_untilstring date-time nullable

Present only while serving_state is grace.

is_trialboolean

True for a free-tier trial domain.

trial_ends_atstring date-time nullable

The trial's hard end date. Null when the domain is not a trial.

trial_data_reset_atstring date-time nullable

The next monthly analytics reset for a trial domain. Null when the domain is not a trial.

created_atstring date-time
updated_atstring date-time

Example response

{
  "domain": "links.myapp.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.