Modelle | regfish DNS & TLS API

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

—

Pflicht

—

Response-Beispiel

A

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

AAAA

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

5

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

AAAA

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

—

Response-Beispiel

AAAA

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

ALIAS

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

5

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

ALIAS

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

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

Response-Beispiel

ALIAS

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

baseResult

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

2

Verwandte Endpunkte

27

Felder

Name

Typ

Format

Pflicht

Description

success

boolean

—

Pflicht

Success indicator

code

integer

—

Optional

Response/Error Code

Response-Beispiel

baseResult

{
  "success": true
}

CAA

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

7

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

CAA

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

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

—

Pflicht

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

—

Pflicht

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

Response-Beispiel

CAA

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

CNAME

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

5

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

CNAME

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

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

Response-Beispiel

CNAME

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

dnssecCapabilities

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

9

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

supported

boolean

—

Pflicht

—

provider

string

—

Pflicht

—

mode_regfish_available

boolean

—

Pflicht

—

mode_external_available

boolean

—

Pflicht

—

accepted_record_kinds

array<string>

—

Pflicht

—

min_records

integer

—

Pflicht

—

max_records

integer

—

Optional

—

accepted_algorithms

array<integer>

—

Pflicht

—

reason_unavailable

string

—

Optional

—

Response-Beispiel

dnssecCapabilities

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

dnssecJobResponse

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

13

Verwandte Endpunkte

6

Felder

Name

Typ

Format

Pflicht

Description

id

integer

—

Pflicht

—

action

string

—

Pflicht

—

mode

string

—

Pflicht

—

status

string

—

Pflicht

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

source

string

—

Pflicht

—

registry_name

string

—

Optional

—

registry_reference

string

—

Optional

—

error_code

string

—

Optional

—

error_text

string

—

Optional

—

ts_created

integer

—

Pflicht

—

ts_updated

integer

—

Pflicht

—

ts_started

integer

—

Optional

—

ts_finished

integer

—

Optional

—

Response-Beispiel

dnssecJobResponse

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

dnssecRecord

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

9

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

kind

ds, dnskey

string

—

Pflicht

—

key_tag

integer

—

Optional

—

flags

integer

—

Optional

—

protocol

integer

—

Optional

—

algorithm

integer

—

Pflicht

—

digest_type

integer

—

Optional

—

digest

string

—

Optional

—

public_key

string

—

Optional

—

comment

string

—

Optional

—

Response-Beispiel

dnssecRecord

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

dnssecRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

13

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

mode

none, regfish, external

string

—

Pflicht

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

—

Pflicht

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

—

Pflicht

—

records[].key_tag

integer

—

Optional

—

records[].flags

integer

—

Optional

—

records[].protocol

integer

—

Optional

—

records[].algorithm

integer

—

Pflicht

—

records[].digest_type

integer

—

Optional

—

records[].digest

string

—

Optional

—

records[].public_key

string

—

Optional

—

records[].comment

string

—

Optional

—

Response-Beispiel

dnssecRequest

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

dnssecResponse

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

75

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

configured

boolean

—

Pflicht

Whether DNSSEC has been configured for the domain.

dnssec_state

active, pending, inactive

string

—

Pflicht

High-level DNSSEC status.

mode

none, regfish, external

string

—

Pflicht

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

—

Pflicht

Fine-grained registry DNSSEC state.

live_state

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

string

—

Pflicht

Fine-grained registry DNSSEC state.

capabilities

object

—

Pflicht

—

capabilities.supported

boolean

—

Pflicht

—

capabilities.provider

string

—

Pflicht

—

capabilities.mode_regfish_available

boolean

—

Pflicht

—

capabilities.mode_external_available

boolean

—

Pflicht

—

capabilities.accepted_record_kinds

array<string>

—

Pflicht

—

capabilities.min_records

integer

—

Pflicht

—

capabilities.max_records

integer

—

Optional

—

capabilities.accepted_algorithms

array<integer>

—

Pflicht

—

capabilities.reason_unavailable

string

—

Optional

—

desired_records

array<object>

—

Pflicht

—

desired_records[].kind

ds, dnskey

string

—

Pflicht

—

desired_records[].key_tag

integer

—

Optional

—

desired_records[].flags

integer

—

Optional

—

desired_records[].protocol

integer

—

Optional

—

desired_records[].algorithm

integer

—

Pflicht

—

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>

