List domains

GET

/api/v1/domains

const url = 'https://digize.com/api/v1/domains';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/domains \
  --header 'x-api-key: <x-api-key>'

Every hostname the workspace has: its own domains (full setup or custom hostname) with their status, records and worker, and each worker’s platform address.

Needs the sites:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

Array<object>

object

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
null

string

Allowed values: full hostname

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
null

string format: date-time

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).

application/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.

application/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.

application/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).

application/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.

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