dnssecResponse

No description available in the specification.

Fields

Field	Type	Required	Description
`configured`	`boolean`	yes	Whether DNSSEC has been configured for the domain.
`dnssec_state`	dnssecDisplayState	yes	High-level DNSSEC status. (`active`, `pending`, `inactive`)
`mode`	dnssecMode	yes	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 (`none`, `regfish`, `external`)
`desired_state`	dnssecState	yes	Fine-grained registry DNSSEC state. (`disabled`, `pending_enable`, `enabled`, `pending_disable`, `error`, `drift`, `unknown`)
`live_state`	dnssecState	yes	Fine-grained registry DNSSEC state. (`disabled`, `pending_enable`, `enabled`, `pending_disable`, `error`, `drift`, `unknown`)
`capabilities`	dnssecCapabilities	yes	—
`desired_records`	dnssecRecord[]	yes	—
`live_records`	dnssecRecord[]	yes	—
`last_error_code`	`string`	no	—
`last_error`	`string`	no	—
`last_registry_name`	`string`	no	—
`last_registry_reference`	`string`	no	—
`last_registry_status`	`string`	no	—
`last_verified_at`	`integer`	no	—
`last_applied_at`	`integer`	no	—
`pending_job`	`dnssecJobResponse`	no	Current DNSSEC transition job, if processing is still in progress.
`using_regfish_nameservers`	`boolean`	yes	—
`legacy_mode`	`boolean`	yes	—
`zone_signed`	`boolean`	yes	—
`zone_pending_disable`	`boolean`	yes	—
`zone_propagated_at`	`integer`	no	—
`jobs`	dnssecJobResponse[]	no	Recent DNSSEC jobs for the domain. This is history, not just the current pending item.

Example

{
  "configured": true,
  "dnssec_state": "active",
  "mode": "none",
  "desired_state": "disabled",
  "live_state": "disabled",
  "capabilities": {
    "supported": true,
    "provider": "string",
    "mode_regfish_available": true,
    "mode_external_available": true,
    "accepted_record_kinds": [
      "ds"
    ],
    "min_records": 0,
    "max_records": 0,
    "accepted_algorithms": [
      0
    ],
    "reason_unavailable": "string"
  },
  "desired_records": [
    {
      "kind": "ds",
      "key_tag": 0,
      "flags": 0,
      "protocol": 0,
      "algorithm": 0,
      "digest_type": 0,
      "digest": "string",
      "public_key": "string",
      "comment": "string"
    }
  ],
  "live_records": [
    {
      "kind": "ds",
      "key_tag": 0,
      "flags": 0,
      "protocol": 0,
      "algorithm": 0,
      "digest_type": 0,
      "digest": "string",
      "public_key": "string",
      "comment": "string"
    }
  ],
  "last_error_code": "string",
  "last_error": "string",
  "last_registry_name": "string",
  "last_registry_reference": "string",
  "last_registry_status": "string",
  "last_verified_at": 0,
  "last_applied_at": 0,
  "pending_job": {
    "id": 0,
    "action": "string",
    "mode": "string",
    "status": "string",
    "source": "string",
    "registry_name": "string",
    "registry_reference": "string",
    "error_code": "string",
    "error_text": "string",
    "ts_created": 0,
    "ts_updated": 0,
    "ts_started": 0,
    "ts_finished": 0
  },
  "using_regfish_nameservers": true,
  "legacy_mode": true,
  "zone_signed": true,
  "zone_pending_disable": true,
  "zone_propagated_at": 0,
  "jobs": [
    {
      "id": 0,
      "action": "string",
      "mode": "string",
      "status": "string",
      "source": "string",
      "registry_name": "string",
      "registry_reference": "string",
      "error_code": "string",
      "error_text": "string",
      "ts_created": 0,
      "ts_updated": 0,
      "ts_started": 0,
      "ts_finished": 0
    }
  ]
}

dnssecResponse

Fields

Example

Used by