Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 2.9 KB

README.md

File metadata and controls

105 lines (72 loc) · 2.9 KB
Raw

banner

Wrapper around the IONOS DNS, Domains & SSL API

GitHub last commit GitHub release (latest by date) GitHub

Installation

Pyonos is a PyPi package and can be installed using pip.

pip install pyonos

Features

  • Full DNS, Domains & SSL API coverage
  • Top-Level methods for easier use of the core methods
  • DynDns Update Function

Quickstart

IONOS exposes 3 different API's.

  • Dns
  • Domains
  • Ssl

Every API has its corresponding & same name class that can be imported from pyonos. Every class needs to be authenticated using a prefix and a secret.

Similarly, every API endpoint has its own corresponding method. Methods always return a PyonosResponse object which has two properties:

  • .status_code: The http status code returned
  • .json: the json response (if not available: None)

DNS API

Full IONOS DNS Documentation

Start by importing the Dns class from pyonos.

from pyonos import Dns

Now we need to authenticate with a prefix and a secret.

from pyonos import Dns

dns = Dns("abc", "def")

Now we use the .get_zones() method to get all zones available. Because PyonosResponse overwrites it's _str_ method, we can just print the response.

from pyonos import Dns

dns = Dns("abc", "def")
response = dns.get_zones()

print(response)

# get single properties like this:
#   response.status_code
#   response.json

List of all available methods/endpoints

Method names are a combination of the http method used and their category.

  • Dns (Official API Docs)
    • Zones
      • get_zones: Returns list of customer zones.
      • get_zone: Returns a customer zone.
      • patch_zone: Replaces all records of the same name and type with the ones provided.
      • put_zone: Replaces all records in the zone with the ones provided.
    • Records
      • post_records: Creates records for a customer zone.
      • get_record: Returns the record from the customer zone with the mentioned id.
      • delete_record: Delete a record from the customer zone.
      • put_record: Update a record from the customer zone.
    • DynDns
      • post_dyndns: Activate dyndns for a group of domains.
      • delete_dyndns: Disable Dynamic Dns.
      • put_dyndns: Update Dynamic Dns for bulk id.
      • delete_dyndns_bulk: Disable Dynamic Dns for bulk id.

About

Made with ♥ by aaronlyy

License

GNU GPL v3