Choose apex, subdomain or delegate hosting

Before you call

Credential

Authorization: Bearer $KEY

Scope

domains:write

Sdk

domains.domain.setMode

Cli

domains domain set mode

Parameters

• dstringrequired
  In the path

Request bodyapplication/json, required

• modestringrequired
  One of: apex, subdomain, delegate.
• subLabelstring
  Pattern: ^[a-z0-9][a-z0-9-]{0,30}$.

Responses

• 200application/json
  Success
  • domainobjectrequired
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring