modify (DNSSEC)

Description

Adds or removes DS records for a given domain. To delete a single record, send a get (dnssec) request, then send a modify request with the full array minus the one you want to remove.

Request parameters for modify (DNSSEC)

Standard parameters

  • action = modify
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

key_tag

Optional

An integer value less than 65536 that identifies the
DNSSEC record for this domain name. Value cannot
be more than 65535.

algorithm

Required

The cryptographic algorithm that generates the
signature. Allowed values are:
2 Diffie-Hellman
3 DSA/SHA-1
4 Elliptic Curve
5 RSA/SHA-1
6 DSA-NSEC3/SHA1
7 RSASHA1-NSEC3/SHA1
8 RSA/SHA-256
10 RSA/SHA-512
253 Private [PRIVATEDNS]
254 Private [PRIVATEOID]

digest_type

Required

The algorithm type that constructs the
digest. Allowed values are:
1 SHA-1
2 SHA-256
3 GOST
4 SHA-384

digest

Required

The digest is an alpha-numeric string value. The
length depends on the digest type used:
SHA-1: 40 characters
SHA-256 and GOST: 64 characters
SHA-384: 96 characters

Response parameters for modify (DNSSEC)

Standard parameters

  • action = reply
  • object = domain

is_success = a Boolean is returned, indicating success or failure of the request
response_code = response code indicating outcome of the request
response_text = message describing the outcome of the request

Examples for modify (DNSSEC)

<?xml version="1.0" encoding="UTF-8"?>
<OPS_envelope>
  <header>
    <version>0.9</version>
  </header>
  <body>
    <data_block>
      <dt_assoc>
        <item key="protocol">XCP</item>
        <item key="action">modify</item>
        <item key="object">domain</item>
        <item key="domain">yourdomain.com</item>
        <item key="attributes">
          <dt_assoc>
            <item key="data">dnssec</item>
            <item key="dnssec">
              <dt_array>
                <item key="0">
                  <dt_assoc>
                    <item key="algorithm">5</item>
                    <item key="key_tag">333</item>
                    <item key="digest_type">1</item>
                    <item key="digest">da39a3ee5e6b4b0d3255bfef95601890afd80709</item>
                  </dt_assoc>
                </item>
              </dt_array>
            </item>
          </dt_assoc>
        </item>
      </dt_assoc>
    </data_block>
  </body>
</OPS_envelope>
<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">DOMAIN</item>
                <item key="response_text">Command successful</item>
                <item key="action">REPLY</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>