Praecise Platform
Menu

Rivier/ Reference/ hosting

Hosting domain update

patch/hosting/sites/{id}/domains/{dom}

Change which form of a name is the address people see (www or apex), or whether a delegated name serves its subdomains.

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:write
Graphql
Mutation.hostingDomainUpdate
Sdk
hosting.domain.update
Cli
hosting domain update
Events
hosting.domain.updated

Parameters

  • idstring (uuid)required
    In the path
  • domstring (uuid)required
    In the path

Request bodyapplication/json, required

  • canonicalstring
    One of: www, apex.
  • wildcardboolean

Responses

  • 200application/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

This page as Markdown