Check custom-domain capability

GET

/capabilities/custom-domains

curl --request GET \
  --url https://example.com/capabilities/custom-domains \
  --header 'Authorization: Bearer <token>'

Authorizations

• BearerAuth

Responses

200

Successful Response

Media typeapplication/json

CustomDomainCapabilityResponse

object

automatic

required

AutomaticDomainTransitionCapability

object

detail

required

Any of:

string

string

null

null

ready

required

Ready

boolean

cloudflare

required

CloudflareCapability

object

detail

required

Any of:

string

string

null

null

supported

required

Supported

boolean

control_ready

required

Control Ready

boolean

detail

required

Any of:

string

string

null

null

enabled

required

Enabled

boolean

routing_enabled

required

Routing Enabled

boolean

routing_targets

required

Routing Targets

Array<object>

CustomDomainRoutingTarget

object

type

required

Type

string

Allowed values: A AAAA

value

required

Value

string

status

required

Status

string

Allowed values: disabled unready ready

Example

{
  "routing_targets": [
    {
      "type": "A"
    }
  ],
  "status": "disabled"
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

403

Forbidden

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}