NAME

Regru::API::DNSSEC - REG.API v2 DNSSEC management

VERSION

version 0.051

DESCRIPTION

REG.API DNSSEC management methods

ATTRIBUTES

namespace

Always returns the name of category: dnssec. For internal uses only.

REG.API METHODS

nop

For testing purposes to check the ability to manage DNSSEC of domains. Scope: clients. Typical usage:

    $resp = $client->dnssec->nop(
        domains => [
            { dname => 'bluth-company.com' },
            { dname => 'sitwell-enterprises.com' },
        ],
    );

Answer will contains a field domains with a list of domain names which allows to manage DNSSEC or error otherwise.

More info at DNSSEC management: nop.

get_status

Gets DNSSEC status for domain(s). Scope: clients. Typical usage:

    $resp = $client->dnssec->get_status(
        domains => [
            { dname => 'bluth-company.com' },
            { dname => 'sitwell-enterprises.com' },
        ],
    );

Answer will contains a field domains with a list of results for each involved to this operation domain names (or error otherwise) and subfield status with one value of: enabled, disabled, updating.

More info at DNSSEC management: get_status.

enable

Enables DNSSEC for domain(s), that uses REG.RU nameservers. Later you can use "get_status" to check that operation finished successfully. Scope: clients. Typical usage:

    $resp = $client->dnssec->enable(
        domains => [
            { dname => 'bluth-company.com' },
            { dname => 'sitwell-enterprises.com' },
        ],
    );

Answer will contains a field domains with a list of results for each involved to this operation domain names or error otherwise.

More info at DNSSEC management: enable.

disable

Disables DNSSEC for domain(s), that uses REG.RU nameservers. Later you can use "get_status" to check that operation finished successfully. Scope: clients. Typical usage:

    $resp = $client->dnssec->disable(
        domains => [
            { dname => 'bluth-company.com' },
            { dname => 'sitwell-enterprises.com' },
        ],
    );

Answer will contains a field domains with a list of results for each involved to this operation domain names or error otherwise.

More info at DNSSEC management: disable.

renew_ksk

Regenerates and updates KSK key for domain(s), that uses REG.RU nameservers. Later you can use "get_status" to check that operation finished successfully. Scope: clients. Typical usage:

    $resp = $client->dnssec->renew_ksk(
        domains => [
            { dname => 'bluth-company.com' },
            { dname => 'sitwell-enterprises.com' },
        ],
    );

Answer will contains a field domains with a list of results for each involved to this operation domain names or error otherwise.

More info at DNSSEC management: renew_ksk.

renew_zsk

Regenerates and updates ZSK key for domain(s), that uses REG.RU nameservers. Later you can use "get_status" to check that operation finished successfully. Scope: clients. Typical usage:

    $resp = $client->dnssec->renew_zsk(
        domains => [
            { dname => 'bluth-company.com' },
            { dname => 'sitwell-enterprises.com' },
        ],
    );

Answer will contains a field domains with a list of results for each involved to this operation domain names or error otherwise.

More info at DNSSEC management: renew_zsk.

get_records

Gets list of DNSSEC records of a domain(s). These are DNSKEY and DS records for domains those use REG.RU nameservers. For other domains it will return DNSSEC records from the parent zone. Scope: clients. Typical usage:

    $resp = $client->dnssec->get_records(
        domains => [
            { dname => 'bluth-company.com' },
            { dname => 'sitwell-enterprises.com' },
        ],
    );

Answer will contains a field domains with a list of results for each involved to this operation domain names (or error otherwise) and subfield records in described format.

More info at DNSSEC management: get_records.

add_keys

Adds information about KSK keys to the parent zone. Can be used only for domains which don't use REG.RU nameservers. records field should contain array of DNSKEY/DS records or API will try to get records from authoritative DNS server if field missed or emty. Later you can use "get_status", "get_records" to check that operation finished successfully. Scope: clients. Typical usage:

    $resp = $client->dnssec->add_keys(
        domains => [
            { dname => 'bluth-company.com', records => [
                "bluth-company.com. 3600 IN DS 2371 13 2 4508a7798c38867c94091bbf91edaf9e6dbf56da0606c748d3d1d1b2382c1602"
            ] },
            { dname => 'sitwell-enterprises.com', records => [
                "sitwell-enterprises.com. IN DNSKEY 257 3 13 X2ehOZBEVxU6baEa58fQx/6Y+gckDeq85XGFW8o6jWFB19wtv6aqdc8ycpIrQaZ4bSLYM7ZyLPJtP6UOkzslDg=="
            ] },
        ],
    );

Answer will contains a field domains with a list of results for each involved to this operation domain names or error otherwise.

More info at DNSSEC management: add_keys.

SEE ALSO

Regru::API

Regru::API::Role::Client

Regru::API::Domain

REG.API DNSSEC management

REG.API Common error codes

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/regru/regru-api-perl/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHORS

  • Polina Shubina <shubina@reg.ru>

  • Anton Gerasimov <a.gerasimov@reg.ru>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by REG.RU LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.