Connect a domain to a Worker

PUT

/api/v1/domains/{hostname}/worker

curl --request PUT \
  --url https://digize.com/api/v1/domains/example/worker \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "site": "example" }'

• Digize

Connects a domain to a worker by id or name, or disconnects it with null. The worker answers on it once the domain is active; on full setup, the domain’s own A, AAAA and CNAME records at its root are replaced.

Needs the sites:write permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

hostname

required

string

>= 3 characters <= 253 characters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

site

required

Any of:

string

string

>= 1 characters <= 64 characters

null

null

Example ^generated

{
  "site": "example"
}

Responses

200

Done

Media typeapplication/json

object

id

required

string

hostname

required

string

worker

required

string | null

siteId

required

string | null

kind

required

string

Allowed values: custom platform

purpose

required

string

Allowed values: site app tap

setup

required

Any of:

string

string

Allowed values: full hostname

null

null

status

required

string

Allowed values: active pending_dns verifying failed

certificate

required

string

Allowed values: active issuing waiting failed

primary

required

boolean

redirectsTo

required

string | null

records

required

Array<object>

object

type

required

string

Allowed values: CNAME TXT MX

name

required

string

value

required

string

priority

number

status

required

string

Allowed values: found missing mismatch

purpose

required

string

optional

boolean

nameservers

required

Array<string>

error

required

string | null

emailRouting

required

boolean

addedAt

required

string format: date-time

verifiedAt

required

Any of:

string

string format: date-time

null

null

checkedAt

required

string format: date-time

Example

{
  "kind": "custom",
  "purpose": "site",
  "setup": "full",
  "status": "active",
  "certificate": "active",
  "records": [
    {
      "type": "CNAME",
      "status": "found"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}