—

Pflicht

—

live_records[].kind

ds, dnskey

string

—

Pflicht

—

live_records[].key_tag

integer

—

Optional

—

live_records[].flags

integer

—

Optional

—

live_records[].protocol

integer

—

Optional

—

live_records[].algorithm

integer

—

Pflicht

—

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

—

Pflicht

—

pending_job.action

string

—

Pflicht

—

pending_job.mode

string

—

Pflicht

—

pending_job.status

string

—

Pflicht

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

pending_job.source

string

—

Pflicht

—

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

—

Pflicht

—

pending_job.ts_updated

integer

—

Pflicht

—

pending_job.ts_started

integer

—

Optional

—

pending_job.ts_finished

integer

—

Optional

—

using_regfish_nameservers

boolean

—

Pflicht

—

legacy_mode

boolean

—

Pflicht

—

zone_signed

boolean

—

Pflicht

—

zone_pending_disable

boolean

—

Pflicht

—

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

—

Pflicht

—

jobs[].action

string

—

Pflicht

—

jobs[].mode

string

—

Pflicht

—

jobs[].status

string

—

Pflicht

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

jobs[].source

string

—

Pflicht

—

jobs[].registry_name

string

—

Optional

—

jobs[].registry_reference

string

—

Optional

—

jobs[].error_code

string

—

Optional

—

jobs[].error_text

string

—

Optional

—

jobs[].ts_created

integer

—

Pflicht

—

jobs[].ts_updated

integer

—

Pflicht

—

jobs[].ts_started

integer

—

Optional

—

jobs[].ts_finished

integer

—

Optional

—

Response-Beispiel

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

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

5

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

records_total

integer

—

Pflicht

—

records_active

integer

—

Pflicht

—

records_auto

integer

—

Pflicht

—

records_manual

integer

—

Pflicht

—

by_type

object

—

Pflicht

—

Response-Beispiel

dnsZoneCounts

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

dnsZoneDelegationNameserver

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

2

Verwandte Endpunkte

2

Felder

Name

Typ

Format

Pflicht

Description

host

string

—

Pflicht

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

ipv4

string

—

Optional

—

Response-Beispiel

dnsZoneDelegationNameserver

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

dnsZoneDetailResponse

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

115

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

domain

string

—

Pflicht

Fully Qualified Domain Name.

origin

string

—

Pflicht

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

active

boolean

—

Pflicht

—

signed

boolean

—

Pflicht

Whether the regfish-hosted zone itself is signed.

using_regfish_nameservers

boolean

—

Pflicht

Whether the domain currently uses regfish authoritative nameservers.

delegation_nameservers

array<object>

—

Pflicht

—

delegation_nameservers[].host

string

—

Pflicht

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

delegation_nameservers[].ipv4

string

—

Optional

—

soa

object

—

Pflicht

—

soa.primary_nameserver

string

—

Pflicht

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

soa.mailbox

string

—

Pflicht

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

soa.serial

integer

—

Pflicht

—

soa.refresh

integer

—

Pflicht

—

soa.retry

integer

—

Pflicht

—

soa.expire

integer

—

Pflicht

—

soa.minimum

integer

—

Pflicht

—

soa.ttl

integer

—

Pflicht

—

record_count

integer

—

Pflicht

—

dnssec_state

active, pending, inactive

string

—

Pflicht

High-level DNSSEC status.

dnssec

object

—

Pflicht

—

dnssec.configured

boolean

—

Pflicht

Whether DNSSEC has been configured for the domain.

dnssec.dnssec_state

active, pending, inactive

string

—

Pflicht

High-level DNSSEC status.

dnssec.mode

none, regfish, external

string

—

Pflicht

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

—

Pflicht

Fine-grained registry DNSSEC state.

dnssec.live_state

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

string

—

Pflicht

Fine-grained registry DNSSEC state.

dnssec.capabilities

object

—

Pflicht

—

dnssec.capabilities.supported

boolean

—

Pflicht

—

dnssec.capabilities.provider

string

—

Pflicht

—

dnssec.capabilities.mode_regfish_available

boolean

—

Pflicht

—

dnssec.capabilities.mode_external_available

boolean

—

Pflicht

—

dnssec.capabilities.accepted_record_kinds

array<string>

—

Pflicht

—

dnssec.capabilities.min_records

integer

—

Pflicht

—

dnssec.capabilities.max_records

