Skip to main content

Unofficial Client for Hosting.de API

Project description

Unofficial Hosting.de API Client

Python3 library for accessing the hosting.de dns api.

PyPI version

Disclaimer

This is a very basic unofficial client for the hosting.de API. I have only implemented very few functions that I need for another hobby project. I am not in any way connected to hosting.de other then being a paying customer.

I'd be happy to give up this library for an official and supported library.

I have built this library to use it for ddns scripts and let's encrypt wildcard certificate requests.

Validation and sanitizing of any inputs is expected to be done at higher level.

USE THIS LIBRARY AT YOUR OWN RISK, DO NOT USE IN PRODUCTION. DO NOT EXPECT SUPPORT.

DNS

I have only implemented functions and data structures for the DNS API.

API functions

The Hosting.de DNS API functions that I have implemented so far are:

  • recordsFind(recordFilter, limit=25, page=1, sort=None)
  • zoneConfigsFind(zoneConfigFilter, limit=25, page=1, sort=None)
  • zonesFind(zoneFilter, limit=25, page=1, sort=None)
  • zoneCreate(zoneConfig, records, useDefaultNameserverSet=False, nameserverSetId=None)
  • zoneDelete(zoneConfigId=None, zoneConfigName=None)
  • zoneRecreate(zoneConfig, records, useDefaultNameserverSet=False, nameserverSetId=None)
  • zoneUpdate(zoneConfig, recordsToAdd, recordsToDelete=[])

There are also helpers to aid with correct data structes for these functions and helper functions, that require less information.

Custom API functions

  • getZonesByFilter(zoneFilter, limit=25, page=1, sort=None)

  • getZonesByRecord(recordName, recordType=None, recordContent=None, limit=25, page=1, sort=None)

  • getZonesByDomainHierarchy(recordName, limit=25, page=1, sort=None)

  • getZoneByRecord(recordName, recordType=None, recordContent=None, limit=25, page=1)

  • getZoneByDomain(recordName, recordType=None, recordContent=None, limit=25, page=1)

  • getRecordsByFilter(recordFilter, limit=50, page=1, sort=None)

  • getRecords(recordName, recordType=None, recordContent=None, limit=50, page=1, sort=None)

  • addZoneRecordWithConfig(zoneConfig, recordName, recordType, recordContent, ttl=600)

  • deleteZoneRecordWithConfig(zoneConfig, recordName, recordType, recordContent)

  • updateZoneRecordWithConfig(zoneConfig, recordName, recordType, recordContent, oldContent, ttl=600)

  • deleteZoneRecordsWithFilter(zoneFilter, recordName, recordType, recordContent=None)

  • setZoneRecordWithFilter(zoneFilter, recordName, recordType, recordContent, oldContent=None, ttl=600)

  • addZoneRecord(zoneName, recordName, recordType, recordContent, ttl=600)

  • deleteZoneRecord(zoneName, recordName, recordType, recordContent)

  • updateZoneRecord(zoneName, recordName, recordType, recordContent, oldContent, ttl=600)

  • deleteZoneRecords(zoneName, recordName, recordType, recordContent=None)

  • setZoneRecord(zoneName, recordName, recordType, recordContent, oldContent=None, ttl=600)

  • addRecord(recordName, recordType, recordContent, ttl=600)

  • deleteRecord(recordName, recordType, recordContent=None)

  • setRecord(recordName, recordType, recordContent, oldContent=None, ttl=600)

  • updateRecord(recordName, recordType, recordContent, oldContent=None, ttl=600)

Examples

Adding IPv4 IP:

from hostingde.api.dns import DnsApiClient
client = DnsApiClient("MySecretLongApiKey")
client.AddRecord("dev.example.org", "demo.dev.example.org", "A", "127.0.0.1", ttl=8400)

Adding IPv6 IP:

from hostingde.api.dns import DnsApiClient
client = DnsApiClient("MySecretLongApiKey")
client.AddRecord("dev.example.org", "demo.dev.example.org", "AAAA", "AFFE::1", ttl=8400)

Update IPv4 IP:

from hostingde.api.dns import DnsApiClient
client = DnsApiClient("MySecretLongApiKey")
client.UpdateRecord("demo.dev.example.org", "A", "128.0.0.1", "127.0.0.1", 60)

In this case the zoneConfigName and TTL are used from the first previous record, ttl can be specified. Value is only updated if there is more than one record or the current value differs from the new value.

Known Issues

  • No warning handling from responses

Dependencies

  • requests

Install

Easy

pip install no-hostingde-api

Developer

git clone https://github.com/DimeOne/no-hostingde-api.git
cd hostingde-api
python setup.py develop

or

git clone https://github.com/DimeOne/no-hostingde-api.git
cd hostingde-api
pip install -e .

Build

python setup.py sdist bdist_wheel

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

no-hostingde-api-0.2.1.tar.gz (10.0 kB view hashes)

Uploaded source

Built Distribution

no_hostingde_api-0.2.1-py2.py3-none-any.whl (9.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page