Skip to main content
POST
domains.verify

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
project
string
required

The project: its id or name, as returned by deploy.projects.list.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$
domain
string
required

The project domain to check, as returned by domains.list or domains.add.

Response

The result

name
string
required

The domain name.

verified
boolean
required

False until you add the DNS records shown by domains.add and run domains.verify.

redirect
string

Domain this one redirects to, if any.

gitBranch
string

Git branch this domain serves, if not production.