get (DNSSEC)

Returns list of all DS records for a domain.

Request parameters

Standard request parameters

  • action = get
  • object = domain

Request attributes

ParameterObligationDefinition/Value
domainRequiredThe relevant domain.
typeRequiredThe type of query, use the value 'dnssec' to retrieve dnssec information.

Response parameters

Standard response parameters

  • action = reply
  • object = domain
  • is_success = Boolean 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.

Response attributes

If the request is successful, the attributes associative array may include the following:

ParameterObligationDefinition/Value
dnssecAlways returnedContains an array specifying the DNSSEC details to be added. For more information, please see the dnssec table below.

Response parameters within the dnssec array includes the following:

ParameterObligationDefinition/Value
algorithmAlways returnedThe cryptographic algorithm that generates the signature. Allowed values are:

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]
key_tagAlways returnedAn integer value that identifies the DNSSEC record for this domain name.
digest_typeAlways returnedThe algorithm type that constructs the digest, allowed values are:
1—SHA-1
2—SHA-256
3—GOST
4—SHA-384
digestAlways returnedThe digest is an alpha-numeric string value.

Example

<?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">get</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.com</item>
                        <item key="type">dnssec</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="attributes">
                    <dt_assoc>
                        <item key="dnssec">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="algorithm">5</item>
                                        <item key="key_tag">333</item>
                                        <item key="digest">da39a3ee5e6b4b0d3255bfef95601890afd80709</item>
                                        <item key="digest_type">1</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>