integer

—

Optional

—

dnssec.capabilities.accepted_algorithms

array<integer>

—

Pflicht

—

dnssec.capabilities.reason_unavailable

string

—

Optional

—

dnssec.desired_records

array<object>

—

Pflicht

—

dnssec.desired_records[].kind

ds, dnskey

string

—

Pflicht

—

dnssec.desired_records[].key_tag

integer

—

Optional

—

dnssec.desired_records[].flags

integer

—

Optional

—

dnssec.desired_records[].protocol

integer

—

Optional

—

dnssec.desired_records[].algorithm

integer

—

Pflicht

—

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>

—

Pflicht

—

dnssec.live_records[].kind

ds, dnskey

string

—

Pflicht

—

dnssec.live_records[].key_tag

integer

—

Optional

—

dnssec.live_records[].flags

integer

—

Optional

—

dnssec.live_records[].protocol

integer

—

Optional

—

dnssec.live_records[].algorithm

integer

—

Pflicht

—

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

—

Pflicht

—

dnssec.pending_job.action

string

—

Pflicht

—

dnssec.pending_job.mode

string

—

Pflicht

—

dnssec.pending_job.status

string

—

Pflicht

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

dnssec.pending_job.source

string

—

Pflicht

—

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

—

Pflicht

—

dnssec.pending_job.ts_updated

integer

—

Pflicht

—

dnssec.pending_job.ts_started

integer

—

Optional

—

dnssec.pending_job.ts_finished

integer

—

Optional

—

dnssec.using_regfish_nameservers

boolean

—

Pflicht

—

dnssec.legacy_mode

boolean

—

Pflicht

—

dnssec.zone_signed

boolean

—

Pflicht

—

dnssec.zone_pending_disable

boolean

—

Pflicht

—

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

—

Pflicht

—

dnssec.jobs[].action

string

—

Pflicht

—

dnssec.jobs[].mode

string

—

Pflicht

—

dnssec.jobs[].status

string

—

Pflicht

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

dnssec.jobs[].source

string

—

Pflicht

—

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

—

Pflicht

—

dnssec.jobs[].ts_updated

integer

—

Pflicht

—

dnssec.jobs[].ts_started

integer

—

Optional

—

dnssec.jobs[].ts_finished

integer

—

Optional

—

counts

object

—

Pflicht

—

counts.records_total

integer

—

Pflicht

—

counts.records_active

integer

—

Pflicht

—

counts.records_auto

integer

—

Pflicht

—

counts.records_manual

integer

—

Pflicht

—

counts.by_type

object

—

Pflicht

—

records

array<object>

—

Pflicht

—

records[].id

number

—

Pflicht

Resource Record ID

records[].name

string

—

Pflicht

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

records[].type

string

—

Pflicht

—

records[].data

string

—

Optional

—

records[].priority

integer

—

Optional

—

records[].flags

integer

—

Optional

—

records[].tag

string

—

Optional

—

records[].ttl

integer

—

Pflicht

—

records[].auto

boolean

—

Pflicht

—

records[].active

boolean

—

Pflicht

—

records[].annotation

string

—

Optional

—

records[].ts_created

integer

—

Pflicht

—

records[].ts_updated

integer

—

Pflicht

—

Response-Beispiel

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.

Typ

object

Felder

13

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

id

number

—

Pflicht

Resource Record ID

name

string

—

Pflicht

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

type

string

—

Pflicht

—

data

string

—

Optional

—

priority

integer

—

Optional

—

flags

integer

—

Optional

—

tag

string

—

Optional

—

ttl

integer

—

Pflicht

—

auto

boolean

—

Pflicht

—

active

boolean

—

Pflicht

—

annotation

string

—

Optional

—

ts_created

integer

—

Pflicht

—

ts_updated

integer

—

Pflicht

—

Response-Beispiel

dnsZoneRecordResponse

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

dnsZoneSOA

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

8

Verwandte Endpunkte

2

Felder

Name

Typ

Format

Pflicht

Description

primary_nameserver

string

—

Pflicht

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

mailbox

string

—

Pflicht

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

serial

integer

—

Pflicht

—

refresh

integer

—

Pflicht

—

retry

integer

—

Pflicht

—

expire

integer

—

Pflicht

—

minimum

integer

—

Pflicht

—

ttl

integer

—

Pflicht

—

Response-Beispiel

