Skip to main content
POST
devices.subdomain.create

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
hostname
string
required

Tracking subdomain in a domain you control, e.g. metrics.example.com.

Response

The result

subdomain
object
required

Registered hostname; DNS setup is separate and pending does not mean active.

ref
string

Reference to what this call created. Pass it as ref to devices.subdomain.get, devices.subdomain.verify or devices.subdomain.delete.