Models | regfish DNS & TLS API

Models & types

46

Related endpoints

212

Fields

555

A

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

A

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

—

Response example

A

{
  "type": "A",
  "name": "www",
  "data": "12.12.12.12"
}

AAAA

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

AAAA

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

—

Response example

AAAA

{
  "type": "AAAA",
  "name": "www",
  "data": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}

ALIAS

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

ALIAS

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

Response example

ALIAS

{
  "type": "ALIAS",
  "name": "www",
  "data": "www.example.com."
}

baseResult

No description was provided in the specification.

Type

object

Fields

2

Related endpoints

27

Fields

Name

Type

Format

Required

Description

success

boolean

—

Required

Success indicator

code

integer

—

Optional

Response/Error Code

Response example

baseResult

{
  "success": true
}

CAA

No description was provided in the specification.

Type

object

Fields

7

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

CAA

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

flags

0, 1

integer

—

Required

indicates criticality, with a value of 1 meaning that the record must be understood and respected by the CA before issuing a certificate, while 0 means it’s optional.

tag

issue, issuewild, iodef

string

—

Required

Specifies the type of authorization or reporting policy, such as allowing specific CAs to issue certificates (issue), wildcard certificates (issuewild), or report issues (iodef).

data

string

—

Required

Use the CA’s domain to authorize a specific CA or to include a URI when used with iodef.

Response example

CAA

{
  "type": "CAA",
  "name": "www",
  "flags": 1,
  "tag": "issue",
  "data": "letsencrypt.org"
}

CNAME

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

CNAME

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

Response example

CNAME

{
  "type": "CNAME",
  "name": "www",
  "data": "www.example.com."
}

dnssecCapabilities

No description was provided in the specification.

Type

object

Fields

9

Related endpoints

5

Fields

Name

Type

Format

Required

Description

supported

boolean

—

Required

—

provider

string

—

Required

—

mode_regfish_available

boolean

—

Required

—

mode_external_available

boolean

—

Required

—

accepted_record_kinds

array<string>

—

Required

—

min_records

integer

—

Required

—

max_records

integer

—

Optional

—

accepted_algorithms

array<integer>

—

Required

—

reason_unavailable

string

—

Optional

—

Response example

dnssecCapabilities

{
  "supported": true,
  "provider": "example",
  "mode_regfish_available": true,
  "mode_external_available": true,
  "accepted_record_kinds": [
    "ds"
  ],
  "min_records": 1,
  "accepted_algorithms": [
    1
  ]
}

dnssecJobResponse

No description was provided in the specification.

Type

object

Fields

13

Related endpoints

6

Fields

Name

Type

Format

Required

Description

id

integer

—

Required

—

action

string

—

Required

—

mode

string

—

Required

—

status

string

—

Required

Job lifecycle status such as `PENDING`, `RUNNING`, `WAITING`, `OK`, `ERROR`, or `CANCELLED`.

source

string

—

Required

—

registry_name

string

—

Optional

—

registry_reference

string

—

Optional

—

error_code

string

—

Optional

—

error_text

string

—

Optional

—

ts_created

integer

—

Required

—

ts_updated

integer

—

Required

—

ts_started

integer

—

Optional

—

ts_finished

integer

—

Optional

—

Response example

dnssecJobResponse

{
  "id": 1,
  "action": "example",
  "mode": "example",
  "status": "example",
  "source": "example",
  "ts_created": 1,
  "ts_updated": 1
}

dnssecRecord

No description was provided in the specification.

Type

object

Fields

9

Related endpoints

5

Fields

Name

Type

Format

Required

Description

kind

ds, dnskey

string

—

Required

—

key_tag

integer

—

Optional

—

flags

integer

—

Optional

—

protocol

integer

—

Optional

—

algorithm

integer

—

Required

—

digest_type

integer

—

Optional

—

digest

string

—

Optional

—

public_key

string

—

Optional

—

comment

string

—

Optional

—

Response example

dnssecRecord

{
  "kind": "ds",
  "algorithm": 1
}

dnssecRequest

No description was provided in the specification.

Type

object

Fields

13

Related endpoints

1

Fields

Name

Type

Format

Required

Description

mode

none, regfish, external

string

—

Required

Requested DNSSEC operating mode. - `none`: no registry DNSSEC should remain active - `regfish`: regfish signs the zone and manages registry trust anchors - `external`: the caller supplies DNSSEC records for external authoritative nameservers

state

disabled, enabled

string

—

Required

Desired high-level DNSSEC state.

verify_after_apply

boolean

—

Optional

When true, the API immediately refreshes registry state and checks DNS delegation after the update.

records

array<object>

—

Optional

Required for `mode=external,state=enabled`. Ignored for regfish-managed activation and for disable operations.

records[].kind

ds, dnskey

string

—

Required

—

records[].key_tag

integer

—

Optional

—

records[].flags

integer

—

Optional

—

records[].protocol

integer

—

Optional

—

records[].algorithm

integer

—

Required

—

records[].digest_type

integer

—

Optional

—

records[].digest

string

—

Optional

—

records[].public_key

string

—

Optional

—

records[].comment

string

—

Optional

—

Response example

dnssecRequest

{
  "mode": "none",
  "state": "disabled"
}

dnssecResponse

No description was provided in the specification.

Type

object

Fields

75

Related endpoints

5

Fields

Name

Type

Format

Required

Description

configured

boolean

—

Required

Whether DNSSEC has been configured for the domain.

dnssec_state

active, pending, inactive

string

—

Required

High-level DNSSEC status.

mode

none, regfish, external

string

—

Required

Requested DNSSEC operating mode. - `none`: no registry DNSSEC should remain active - `regfish`: regfish signs the zone and manages registry trust anchors - `external`: the caller supplies DNSSEC records for external authoritative nameservers

desired_state

disabled, pending_enable, enabled, pending_disable, error, drift, unknown

