Skip to main content
POST
Add a domain to the workspace

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.

Body

application/json
name
string
required

Hostname to add, for example app.example.com. Subdomains of brimble.app are not allowed.

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

Redirect this domain to another URL instead of serving the project. Send null to remove the redirect.

Response

Domain created successfully

message
string
required

Human-readable result of the request.

Example:

"Domain created successfully"

data
object
required

The result of the request.

Last modified on October 11, 2026