dnsZoneSOA

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

dnsZoneSummaryResponse

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

19

Verwandte Endpunkte

2

Felder

Name

Typ

Format

Pflicht

Description

domain

string

—

Pflicht

Fully Qualified Domain Name.

origin

string

—

Pflicht

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

active

boolean

—

Pflicht

—

signed

boolean

—

Pflicht

Whether the regfish-hosted zone itself is signed.

using_regfish_nameservers

boolean

—

Pflicht

Whether the domain currently uses regfish authoritative nameservers.

delegation_nameservers

array<object>

—

Pflicht

—

delegation_nameservers[].host

string

—

Pflicht

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

delegation_nameservers[].ipv4

string

—

Optional

—

soa

object

—

Pflicht

—

soa.primary_nameserver

string

—

Pflicht

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

soa.mailbox

string

—

Pflicht

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

soa.serial

integer

—

Pflicht

—

soa.refresh

integer

—

Pflicht

—

soa.retry

integer

—

Pflicht

—

soa.expire

integer

—

Pflicht

—

soa.minimum

integer

—

Pflicht

—

soa.ttl

integer

—

Pflicht

—

record_count

integer

—

Pflicht

—

dnssec_state

active, pending, inactive

string

—

Pflicht

High-level DNSSEC status.

Response-Beispiel

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

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

21

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

domains

array<object>

—

Pflicht

Domain list for the current result page.

domains[].domain

string

—

Pflicht

Fully Qualified Domain Name.

domains[].sld

string

—

Pflicht

Second-level domain label.

domains[].tld

string

—

Pflicht

Top-level domain.

domains[].favorite

boolean

—

Pflicht

Whether the domain is marked as a favorite.

domains[].owner_contact_id

integer

—

Optional

Registrant contact identifier, if available.

domains[].owner

string

—

Pflicht

Registrant name or organization label.

domains[].primary_nameserver

string

—

Pflicht

Primary delegated nameserver.

domains[].dnssec_state

active, pending, inactive

string

—

Pflicht

High-level DNSSEC status.

domains[].auto_renew

boolean

—

Pflicht

Whether the domain is set to renew automatically.

domains[].cancelled

boolean

—

Pflicht

Whether the domain has been cancelled.

domains[].registered_at

integer

—

Pflicht

Unix timestamp when the domain was registered.

domains[].expires_at

integer

—

Pflicht

Unix timestamp when the domain expires.

total_items

integer

—

Pflicht

Total number of matching domains.

total_pages

integer

—

Pflicht

Total number of available pages.

page

integer

—

Pflicht

Current page number.

page_size

integer

—

Pflicht

Number of items returned per page.

search

string

—

Pflicht

Applied search term.

filters

array<string>

—

Pflicht

Applied filters.

sort_by

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

string

—

Pflicht

—

sort_order

asc, desc

string

—

Pflicht

—

Response-Beispiel

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

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

12

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

domain

string

—

Pflicht

Fully Qualified Domain Name.

sld

string

—

Pflicht

Second-level domain label.

tld

string

—

Pflicht

Top-level domain.

favorite

boolean

—

Pflicht

Whether the domain is marked as a favorite.

owner_contact_id

integer

—

Optional

Registrant contact identifier, if available.

owner

string

—

Pflicht

Registrant name or organization label.

primary_nameserver

string

—

Pflicht

Primary delegated nameserver.

dnssec_state

active, pending, inactive

string

—

Pflicht

High-level DNSSEC status.

auto_renew

boolean

—

Pflicht

Whether the domain is set to renew automatically.

cancelled

boolean

—

Pflicht

Whether the domain has been cancelled.

registered_at

integer

—

Pflicht

Unix timestamp when the domain was registered.

expires_at

integer

—

Pflicht

Unix timestamp when the domain expires.

Response-Beispiel

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

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

3

Verwandte Endpunkte

30

Felder

Name

Typ

Format

Pflicht

Description

success

boolean

—

Pflicht

Indicator of success (always `false`)

message

string

—

Optional

A human readable message

error

string

—

Optional

A human readable error message

Response-Beispiel

Error

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

MX

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

6

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

MX

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

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

priority

integer

—

Pflicht

—

Response-Beispiel

MX

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

record

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

4

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

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

string

—

Pflicht

—

name

string

—

Pflicht

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-Beispiel

record

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

recordRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

5

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

type

A

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

—