string

—

Required

Fine-grained registry DNSSEC state.

live_state

disabled, pending_enable, enabled, pending_disable, error, drift, unknown

string

—

Required

Fine-grained registry DNSSEC state.

capabilities

object

—

Required

—

capabilities.supported

boolean

—

Required

—

capabilities.provider

string

—

Required

—

capabilities.mode_regfish_available

boolean

—

Required

—

capabilities.mode_external_available

boolean

—

Required

—

capabilities.accepted_record_kinds

array<string>

—

Required

—

capabilities.min_records

integer

—

Required

—

capabilities.max_records

integer

—

Optional

—

capabilities.accepted_algorithms

array<integer>

—

Required

—

capabilities.reason_unavailable

string

—

Optional

—

desired_records

array<object>

—

Required

—

desired_records[].kind

ds, dnskey

string

—

Required

—

desired_records[].key_tag

integer

—

Optional

—

desired_records[].flags

integer

—

Optional

—

desired_records[].protocol

integer

—

Optional

—

desired_records[].algorithm

integer

—

Required

—

desired_records[].digest_type

integer

—

Optional

—

desired_records[].digest

string

—

Optional

—

desired_records[].public_key

string

—

Optional

—

desired_records[].comment

string

—

Optional

—

live_records

array<object>

—

Required

—

live_records[].kind

ds, dnskey

string

—

Required

—

live_records[].key_tag

integer

—

Optional

—

live_records[].flags

integer

—

Optional

—

live_records[].protocol

integer

—

Optional

—

live_records[].algorithm

integer

—

Required

—

live_records[].digest_type

integer

—

Optional

—

live_records[].digest

string

—

Optional

—

live_records[].public_key

string

—

Optional

—

live_records[].comment

string

—

Optional

—

last_error_code

string

—

Optional

—

last_error

string

—

Optional

—

last_registry_name

string

—

Optional

—

last_registry_reference

string

—

Optional

—

last_registry_status

string

—

Optional

—

last_verified_at

integer

—

Optional

—

last_applied_at

integer

—

Optional

—

pending_job

object

—

Optional

—

pending_job.id

integer

—

Required

—

pending_job.action

string

—

Required

—

pending_job.mode

string

—

Required

—

pending_job.status

string

—

Required

Job lifecycle status such as `PENDING`, `RUNNING`, `WAITING`, `OK`, `ERROR`, or `CANCELLED`.

pending_job.source

string

—

Required

—

pending_job.registry_name

string

—

Optional

—

pending_job.registry_reference

string

—

Optional

—

pending_job.error_code

string

—

Optional

—

pending_job.error_text

string

—

Optional

—

pending_job.ts_created

integer

—

Required

—

pending_job.ts_updated

integer

—

Required

—

pending_job.ts_started

integer

—

Optional

—

pending_job.ts_finished

integer

—

Optional

—

using_regfish_nameservers

boolean

—

Required

—

legacy_mode

boolean

—

Required

—

zone_signed

boolean

—

Required

—

zone_pending_disable

boolean

—

Required

—

zone_propagated_at

integer

—

Optional

—

jobs

array<object>

—

Optional

Recent DNSSEC jobs for the domain. This is history, not just the current pending item.

jobs[].id

integer

—

Required

—

jobs[].action

string

—

Required

—

jobs[].mode

string

—

Required

—

jobs[].status

string

—

Required

Job lifecycle status such as `PENDING`, `RUNNING`, `WAITING`, `OK`, `ERROR`, or `CANCELLED`.

jobs[].source

string

—

Required

—

jobs[].registry_name

string

—

Optional

—

jobs[].registry_reference

string

—

Optional

—

jobs[].error_code

string

—

Optional

—

jobs[].error_text

string

—

Optional

—

jobs[].ts_created

integer

—

Required

—

jobs[].ts_updated

integer

—

Required

—

jobs[].ts_started

integer

—

Optional

—

jobs[].ts_finished

integer

—

Optional

—

Response example

dnssecResponse

{
  "configured": true,
  "dnssec_state": "active",
  "mode": "none",
  "desired_state": "disabled",
  "live_state": "disabled",
  "capabilities": {
    "supported": true,
    "provider": "example",
    "mode_regfish_available": true,
    "mode_external_available": true,
    "accepted_record_kinds": [
      "ds"
    ],
    "min_records": 1,
    "accepted_algorithms": [
      1
    ]
  },
  "desired_records": [
    {
      "kind": "ds",
      "algorithm": 1
    }
  ],
  "live_records": [
    {
      "kind": "ds",
      "algorithm": 1
    }
  ],
  "using_regfish_nameservers": true,
  "legacy_mode": true,
  "zone_signed": true,
  "zone_pending_disable": true
}

dnsZoneCounts

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

1

Fields

Name

Type

Format

Required

Description

records_total

integer

—

Required

—

records_active

integer

—

Required

—

records_auto

integer

—

Required

—

records_manual

integer

—

Required

—

by_type

object

—

Required

—

Response example

dnsZoneCounts

{
  "records_total": 1,
  "records_active": 1,
  "records_auto": 1,
  "records_manual": 1,
  "by_type": {}
}

dnsZoneDelegationNameserver

No description was provided in the specification.

Type

object

Fields

2

Related endpoints

2

Fields

Name

Type

Format

Required

Description

host

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

ipv4

string

—

Optional

—

Response example

dnsZoneDelegationNameserver

{
  "host": "www.example.com."
}

dnsZoneDetailResponse

No description was provided in the specification.

Type

object

Fields

115

Related endpoints

1

Fields

Name

Type

Format

Required

Description

domain

string

—

Required

Fully Qualified Domain Name.

origin

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

active

boolean

—

Required

—

signed

boolean

—

Required

Whether the regfish-hosted zone itself is signed.

using_regfish_nameservers

boolean

—

Required

