Rivier/ Reference/ hosting

Hosting domain options

get/hosting/sites/{id}/domains/options

The ways to connect a name, best first (buy it, let Rivier run the DNS, connect a DNS account, one click at the registrar, add the records yourself), each with exact steps and records.

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:read
Mcp
rivier_hosting_domain_options
Graphql
Query.hostingDomainOptions
Sdk
hosting.domain.options
Cli
hosting domain options

Parameters

  • idstring (uuid)required
    In the path
  • hoststringrequired
    In the query

Responses

  • 200application/json
    Success
    • optionslist of objectrequired
      • methodstringrequired
        One of: buy, delegation, connector, domain_connect, watch.
      • labelstringrequired
      • availablebooleanrequired
      • whystringrequired
      • stepslist of stringrequired
      • recordslist of objectrequired
        • typestringrequired
        • hoststringrequired
        • answerstringrequired
  • 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

This page as Markdown