The package is a wrapper for the API of Russian DNS registrar Ru-Center (a.k.a. NIC.RU). The library provides classes for managing DNS services, zones and records.
Using pip
:
pip install nic-api
If you want to use the module in your project, add this line to the project's requirements.txt
file:
nic-api
To start using the API, you should get a pair of OAuth application login and password from NIC.RU. Here is the registration page: https://www.nic.ru/manager/oauth.cgi?step=oauth.app_register
Create an instance of nic_api.DnsApi
and provide the OAuth application credentials:
Call the authorize()
method and specify the username and the password of your NIC.RU account, and a file to store the OAuth token for future use:
Now you are ready to use the API.
While the token in token_filename
file is valid, you don't need to provide neither username or password to access the API - just create an instance of the DnsApi
class with the same OAuth config, and pass only token_filename
to the authorize()
method.
In the NIC.RU, DNS zones are located in "services":
Usually there is one service per account. Let's view available zones in the service MY_SERVICE
:
Always check if the zone has any uncommitted changes to it before making any modifications - your commit will apply other changes too!
For viewing or modifying records, you need to specify both service and DNS zone name:
To add a record, create an instance of one of the nic_api.models.DNSRecord
subclasses, i.e. ARecord
:
Add this record to the zone and commit the changes:
Every record in the zone has an unique ID, and it's accessible via DNSRecord.id
property. When you got the ID, pass it to the delete_record
method:
Do not forget to always commit the changes!