Whether the domain currently uses regfish authoritative nameservers.

delegation_nameservers

array<object>

—

Required

—

delegation_nameservers[].host

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

delegation_nameservers[].ipv4

string

—

Optional

—

soa

object

—

Required

—

soa.primary_nameserver

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

soa.mailbox

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

soa.serial

integer

—

Required

—

soa.refresh

integer

—

Required

—

soa.retry

integer

—

Required

—

soa.expire

integer

—

Required

—

soa.minimum

integer

—

Required

—

soa.ttl

integer

—

Required

—

record_count

integer

—

Required

—

dnssec_state

active, pending, inactive

string

—

Required

High-level DNSSEC status.

dnssec

object

—

Required

—

dnssec.configured

boolean

—

Required

Whether DNSSEC has been configured for the domain.

dnssec.dnssec_state

active, pending, inactive

string

—

Required

High-level DNSSEC status.

dnssec.mode

none, regfish, external

string

—

Required

Requested DNSSEC operating mode. - `none`: no registry DNSSEC should remain active - `regfish`: regfish signs the zone and manages registry trust anchors - `external`: the caller supplies DNSSEC records for external authoritative nameservers

dnssec.desired_state

disabled, pending_enable, enabled, pending_disable, error, drift, unknown

string

—

Required

Fine-grained registry DNSSEC state.

dnssec.live_state

disabled, pending_enable, enabled, pending_disable, error, drift, unknown

string

—

Required

Fine-grained registry DNSSEC state.

dnssec.capabilities

object

—

Required

—

dnssec.capabilities.supported

boolean

—

Required

—

dnssec.capabilities.provider

string

—

Required

—

dnssec.capabilities.mode_regfish_available

boolean

—

Required

—

dnssec.capabilities.mode_external_available

boolean

—

Required

—

dnssec.capabilities.accepted_record_kinds

array<string>

—

Required

—

dnssec.capabilities.min_records

integer

—

Required

—

dnssec.capabilities.max_records

integer

—

Optional

—

dnssec.capabilities.accepted_algorithms

array<integer>

—

Required

—

dnssec.capabilities.reason_unavailable

string

—

Optional

—

dnssec.desired_records

array<object>

—

Required

—

dnssec.desired_records[].kind

ds, dnskey

string

—

Required

—

dnssec.desired_records[].key_tag

integer

—

Optional

—

dnssec.desired_records[].flags

integer

—

Optional

—

dnssec.desired_records[].protocol

integer

—

Optional

—

dnssec.desired_records[].algorithm

integer

—

Required

—

dnssec.desired_records[].digest_type

integer

—

Optional

—

dnssec.desired_records[].digest

string

—

Optional

—

dnssec.desired_records[].public_key

string

—

Optional

—

dnssec.desired_records[].comment

string

—

Optional

—

dnssec.live_records

array<object>

—

Required

—

dnssec.live_records[].kind

ds, dnskey

string

—

Required

—

dnssec.live_records[].key_tag

integer

—

Optional

—

dnssec.live_records[].flags

integer

—

Optional

—

dnssec.live_records[].protocol

integer

—

Optional

—

dnssec.live_records[].algorithm

integer

—

Required

—

dnssec.live_records[].digest_type

integer

—

Optional

—

dnssec.live_records[].digest

string

—

Optional

—

dnssec.live_records[].public_key

string

—

Optional

—

dnssec.live_records[].comment

string

—

Optional

—

dnssec.last_error_code

string

—

Optional

—

dnssec.last_error

string

—

Optional

—

dnssec.last_registry_name

string

—

Optional

—

dnssec.last_registry_reference

string

—

Optional

—

dnssec.last_registry_status

string

—

Optional

—

dnssec.last_verified_at

integer

—

Optional

—

dnssec.last_applied_at

integer

—

Optional

—

dnssec.pending_job

object

—

Optional

—

dnssec.pending_job.id

integer

—

Required

—

dnssec.pending_job.action

string

—

Required

—

dnssec.pending_job.mode

string

—

Required

—

dnssec.pending_job.status

string

—

Required

Job lifecycle status such as `PENDING`, `RUNNING`, `WAITING`, `OK`, `ERROR`, or `CANCELLED`.

dnssec.pending_job.source

string

—

Required

—

dnssec.pending_job.registry_name

string

—

Optional

—

dnssec.pending_job.registry_reference

string

—

Optional

—

dnssec.pending_job.error_code

string

—

Optional

—

dnssec.pending_job.error_text

string

—

Optional

—

dnssec.pending_job.ts_created

integer

—

Required

—

dnssec.pending_job.ts_updated

integer

—

Required

—

dnssec.pending_job.ts_started

integer

—

Optional

—

dnssec.pending_job.ts_finished

integer

—

Optional

—

dnssec.using_regfish_nameservers

boolean

—

Required

—

dnssec.legacy_mode

boolean

—

Required

—

dnssec.zone_signed

boolean

—

Required

—

dnssec.zone_pending_disable

boolean

—

Required

—

dnssec.zone_propagated_at

integer

—

Optional

—

dnssec.jobs

array<object>

—

Optional

Recent DNSSEC jobs for the domain. This is history, not just the current pending item.

dnssec.jobs[].id

integer

—

Required

—

dnssec.jobs[].action

string

—

Required

—

dnssec.jobs[].mode

string

—

Required

—

dnssec.jobs[].status

string

—

Required

Job lifecycle status such as `PENDING`, `RUNNING`, `WAITING`, `OK`, `ERROR`, or `CANCELLED`.

dnssec.jobs[].source

string

—

Required

—

dnssec.jobs[].registry_name

string

—

Optional

—

dnssec.jobs[].registry_reference

string

—

Optional

—

dnssec.jobs[].error_code

string

—

Optional

—

dnssec.jobs[].error_text

string

—

Optional

—

dnssec.jobs[].ts_created

integer

—

