Skip to content
Artbucket

Add a domain

POST
/api/v1/domains
curl --request POST \
  --url http://localhost:3000/api/v1/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "host": "example" }'

An address of the organization’s own: the app’s, or a portal’s once the portal picks it. Add the TXT record in record, point it at the server (cname), then POST /api/v1/domains/{host}/verify. The first verified one becomes the default, where links in email point. Counts against the domains limit.

Scope: admin.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
host
required

A host name of the organization’s, e.g. assets.example.com

string
>= 1 characters <= 253 characters
Examplegenerated
{
  "host": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

The domain, not verified yet

Media typeapplication/json
object
data
required
object
host
required
string
verified
required
boolean
record
required

What proves it: add this record at your DNS host

object
type
required
string
Allowed value: TXT
name
required
string
value
required
string
cname
required
Any of:
object
type
required
string
Allowed value: CNAME
name
required
string
value
required
string
app
required

Used for the app: the whole app answers here

boolean
primary
required

The default of those used for the app: links in email point here

boolean
portal
required

The portal it serves, by slug; null for the whole app

string | null
url
required
string format: uri
Example
{
  "data": {
    "record": {
      "type": "TXT"
    },
    "cname": {
      "type": "CNAME"
    }
  }
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}