Change a domain's root redirect: your workspace's owner

PATCH

/v1/buyer/domains/{id}

curl --request PATCH \
  --url https://example.com/v1/buyer/domains/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "host": "example", "root_redirect_url": "example" }'

Who: a workspace’s owner. Not for API keys.

Authorizations

• bearer

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

host

string

root_redirect_url

string | null

Example ^generated

{
  "host": "example",
  "root_redirect_url": "example"
}

Responses

200

OK

Media typeapplication/json

object

certificate

required

Any of:

object

object

issuer

required

string

not_after

required

string format: date-time

not_before

required

string format: date-time

renew_at

required

string format: date-time

serial_number

required

string

null

null

certificate_error

required

string

check_error

required

string

cname_target

required

string

created_at

required

string format: date-time

host

required

string

id

required

integer format: int64

last_checked_at

required

string | null format: date-time

next_check_at

required

string | null format: date-time

root_redirect_url

required

string

sequence

required

integer format: int64

status

required

string | null

Allowed values: pending verified active failed

txt_name

required

string

txt_value

required

string

updated_at

required

string format: date-time

verified_at

required

string | null format: date-time

workspace_id

required

integer format: int64

Example

{
  "status": "pending"
}

default

An error, as go-commons apperr maps it

Media typeapplication/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}