Required

—

dnssec.jobs[].ts_updated

integer

—

Required

—

dnssec.jobs[].ts_started

integer

—

Optional

—

dnssec.jobs[].ts_finished

integer

—

Optional

—

counts

object

—

Required

—

counts.records_total

integer

—

Required

—

counts.records_active

integer

—

Required

—

counts.records_auto

integer

—

Required

—

counts.records_manual

integer

—

Required

—

counts.by_type

object

—

Required

—

records

array<object>

—

Required

—

records[].id

number

—

Required

Resource Record ID

records[].name

string

—

Required

Record owner name. Apex records are returned as `@`; other records use their fully-qualified name.

records[].type

string

—

Required

—

records[].data

string

—

Optional

—

records[].priority

integer

—

Optional

—

records[].flags

integer

—

Optional

—

records[].tag

string

—

Optional

—

records[].ttl

integer

—

Required

—

records[].auto

boolean

—

Required

—

records[].active

boolean

—

Required

—

records[].annotation

string

—

Optional

—

records[].ts_created

integer

—

Required

—

records[].ts_updated

integer

—

Required

—

Response example

dnsZoneDetailResponse

{
  "domain": "www.example.com",
  "origin": "www.example.com.",
  "active": true,
  "signed": true,
  "using_regfish_nameservers": true,
  "delegation_nameservers": [
    {
      "host": "www.example.com."
    }
  ],
  "soa": {
    "primary_nameserver": "www.example.com.",
    "mailbox": "www.example.com.",
    "serial": 1,
    "refresh": 1,
    "retry": 1,
    "expire": 1,
    "minimum": 1,
    "ttl": 1
  },
  "record_count": 1,
  "dnssec_state": "active",
  "dnssec": {
    "configured": true,
    "dnssec_state": "active",
    "mode": "none",
    "desired_state": "disabled",
    "live_state": "disabled",
    "capabilities": {
      "supported": true,
      "provider": "example",
      "mode_regfish_available": true,
      "mode_external_available": true,
      "accepted_record_kinds": [
        "ds"
      ],
      "min_records": 1,
      "accepted_algorithms": [
        1
      ]
    },
    "desired_records": [
      {
        "kind": "ds",
        "algorithm": 1
      }
    ],
    "live_records": [
      {
        "kind": "ds",
        "algorithm": 1
      }
    ],
    "using_regfish_nameservers": true,
    "legacy_mode": true,
    "zone_signed": true,
    "zone_pending_disable": true
  },
  "counts": {
    "records_total": 1,
    "records_active": 1,
    "records_auto": 1,
    "records_manual": 1,
    "by_type": {}
  },
  "records": [
    {
      "id": 1,
      "name": "example",
      "type": "example",
      "ttl": 1,
      "auto": true,
      "active": true,
      "ts_created": 1,
      "ts_updated": 1
    }
  ]
}

dnsZoneRecordResponse

Superset record representation returned by the detailed zone endpoint. Record-specific fields such as `priority`, `flags`, or `tag` are included when applicable.

Type

object

Fields

13

Related endpoints

1

Fields

Name

Type

Format

Required

Description

id

number

—

Required

Resource Record ID

name

string

—

Required

Record owner name. Apex records are returned as `@`; other records use their fully-qualified name.

type

string

—

Required

—

data

string

—

Optional

—

priority

integer

—

Optional

—

flags

integer

—

Optional

—

tag

string

—

Optional

—

ttl

integer

—

Required

—

auto

boolean

—

Required

—

active

boolean

—

Required

—

annotation

string

—

Optional

—

ts_created

integer

—

Required

—

ts_updated

integer

—

Required

—

Response example

dnsZoneRecordResponse

{
  "id": 1,
  "name": "example",
  "type": "example",
  "ttl": 1,
  "auto": true,
  "active": true,
  "ts_created": 1,
  "ts_updated": 1
}

dnsZoneSOA

No description was provided in the specification.

Type

object

Fields

8

Related endpoints

2

Fields

Name

Type

Format

Required

Description

primary_nameserver

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

mailbox

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

serial

integer

—

Required

—

refresh

integer

—

Required

—

retry

integer

—

Required

—

expire

integer

—

Required

—

minimum

integer

—

Required

—

ttl

integer

—

Required

—

Response example

dnsZoneSOA

{
  "primary_nameserver": "www.example.com.",
  "mailbox": "www.example.com.",
  "serial": 1,
  "refresh": 1,
  "retry": 1,
  "expire": 1,
  "minimum": 1,
  "ttl": 1
}

dnsZoneSummaryResponse

No description was provided in the specification.

Type

object

Fields

19

Related endpoints

2

Fields

Name

Type

Format

Required

Description

domain

string

—

Required

Fully Qualified Domain Name.

origin

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

active

boolean

—

Required

—

signed

boolean

—

Required

Whether the regfish-hosted zone itself is signed.

using_regfish_nameservers

boolean

—

Required

Whether the domain currently uses regfish authoritative nameservers.

delegation_nameservers

array<object>

—

Required

—

delegation_nameservers[].host

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

delegation_nameservers[].ipv4

string

—

Optional

—

soa

object

—

Required

—

soa.primary_nameserver

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

soa.mailbox

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

soa.serial

integer

—

Required

—

soa.refresh

integer

—

Required

—

soa.retry

integer

—

Required

—

soa.expire

integer

—

Required

—

soa.minimum

integer

—

Required

—

soa.ttl

integer

—

Required

—

record_count

integer

—

Required

—

dnssec_state

active, pending, inactive

string

—

Required

High-level DNSSEC status.

Response example

dnsZoneSummaryResponse

