Skip to the page

Praecise Platform

Rivier/ Reference/ domains

Add a domain

post/workspace/domains

Add a domain: detect where its DNS is hosted, build the records and check for conflicts.

Before you call

Credential: Authorization: Bearer $KEY
Scope: domains:write
Mcp: rivier_domain_set
Sdk: domains.domain.add
Cli: domains domain add
Events: domains.domain.added

Request bodyapplication/json, required

domainstringrequired
At most 253 characters.
modestring
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

Example request

curl -X POST 'https://api.rivier.ai/workspace/domains' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "domain": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown