Create a custom domain claim

POST

/sites/{site_name}/domains

curl --request POST \
  --url https://example.com/sites/example/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "hostname": "example" }'

Authorizations

• BearerAuth

Parameters

Path Parameters

site_name

required

Site Name

string

Request Body^required

Media typeapplication/json

CreateDomainClaimRequest

object

hostname

required

Hostname

string

Example^generated

{
  "hostname": "example"
}

Responses

201

Successful Response

Media typeapplication/json

DomainClaimResponse

object

activated_at

required

Any of:

string

string

null

null

activation_checked_at

required

Any of:

string

string

null

null

activation_error

required

Any of:

string

string

null

null

challenge_path

required

Any of:

string

string

null

null

challenge_seen_at

required

Any of:

string

string

null

null

cloudflare_diagnostics

required

Any of:

CloudflareDiagnosticResponse

CloudflareDiagnosticResponse

object

checked_at

required

Checked At

string

consecutive_failures

required

Consecutive Failures

integer

dns

required

CloudflareDiagnosticComponent

object

error

required

Any of:

string

string

null

null

status

required

Status

string

edge_http

required

CloudflareEdgeHttpDiagnostic

object

address

required

Any of:

string

string

null

null

cf_cache_status

required

Any of:

string

string

null

null

cf_ray

required

Any of:

string

string

null

null

error

required

Any of:

string

string

null

null

redirect_location

required

Any of:

string

string

null

null

status

required

Status

string

status_code

required

Any of:

integer

integer

null

null

edge_tls

required

CloudflareDiagnosticComponent

object

error

required

Any of:

string

string

null

null

status

required

Status

string

generation

required

Generation

integer

http_forwarding

required

CloudflareHttpForwardDiagnostic

object

error

required

Any of:

string

string

null

null

status

required

Status

string

status_code

required

Any of:

integer

integer

null

null

origin

required

CloudflareDiagnosticComponent

object

error

required

Any of:

string

string

null

null

status

required

Status

string

ownership

required

CloudflareDiagnosticComponent

object

error

required

Any of:

string

string

null

null

status

required

Status

string

ranges_version

required

Any of:

string

string

null

null

null

null

connection_status

required

Connection Status

string

Allowed values: waiting_for_dns securing connected updating action_needed

created_at

required

Created At

string

effective_mode

required

Any of:

string

string

Allowed values: direct cloudflare

null

null

expires_at

required

Expires At

string

hostname

required

Hostname

string

id

required

Id

integer

last_checked_at

required

Any of:

string

string

null

null

last_error

required

Any of:

string

string

null

null

mode

required

Mode

string

Allowed values: direct cloudflare

observed_mode

required

Any of:

string

string

Allowed values: direct cloudflare mixed unsupported unavailable

null

null

removal_requested_at

required

Any of:

string

string

null

null

route_error

required

Any of:

string

string

null

null

route_generation

required

Route Generation

integer

route_status

required

Route Status

string

Allowed values: not_routed publishing routed removing removed

site_name

required

Any of:

string

string

null

null

status

required

Status

string

Allowed values: pending verified expired cancelled

target_mode

required

Any of:

string

string

Allowed values: direct cloudflare

null

null

transition_deadline_at

required

Any of:

string

string

null

null

transition_error

required

Any of:

string

string

null

null

transition_started_at

required

Any of:

string

string

null

null

verification

required

DomainVerificationRecord

object

name

required

Name

string

type

required

Type

string

Allowed value: TXT

value

required

Value

string

verified_at

required

Any of:

string

string

null

null

withdrawn_at

required

Any of:

string

string

null

null

Example

{
  "connection_status": "waiting_for_dns",
  "effective_mode": "direct",
  "mode": "direct",
  "observed_mode": "direct",
  "route_status": "not_routed",
  "status": "pending",
  "target_mode": "direct",
  "verification": {
    "type": "TXT"
  }
}

400

Bad Request

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

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"
}

409

Conflict

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"
    }
  ]
}

429

Too Many Requests

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}

503

Service Unavailable

Media typeapplication/json

ErrorResponse

object

detail

required

Detail

string

Example^generated

{
  "detail": "example"
}