{
  "domain": "www.example.com",
  "origin": "www.example.com.",
  "active": true,
  "signed": true,
  "using_regfish_nameservers": true,
  "delegation_nameservers": [
    {
      "host": "www.example.com."
    }
  ],
  "soa": {
    "primary_nameserver": "www.example.com.",
    "mailbox": "www.example.com.",
    "serial": 1,
    "refresh": 1,
    "retry": 1,
    "expire": 1,
    "minimum": 1,
    "ttl": 1
  },
  "record_count": 1,
  "dnssec_state": "active"
}

domainListResponse

No description was provided in the specification.

Type

object

Fields

21

Related endpoints

1

Fields

Name

Type

Format

Required

Description

domains

array<object>

—

Required

Domain list for the current result page.

domains[].domain

string

—

Required

Fully Qualified Domain Name.

domains[].sld

string

—

Required

Second-level domain label.

domains[].tld

string

—

Required

Top-level domain.

domains[].favorite

boolean

—

Required

Whether the domain is marked as a favorite.

domains[].owner_contact_id

integer

—

Optional

Registrant contact identifier, if available.

domains[].owner

string

—

Required

Registrant name or organization label.

domains[].primary_nameserver

string

—

Required

Primary delegated nameserver.

domains[].dnssec_state

active, pending, inactive

string

—

Required

High-level DNSSEC status.

domains[].auto_renew

boolean

—

Required

Whether the domain is set to renew automatically.

domains[].cancelled

boolean

—

Required

Whether the domain has been cancelled.

domains[].registered_at

integer

—

Required

Unix timestamp when the domain was registered.

domains[].expires_at

integer

—

Required

Unix timestamp when the domain expires.

total_items

integer

—

Required

Total number of matching domains.

total_pages

integer

—

Required

Total number of available pages.

page

integer

—

Required

Current page number.

page_size

integer

—

Required

Number of items returned per page.

search

string

—

Required

Applied search term.

filters

array<string>

—

Required

Applied filters.

sort_by

domain, expires_at, cancelled, primary_nameserver, dnssec_state, owner, registered_at

string

—

Required

—

sort_order

asc, desc

string

—

Required

—

Response example

domainListResponse

{
  "domains": [
    {
      "domain": "www.example.com",
      "sld": "example",
      "tld": "example",
      "favorite": true,
      "owner": "example",
      "primary_nameserver": "example",
      "dnssec_state": "active",
      "auto_renew": true,
      "cancelled": true,
      "registered_at": 1,
      "expires_at": 1
    }
  ],
  "total_items": 1,
  "total_pages": 1,
  "page": 1,
  "page_size": 1,
  "search": "example",
  "filters": [
    "cancelled"
  ],
  "sort_by": "domain",
  "sort_order": "asc"
}

domainResponse

No description was provided in the specification.

Type

object

Fields

12

Related endpoints

1

Fields

Name

Type

Format

Required

Description

domain

string

—

Required

Fully Qualified Domain Name.

sld

string

—

Required

Second-level domain label.

tld

string

—

Required

Top-level domain.

favorite

boolean

—

Required

Whether the domain is marked as a favorite.

owner_contact_id

integer

—

Optional

Registrant contact identifier, if available.

owner

string

—

Required

Registrant name or organization label.

primary_nameserver

string

—

Required

Primary delegated nameserver.

dnssec_state

active, pending, inactive

string

—

Required

High-level DNSSEC status.

auto_renew

boolean

—

Required

Whether the domain is set to renew automatically.

cancelled

boolean

—

Required

Whether the domain has been cancelled.

registered_at

integer

—

Required

Unix timestamp when the domain was registered.

expires_at

integer

—

Required

Unix timestamp when the domain expires.

Response example

domainResponse

{
  "domain": "www.example.com",
  "sld": "example",
  "tld": "example",
  "favorite": true,
  "owner": "example",
  "primary_nameserver": "example",
  "dnssec_state": "active",
  "auto_renew": true,
  "cancelled": true,
  "registered_at": 1,
  "expires_at": 1
}

Error

No description was provided in the specification.

Type

object

Fields

3

Related endpoints

30

Fields

Name

Type

Format

Required

Description

success

boolean

—

Required

Indicator of success (always `false`)

message

string

—

Optional

A human readable message

error

string

—

Optional

A human readable error message

Response example

Error

{
  "success": false,
  "message": "Unauthorized",
  "error": "Invalid API key"
}

MX

No description was provided in the specification.

Type

object

Fields

6

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

MX

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

priority

integer

—

Required

—

Response example

MX

{
  "type": "MX",
  "name": "www",
  "data": "www.example.com.",
  "priority": 1
}

record

No description was provided in the specification.

Type

object

Fields

4

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

A, AAAA, CNAME, CAA, ALIAS, TXT, MX

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

Response example

record

{
  "type": "A",
  "name": "www"
}

recordRequest

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

1

Fields

Name

Type

Format

Required

Description

type

A

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

—

Response example

recordRequest

{
  "type": "A",
  "name": "www",
  "data": "12.12.12.12"
}

recordRequestFQDN

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

2

Fields

Name

Type

Format

Required

Description

type

A

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

—

Response example

recordRequestFQDN

{
  "type": "A",
  "name": "www.example.com.",
  "data": "12.12.12.12"
}

recordResponse

No description was provided in the specification.

Type

object

Fields

10

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

A

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

—

id

number

—

Required

Resource Record ID

auto

boolean

—

Required

Whether the DNS record is managed automatically by regfish.

active

boolean

—

Required

Whether the DNS record is currently active.

ts_created

integer

—

Required

Unix timestamp when the record was created.

ts_updated

integer

—

Required

Unix timestamp when the record was last updated.

Response example

recordResponse

{
  "type": "A",
  "name": "www.example.com.",
  "data": "12.12.12.12",
  "id": 1,
  "auto": true,
  "active": true,
  "ts_created": 1,
  "ts_updated": 1
}

recordResponseAdditionalReqFQDN

No description was provided in the specification.

Type

object

Fields

1

Related endpoints

5

Fields

Name

Type

Format