Response-Beispiel

recordRequest

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

recordRequestFQDN

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

5

Verwandte Endpunkte

2

Felder

Name

Typ

Format

Pflicht

Description

type

A

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

—

Response-Beispiel

recordRequestFQDN

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

recordResponse

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

10

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

A

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

—

id

number

—

Pflicht

Resource Record ID

auto

boolean

—

Pflicht

Whether the DNS record is managed automatically by regfish.

active

boolean

—

Pflicht

Whether the DNS record is currently active.

ts_created

integer

—

Pflicht

Unix timestamp when the record was created.

ts_updated

integer

—

Pflicht

Unix timestamp when the record was last updated.

Response-Beispiel

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

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

1

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

name

string

—

Pflicht

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

Response-Beispiel

recordResponseAdditionalReqFQDN

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

recordResponseAdditionalReqRRID

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

1

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

id

number

—

Pflicht

Resource Record ID

Response-Beispiel

recordResponseAdditionalReqRRID

{
  "id": 1
}

recordResponseAdditionalState

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

4

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

auto

boolean

—

Pflicht

Whether the DNS record is managed automatically by regfish.

active

boolean

—

Pflicht

Whether the DNS record is currently active.

ts_created

integer

—

Pflicht

Unix timestamp when the record was created.

ts_updated

integer

—

Pflicht

Unix timestamp when the record was last updated.

Response-Beispiel

recordResponseAdditionalState

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

recordType

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

5

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

A

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

—

Response-Beispiel

recordType

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

tlsCertificateCancelRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

1

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

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-Beispiel

tlsCertificateCancelRequest

{
  "note": "example"
}

tlsCertificateCompleteRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

1

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

org_id

string

—

Pflicht

Public TLS organization ID

Response-Beispiel

tlsCertificateCompleteRequest

{
  "org_id": "hdl_7K9QW3M2ZT8HJ"
}

tlsCertificateOrderCancelRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

2

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

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-Beispiel

tlsCertificateOrderCancelRequest

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

tlsCertificateOrganization

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

4

Verwandte Endpunkte

8

Felder

Name

Typ

Format

Pflicht

Description

id

string

—

Pflicht

Public TLS organization ID

name

string

—

Pflicht

—

status

ready, incomplete

string

—

Pflicht

—

usable_for_ordering

boolean

—

Pflicht

—

Response-Beispiel

tlsCertificateOrganization

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

tlsCertificateReissueRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

6

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

csr

string

—

Pflicht

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

—

Pflicht

—

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-Beispiel

tlsCertificateReissueRequest

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

tlsCertificateReissueResponse

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

14

Verwandte Endpunkte

8

Felder

Name

Typ

Format

Pflicht

Description

id

integer

—

Pflicht

—

status

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

string

—

Pflicht

—

common_name

string

—

Pflicht

—

dns_names

array<string>

—

Pflicht

—

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

—

Pflicht

—

validation.dns_records

array<object>

—

Optional

—

validation.dns_records[].name

string

—

Pflicht

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

validation.dns_records[].type

CNAME

string

—

Pflicht

—

validation.dns_records[].value

string

—

Pflicht

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

validation.email_targets

array<string>

—

Optional

—

Response-Beispiel

tlsCertificateReissueResponse

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

tlsCertificateRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

9

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

sku

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

string

—

Pflicht

regfish TLS certificate product identifier.

common_name

string

—

Pflicht

Fully Qualified Domain Name.

dns_names

array<string>

—

Optional

—

csr

string

—

Pflicht

PEM encoded certificate signing request (CSR).

dcv_method

dns-cname-token, email

string

—

Pflicht

—

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-Beispiel

tlsCertificateRequest

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

tlsCertificateResponse

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

51

Verwandte Endpunkte

8

Felder

Name

Typ

Format

Pflicht

Description

id

string

—

Pflicht

Public TLS certificate ID

status

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

string

—

Pflicht

—

common_name

string

—

Pflicht

—

product

string

—

Pflicht

—

provider

digicert

string

—

Pflicht

—

dns_names

array<string>

—

Pflicht

—

action_required

boolean

—

Pflicht

—

pending_reason

string

—

Pflicht

—

pending_message

string

—

Pflicht

—

completion_url

string

—

Pflicht

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

—

Pflicht

—

organization

object

—

Optional

—

organization.id

string

—

Pflicht

Public TLS organization ID

