Understanding How The API Works »
Activating or Deactivating the DNSSEC service in the API requires specific syntax depending on whether you are using using REST or SOAP. Use this table to find the syntax for your command.
REST Syntax
Click to view all REST Resources |
/REST/DNSSEC/ PUT — Activates or Deactivates an existing DNSSEC service on the zone indicated.
HTTP Action — PUT
URI — https://api.dynect.net/REST/DNSSEC/<zone>/ |
Arguments —
To Activate DNSSEC on the zone indicated — boolean activate — Required.
To Deactivate DNSSEC on the zone indicated — boolean deactivate — Required. |
Response — Click for More Info
- string
active — Identifies the state of the service.
Valid values:
Y = service is active.
N = service is inactive.
- string
zone — Name of the zone where the service exists.
- string
contact_nickname — Name of contact to receive notifications.
- string
notify_events — Comma-separated list of events which trigger notifications.
Valid values: create, expire, warning.
- array
keys
- string
dnssec_key_id — A numeric ID for this key.
- string
type — The type of the key.
Valid values:
KSK
ZSK
- string
algorithm — Algorithm assigned to the key.
Valid values:
RSA/SHA-1
RSA/SHA-256
RSA/SHA-512
DSA
ECDSAP256SHA256
ECDSAP384SHA384
- string
bits — Length of key in bits.
- string
start_ts — An epoch time when key is valid.
- string
expire_ts — An epoch time specifying when this key will expire.
- string
lifetime — Lifetime of the key, expressed in seconds.
- string
overlap — Time before expiration when a replacement key is prepared, specified in seconds.
- hash
dnskey — A DNSKEY record containing this key.
- string
algorithm
- string
flags
- string
protocol
- string
public_key
- hash
ds — A DS record containing the signature of this key.
- string
algorithm
- string
digest
- string
digtype
- string
keytag
- array all_ds — The full list of all DS records created for the KSK. This field will contain an empty list if inspected on a ZSK resource.
-
- string
algorithm
- string
digest
- string
digtype
- string
keytag
|

SOAP Syntax
Click to view all SOAP Commands |
ActivateDNSSEC — Activates the DNSSEC service on the zone indicated.
DeactivateDNSSEC — Deactivates the DNSSEC service on the zone indicated. |
Arguments — (For both Activate and Deactivate)
string token — Required. The session identifier.
string zone — Required. Name of the zone where the DNSSEC service exists. |
Response (For both Activate and Deactivate) — Click for More Info
- hash
data
- string
active — Identifies the state of the service.
Valid values:
Y = service is active.
N = service is inactive.
- string
zone — Name of the zone where the service exists.
- string
contact_nickname — Name of contact to receive notifications.
- string
notify_events — Comma-separated list of events which trigger notifications.
Valid values: create, expire, warning.
- array
keys
- string
dnssec_key_id — A numeric ID for this key.
- string
type — The type of the key.
Valid values:
KSK
ZSK
- string
algorithm — Algorithm assigned to the key.
Valid values:
RSA/SHA-1
RSA/SHA-256
RSA/SHA-512
DSA
ECDSAP256SHA256
ECDSAP384SHA384
- string
bits — Length of key in bits.
- string
start_ts — An epoch time when key is valid.
- string
expire_ts — An epoch time specifying when this key will expire.
- string
lifetime — Lifetime of the key, expressed in seconds.
- string
overlap — Time before expiration when a replacement key is prepared, specified in seconds.
- hash
dnskey — A DNSKEY record containing this key.
- string
algorithm
- string
flags
- string
protocol
- string
public_key
- hash
ds — A DS record containing the signature of this key.
- string
algorithm
- string
digest
- string
digtype
- string
keytag
- array all_ds — The full list of all DS records created for the KSK. This field will contain an empty list if inspected on a ZSK resource.
- string
algorithm
- string
digest
- string
digtype
- string
keytag
|
Example Request (For both Activate and Deactivate) — Click for More Info
{
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
<< DNS API Knowledge Base