Required

Description

name

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

Response example

recordResponseAdditionalReqFQDN

{
  "name": "www.example.com."
}

recordResponseAdditionalReqRRID

No description was provided in the specification.

Type

object

Fields

1

Related endpoints

5

Fields

Name

Type

Format

Required

Description

id

number

—

Required

Resource Record ID

Response example

recordResponseAdditionalReqRRID

{
  "id": 1
}

recordResponseAdditionalState

No description was provided in the specification.

Type

object

Fields

4

Related endpoints

5

Fields

Name

Type

Format

Required

Description

auto

boolean

—

Required

Whether the DNS record is managed automatically by regfish.

active

boolean

—

Required

Whether the DNS record is currently active.

ts_created

integer

—

Required

Unix timestamp when the record was created.

ts_updated

integer

—

Required

Unix timestamp when the record was last updated.

Response example

recordResponseAdditionalState

{
  "auto": true,
  "active": true,
  "ts_created": 1,
  "ts_updated": 1
}

recordType

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

A

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

—

Response example

recordType

{
  "type": "A",
  "name": "www",
  "data": "12.12.12.12"
}

tlsCertificateCancelRequest

No description was provided in the specification.

Type

object

Fields

1

Related endpoints

1

Fields

Name

Type

Format

Required

Description

note

string

—

Optional

Optional provider note stored with the cancellation request. If omitted, regfish sends a default note because the CA requires one for pending-order cancellations.

Response example

tlsCertificateCancelRequest

{
  "note": "example"
}

tlsCertificateCompleteRequest

No description was provided in the specification.

Type

object

Fields

1

Related endpoints

1

Fields

Name

Type

Format

Required

Description

org_id

string

—

Required

Public TLS organization ID

Response example

tlsCertificateCompleteRequest

{
  "org_id": "hdl_7K9QW3M2ZT8HJ"
}

tlsCertificateOrderCancelRequest

No description was provided in the specification.

Type

object

Fields

2

Related endpoints

1

Fields

Name

Type

Format

Required

Description

comment

string

—

Optional

Optional provider comment for the full order cancellation request. If the request resolves to a pending-order cancellation, regfish sends a default provider note when this field is omitted.

revocation_reason

unspecified, keyCompromise, affiliationChanged, superseded, cessationOfOperation

string

—

Optional

Revocation reason.

Response example

tlsCertificateOrderCancelRequest

{
  "comment": "example",
  "revocation_reason": "unspecified"
}

tlsCertificateOrganization

No description was provided in the specification.

Type

object

Fields

4

Related endpoints

8

Fields

Name

Type

Format

Required

Description

id

string

—

Required

Public TLS organization ID

name

string

—

Required

—

status

ready, incomplete

string

—

Required

—

usable_for_ordering

boolean

—

Required

—

Response example

tlsCertificateOrganization

{
  "id": "hdl_7K9QW3M2ZT8HJ",
  "name": "example",
  "status": "ready",
  "usable_for_ordering": true
}

tlsCertificateReissueRequest

No description was provided in the specification.

Type

object

Fields

6

Related endpoints

1

Fields

Name

Type

Format

Required

Description

csr

string

—

Required

PEM encoded certificate signing request (CSR).

common_name

string

—

Optional

Fully Qualified Domain Name.

dns_names

array<string>

—

Optional

Optional. If provided, the SAN list must match the current order exactly.

dcv_method

dns-cname-token, email

string

—

Required

—

comments

string

—

Optional

Optional provider comment stored with the reissue request.

validity_days

integer

—

Optional

Optional requested certificate lifetime in days for the replacement certificate. The CA only honors this for eligible multi-year plan orders and never beyond the remaining order contract.

Response example

tlsCertificateReissueRequest

{
  "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC...\n-----END CERTIFICATE REQUEST-----",
  "dcv_method": "dns-cname-token"
}

tlsCertificateReissueResponse

No description was provided in the specification.

Type

object

Fields

14

Related endpoints

8

Fields

Name

Type

Format

Required

Description

id

integer

—

Required

—

status

pending, processing, pending_approval, issued, cancelled, rejected, failed

string

—

Required

—

common_name

string

—

Required

—

dns_names

array<string>

—

Required

—

order_state

string

—

Optional

—

requested_at

string

date-time

Optional

—

last_updated_at

string

date-time

Optional

—

validation

object

—

Optional

—

validation.method

dns-cname-token, email

string

—

Required

—

validation.dns_records

array<object>

—

Optional

—

validation.dns_records[].name

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

validation.dns_records[].type

CNAME

string

—

Required

—

validation.dns_records[].value

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

validation.email_targets

array<string>

—

Optional

—

Response example

tlsCertificateReissueResponse

{
  "id": 1,
  "status": "pending",
  "common_name": "example",
  "dns_names": [
    "example"
  ]
}

tlsCertificateRequest

No description was provided in the specification.

Type

object

Fields

9

Related endpoints

1

Fields

Name

Type

Format

Required

Description

sku

RapidSSL, RapidSSLWildcard, QuickSSLPremium, SSL123, TrueBusinessID, SecureSite, SSLWebServer

string

—

Required

regfish TLS certificate product identifier.

common_name

string

—

Required

Fully Qualified Domain Name.

dns_names

array<string>

—

Optional

—

csr

string

—

Required

PEM encoded certificate signing request (CSR).

dcv_method

dns-cname-token, email

string

—

Required

—

dcv_emails

array<string>

—

Optional

—

org_id

string

—

Optional

Public TLS organization ID

renewal_of_certificate_id

string

—

Optional

Public TLS certificate ID

validity_days

integer

—

Optional

Purchased base order validity in days. For renewal orders this value is not reduced by any expected remaining-validity bonus from the previous certificate. If the provider credits remaining validity, the issued certificate may end up with a longer effective lifetime than this value.

Response example

tlsCertificateRequest

