Connect a name

post/hosting/sites/{id}/domains

Connect a name. Control is proven by the name pointing at the site; the certificate is obtained before the first visitor.

Before you call

Credential: Authorization: Bearer $KEY
Scope: hosting:write
Mcp: rivier_hosting_domain_add
Graphql: Mutation.hostingDomainAdd
Sdk: hosting.domain.add
Cli: hosting domain add
Events: hosting.domain.added

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

hoststringrequired
At most 253 characters.
methodstring
One of: buy, delegation, connector, domain_connect, watch.
wildcardboolean
canonicalstring
One of: www, apex.

Responses

201application/json
Success
- registeredUntilstring or null
- idstring (uuid)required
- projectIdstringrequired
- hoststringrequired
- wildcardbooleanrequired
- methodstringrequired
  One of: buy, delegation, connector, domain_connect, watch.
- statestringrequired
  One of: pending_dns, verifying, issuing, live, degraded, suspended.
- reasonstringrequired
- nextobject or nullrequired
- certificatestringrequired
  One of: pending, issued, failed.
- certExpiresAtstring or nullrequired
- targetstringrequired
- canonicalstringrequired
  One of: www, apex.
- verifiedAtstring or nullrequired
- liveAtstring or nullrequired
- checkedAtstring or nullrequired
- createdAtstringrequired
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/hosting/sites/{id}/domains' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "host": "string"
}'

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

This page as Markdown