Skip to main content
POST
Add a domain

Authorizations

x-brimble-key
string
header
required

API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.

Path Parameters

projectId
string
required

Required in some cases.

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

Body

application/json
name
string
required
Required string length: 3 - 63
teamId
string

Team to act in. Omit for your personal workspace.

Pattern: ^[a-fA-F0-9]{24}$
redirect
object | null

Response

Domain created successfully

message
string
required
Example:

"Domain created successfully"

data
object
required
Last modified on October 10, 2026