{
  "sku": "RapidSSL",
  "common_name": "www.example.com",
  "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC...\n-----END CERTIFICATE REQUEST-----",
  "dcv_method": "dns-cname-token"
}

tlsCertificateResponse

No description was provided in the specification.

Type

object

Fields

51

Related endpoints

8

Fields

Name

Type

Format

Required

Description

id

string

—

Required

Public TLS certificate ID

status

pending, issued, pending_cancellation, pending_revocation, pending_order_revocation, cancelled, order_cancelled, revoked, order_revoked, rejected, expired, unknown

string

—

Required

—

common_name

string

—

Required

—

product

string

—

Required

—

provider

digicert

string

—

Required

—

dns_names

array<string>

—

Required

—

action_required

boolean

—

Required

—

pending_reason

string

—

Required

—

pending_message

string

—

Required

—

completion_url

string

—

Required

Absolute URL where the remaining order details can be completed in the web interface. API clients can alternatively use `/tls/certificate/{certificate_id}/complete`.

organization_id

string

—

Required

—

organization

object

—

Optional

—

organization.id

string

—

Required

Public TLS organization ID

organization.name

string

—

Required

—

organization.status

ready, incomplete

string

—

Required

—

organization.usable_for_ordering

boolean

—

Required

—

order_state

string

—

Optional

—

revocation_scope

certificate, order

string

—

Optional

—

revocation_pending_scope

certificate, order

string

—

Optional

—

reissue_supported

boolean

—

Optional

—

validity_days

integer

—

Optional

Purchased base order validity in days as submitted for the order. On provider-linked renewals the effective issued certificate lifetime can be longer. Use `valid_from` and `valid_until` as the authoritative issued lifetime.

renewal_bonus_days

integer

—

Optional

Confirmed additional validity days on top of `validity_days`, derived from the actually issued renewal certificate. This field is only present for renewal certificates once the effective issued lifetime can be determined.

serial_number

string

—

Optional

—

valid_from

string

date-time

Optional

—

valid_until

string

date-time

Optional

Authoritative expiration timestamp of the currently issued certificate. On provider-linked renewals this can be later than `validity_days` would suggest if the provider adds remaining validity from the previous certificate.

contract_valid_from

string

date-time

Optional

—

contract_valid_until

string

date-time

Optional

—

last_status_check

string

date-time

Optional

—

certificate_pem_available

boolean

—

Required

—

order_cancellable

boolean

—

Optional

—

order_cancellation_mode

cancel_pending, revoke_issued

string

—

Optional

—

order_cancellable_until

string

date-time

Optional

—

validation

object

—

Optional

—

validation.method

dns-cname-token, email

string

—

Required

—

validation.dns_records

array<object>

—

Optional

—

validation.dns_records[].name

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

validation.dns_records[].type

CNAME

string

—

Required

—

validation.dns_records[].value

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

validation.email_targets

array<string>

—

Optional

—

reissue

object

—

Optional

—

reissue.id

integer

—

Required

—

reissue.status

pending, processing, pending_approval, issued, cancelled, rejected, failed

string

—

Required

—

reissue.common_name

string

—

Required

—

reissue.dns_names

array<string>

—

Required

—

reissue.order_state

string

—

Optional

—

reissue.requested_at

string

date-time

Optional

—

reissue.last_updated_at

string

date-time

Optional

—

reissue.validation

object

—

Optional

—

reissue.validation.method

dns-cname-token, email

string

—

Required

—

reissue.validation.dns_records

array<object>

—

Optional

—

reissue.validation.email_targets

array<string>

—

Optional

—

Response example

tlsCertificateResponse

{
  "id": "7K9QW3M2ZT8HJ",
  "status": "pending",
  "common_name": "example",
  "product": "example",
  "provider": "digicert",
  "dns_names": [
    "example"
  ],
  "action_required": false,
  "pending_reason": "validation_pending",
  "pending_message": "The TLS certificate order is waiting for domain validation.",
  "completion_url": "",
  "organization_id": null,
  "certificate_pem_available": false
}

tlsCertificateRevokeRequest

No description was provided in the specification.

Type

object

Fields

2

Related endpoints

1

Fields

Name

Type

Format

Required

Description

comment

string

—

Optional

Optional provider comment for the revocation request.

revocation_reason

unspecified, keyCompromise, affiliationChanged, superseded, cessationOfOperation

string

—

Optional

Revocation reason.

Response example

tlsCertificateRevokeRequest

{
  "comment": "example",
  "revocation_reason": "unspecified"
}

tlsOrganizationCreateRequest

No description was provided in the specification.

Type

object

Fields

9

Related endpoints

1

Fields

Name

Type

Format

Required

Description

organization

string

—

Required

—

first_name

string

—

Required

—

last_name

string

—

Required

—

address

string

—

Required

—

postal_code

string

—

Required

—

city

string

—

Required

—

country_code

string

—

Required

—

phone

string

—

Required

—

email

string

—

Required

—

Response example

tlsOrganizationCreateRequest

{
  "organization": "example",
  "first_name": "example",
  "last_name": "example",
  "address": "example",
  "postal_code": "example",
  "city": "example",
  "country_code": "example",
  "phone": "example",
  "email": "example"
}

tlsOrganizationPatchRequest

No description was provided in the specification.

Type

object

Fields

10

Related endpoints

1

Fields

Name

Type

Format

Required

Description

edit_mode

create_replacement, update_provider

string

—

Optional

—

organization

string

—

Optional

—

first_name

string

—

Optional

—

last_name

string

—

Optional

—

address

string

—

Optional

—

postal_code

string

—

Optional

—

city

string

—

Optional

—

country_code

string

—

Optional

—

phone

string

—

Optional

—

email

string

—

Optional

—

Response example

tlsOrganizationPatchRequest

{
  "edit_mode": "create_replacement",
  "organization": "example",
  "first_name": "example",
  "last_name": "example"
}