organization.name

string

—

Pflicht

—

organization.status

ready, incomplete

string

—

Pflicht

—

organization.usable_for_ordering

boolean

—

Pflicht

—

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

—

Pflicht

—

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

—

Pflicht

—

validation.dns_records

array<object>

—

Optional

—

validation.dns_records[].name

string

—

Pflicht

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

validation.dns_records[].type

CNAME

string

—

Pflicht

—

validation.dns_records[].value

string

—

Pflicht

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

validation.email_targets

array<string>

—

Optional

—

reissue

object

—

Optional

—

reissue.id

integer

—

Pflicht

—

reissue.status

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

string

—

Pflicht

—

reissue.common_name

string

—

Pflicht

—

reissue.dns_names

array<string>

—

Pflicht

—

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

—

Pflicht

—

reissue.validation.dns_records

array<object>

—

Optional

—

reissue.validation.email_targets

array<string>

—

Optional

—

Response-Beispiel

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

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

2

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

comment

string

—

Optional

Optional provider comment for the revocation request.

revocation_reason

unspecified, keyCompromise, affiliationChanged, superseded, cessationOfOperation

string

—

Optional

Revocation reason.

Response-Beispiel

tlsCertificateRevokeRequest

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

tlsOrganizationCreateRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

9

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

organization

string

—

Pflicht

—

first_name

string

—

Pflicht

—

last_name

string

—

Pflicht

—

address

string

—

Pflicht

—

postal_code

string

—

Pflicht

—

city

string

—

Pflicht

—

country_code

string

—

Pflicht

—

phone

string

—

Pflicht

—

email

string

—

Pflicht

—

Response-Beispiel

tlsOrganizationCreateRequest

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

tlsOrganizationPatchRequest

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

10

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

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-Beispiel

tlsOrganizationPatchRequest

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

tlsOrganizationResponse

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

18

Verwandte Endpunkte

4

Felder

Name

Typ

Format

Pflicht

Description

id

string

—

Pflicht

Public TLS organization ID

organization

string

—

Pflicht

—

status

ready, incomplete

string

—

Pflicht

—

usable_for_ordering

boolean

—

Pflicht

—

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

—

Pflicht

—

last_name

string

—

Pflicht

—

address

string

—

Pflicht

—

postal_code

string

—

Pflicht

—

city

string

—

Pflicht

—

country_code

string

—

Pflicht

—

phone

string

—

Pflicht

—

email

string

—

Pflicht

—

Response-Beispiel

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

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

19

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

Description

sku

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

string

—

Pflicht

regfish TLS certificate product identifier.

name

string

—

Pflicht

—

type

DV, OV, EV

string

—

Pflicht

—

validation_level

dv, ov, ev

string

—

Pflicht

—

organization_required

boolean

—

Pflicht

—

ca

digicert, geotrust, rapidssl, thawte

string

—

Pflicht

—

price

object

—

Pflicht

—

price.yearly

number

float

Pflicht

—

price.daily

number

float

Pflicht

—

recommended

boolean

—

Optional

—

specs

object

—

Pflicht

—

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-Beispiel

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

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

8

Verwandte Endpunkte

1

Felder

Name

Typ

Format

Pflicht

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-Beispiel

tlsProductSpecs

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

tlsValidation

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

6

Verwandte Endpunkte

8

Felder

Name

Typ

Format

Pflicht

Description

method

dns-cname-token, email

string

—

Pflicht

—

dns_records

array<object>

—

Optional

—

dns_records[].name

string

—

Pflicht

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

dns_records[].type

CNAME

string

—

Pflicht

—

dns_records[].value

string

—

Pflicht

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

email_targets

array<string>

—

Optional

—

Response-Beispiel

tlsValidation

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

tlsValidationDnsRecord

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

3

Verwandte Endpunkte

8

Felder

Name

Typ

Format

Pflicht

Description

name

string

—

Pflicht

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

type

CNAME

string

—

Pflicht

—

value

string

—

Pflicht

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

Response-Beispiel

tlsValidationDnsRecord

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

TXT

Keine Beschreibung in der Spezifikation vorhanden.

Typ

object

Felder

5

Verwandte Endpunkte

5

Felder

Name

Typ

Format

Pflicht

Description

type

TXT

string

—

Pflicht

—

name

string

—

Pflicht

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

—

Pflicht

—

Response-Beispiel

TXT

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