Skip to main content
POST

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
name
string
required

The domain, for example www.example.com, or *.example.com for a wildcard domain.

type
enum<string>
default:PROJECT

PROJECT for an app's domain, BUCKET for an object storage bucket's domain.

Available options:
PROJECT,
BUCKET
project
string

The app's name. Required when type is PROJECT.

bucket
string

The bucket's name. Required when type is BUCKET.

isWildcard
boolean
default:false

Set automatically when name starts with *.. Only for apps.

Response

The domain was added.

domain
object