tlsOrganizationResponse

No description was provided in the specification.

Type

object

Fields

18

Related endpoints

4

Fields

Name

Type

Format

Required

Description

id

string

—

Required

Public TLS organization ID

organization

string

—

Required

—

status

ready, incomplete

string

—

Required

—

usable_for_ordering

boolean

—

Required

—

provider

string

—

Optional

—

provider_status

string

—

Optional

—

validation_status

unknown, pending, validated, expired, revalidation_required

string

—

Optional

—

validation_type

string

—

Optional

—

validated_until

string

—

Optional

—

revalidation_required

boolean

—

Optional

—

first_name

string

—

Required

—

last_name

string

—

Required

—

address

string

—

Required

—

postal_code

string

—

Required

—

city

string

—

Required

—

country_code

string

—

Required

—

phone

string

—

Required

—

email

string

—

Required

—

Response example

tlsOrganizationResponse

{
  "id": "hdl_7K9QW3M2ZT8HJ",
  "organization": "example",
  "status": "ready",
  "usable_for_ordering": true,
  "first_name": "example",
  "last_name": "example",
  "address": "example",
  "postal_code": "example",
  "city": "example",
  "country_code": "example",
  "phone": "example",
  "email": "example"
}

tlsProductResponse

No description was provided in the specification.

Type

object

Fields

19

Related endpoints

1

Fields

Name

Type

Format

Required

Description

sku

RapidSSL, RapidSSLWildcard, QuickSSLPremium, SSL123, TrueBusinessID, SecureSite, SSLWebServer

string

—

Required

regfish TLS certificate product identifier.

name

string

—

Required

—

type

DV, OV, EV

string

—

Required

—

validation_level

dv, ov, ev

string

—

Required

—

organization_required

boolean

—

Required

—

ca

digicert, geotrust, rapidssl, thawte

string

—

Required

—

price

object

—

Required

—

price.yearly

number

float

Required

—

price.daily

number

float

Required

—

recommended

boolean

—

Optional

—

specs

object

—

Required

—

specs.seal

boolean

—

Optional

—

specs.san_support

boolean

—

Optional

—

specs.www_on_apex

boolean

—

Optional

—

specs.apex_on_wc

boolean

—

Optional

—

specs.wc_support

boolean

—

Optional

—

specs.san_wc_support

boolean

—

Optional

—

specs.max_sans

integer

—

Optional

—

specs.malware_check

boolean

—

Optional

—

Response example

tlsProductResponse

{
  "sku": "RapidSSL",
  "name": "example",
  "type": "DV",
  "validation_level": "dv",
  "organization_required": false,
  "ca": "digicert",
  "price": {
    "yearly": 1,
    "daily": 1
  },
  "specs": {
    "seal": true,
    "san_support": true,
    "www_on_apex": true,
    "apex_on_wc": true
  }
}

tlsProductSpecs

No description was provided in the specification.

Type

object

Fields

8

Related endpoints

1

Fields

Name

Type

Format

Required

Description

seal

boolean

—

Optional

—

san_support

boolean

—

Optional

—

www_on_apex

boolean

—

Optional

—

apex_on_wc

boolean

—

Optional

—

wc_support

boolean

—

Optional

—

san_wc_support

boolean

—

Optional

—

max_sans

integer

—

Optional

—

malware_check

boolean

—

Optional

—

Response example

tlsProductSpecs

{
  "seal": true,
  "san_support": true,
  "www_on_apex": true,
  "apex_on_wc": true
}

tlsValidation

No description was provided in the specification.

Type

object

Fields

6

Related endpoints

8

Fields

Name

Type

Format

Required

Description

method

dns-cname-token, email

string

—

Required

—

dns_records

array<object>

—

Optional

—

dns_records[].name

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

dns_records[].type

CNAME

string

—

Required

—

dns_records[].value

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

email_targets

array<string>

—

Optional

—

Response example

tlsValidation

{
  "method": "dns-cname-token"
}

tlsValidationDnsRecord

No description was provided in the specification.

Type

object

Fields

3

Related endpoints

8

Fields

Name

Type

Format

Required

Description

name

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

type

CNAME

string

—

Required

—

value

string

—

Required

Fully Qualified Domain Name (FQDN, ending with a period).

Response example

tlsValidationDnsRecord

{
  "name": "www.example.com.",
  "type": "CNAME",
  "value": "www.example.com."
}

TXT

No description was provided in the specification.

Type

object

Fields

5

Related endpoints

5

Fields

Name

Type

Format

Required

Description

type

TXT

string

—

Required

—

name

string

—

Required

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Required

—

Response example

TXT

{
  "type": "TXT",
  "name": "www",
  "data": "example"
}

On this page

A

Fields

Response example

Related endpoints

AAAA

Fields

Response example

Related endpoints

ALIAS

Fields

Response example

Related endpoints

baseResult

Fields

Response example

Related endpoints

CAA

Fields

Response example

Related endpoints

CNAME

Fields

Response example

Related endpoints

dnssecCapabilities

Fields

Response example

Related endpoints

dnssecJobResponse

Fields

Response example

Related endpoints

dnssecRecord

Fields

Response example

Related endpoints

dnssecRequest

Fields

Response example

Related endpoints

dnssecResponse

Fields

Response example

Related endpoints

dnsZoneCounts

Fields

Response example

Related endpoints

dnsZoneDelegationNameserver

Fields

Response example

Related endpoints

dnsZoneDetailResponse

Fields

Response example

Related endpoints

dnsZoneRecordResponse

Fields

Response example

Related endpoints

dnsZoneSOA

Fields

Response example

Related endpoints

dnsZoneSummaryResponse

Fields

Response example

Related endpoints

domainListResponse

Fields

Response example

Related endpoints

domainResponse

Fields

Response example

Related endpoints

Error

Fields

Response example