Package: ionoscloud-dns
Python API client for ionoscloud_dnsCloud DNS service helps IONOS Cloud customers to automate DNS Zone and Record management.OverviewThe IONOS Cloud SDK for Python provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Python. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.Installation & UsageRequirements:Python >= 3.5pip installSince this package is hosted onPypiyou can install it by using:pipinstallionoscloud-dnsIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/ionos-cloud/sdk-python-dns.gitNote: you may need to runpipwith root permission:sudo pip install git+https://github.com/ionos-cloud/sdk-python-dns.gitThen import the package:importionoscloud_dnsSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--userorsudo python setup.py installto install the package for all usersThen import the package:importionoscloud_dnsNOTE:The Python SDK does not support Python 2. It only supports Python >= 3.5.AuthenticationThe username and passwordorthe authentication token can be manually specified when initializing the SDK client:configuration=ionoscloud_dns.Configuration(username='YOUR_USERNAME',password='YOUR_PASSWORD',token='YOUR_TOKEN')client=ionoscloud_dns.ApiClient(configuration)Environment variables can also be used. This is an example of how one would do that:importosconfiguration=ionoscloud_dns.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),token=os.environ.get('IONOS_TOKEN'))client=ionoscloud_dns.ApiClient(configuration)Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.HTTP proxiesYou can use http proxies by setting the following environment variables:IONOS_HTTP_PROXY- proxy URLIONOS_HTTP_PROXY_HEADERS- proxy headersChanging the base URLBase URL for the HTTP operation can be changed in the following way:importosconfiguration=ionoscloud_dns.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),host=os.environ.get('IONOS_API_URL'),server_index=None,)client=ionoscloud_dns.ApiClient(configuration)Certificate pinning:You can enable certificate pinning if you want to bypass the normal certificate checking procedure,
by doing the following:Set env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>You can get the sha256 fingerprint most easily from the browser by inspecting the certificate.Documentation for API EndpointsAll URIs are relative tohttps://dns.de-fra.ionos.comAPI Endpoints tableClassMethodHTTP requestDescriptionDNSSECApizones_keys_deleteDELETE/zones/{zoneId}/keysDelete a DNSSEC keyDNSSECApizones_keys_getGET/zones/{zoneId}/keysRetrieve a DNSSEC keyDNSSECApizones_keys_postPOST/zones/{zoneId}/keysCreate a DNSSEC keyQuotaApiquota_getGET/quotaRetrieve resources quotaRecordsApirecords_getGET/recordsRetrieve all records from primary zonesRecordsApisecondaryzones_records_getGET/secondaryzones/{secondaryZoneId}/recordsRetrieve records for a secondary zoneRecordsApizones_records_deleteDELETE/zones/{zoneId}/records/{recordId}Delete a recordRecordsApizones_records_find_by_idGET/zones/{zoneId}/records/{recordId}Retrieve a recordRecordsApizones_records_getGET/zones/{zoneId}/recordsRetrieve recordsRecordsApizones_records_postPOST/zones/{zoneId}/recordsCreate a recordRecordsApizones_records_putPUT/zones/{zoneId}/records/{recordId}Ensure a recordSecondaryZonesApisecondaryzones_axfr_getGET/secondaryzones/{secondaryZoneId}/axfrGet status of zone transferSecondaryZonesApisecondaryzones_axfr_putPUT/secondaryzones/{secondaryZoneId}/axfrStart zone transferSecondaryZonesApisecondaryzones_deleteDELETE/secondaryzones/{secondaryZoneId}Delete a secondary zoneSecondaryZonesApisecondaryzones_find_by_idGET/secondaryzones/{secondaryZoneId}Retrieve a secondary zoneSecondaryZonesApisecondaryzones_getGET/secondaryzonesRetrieve secondary zonesSecondaryZonesApisecondaryzones_postPOST/secondaryzonesCreate a secondary zoneSecondaryZonesApisecondaryzones_putPUT/secondaryzones/{secondaryZoneId}Ensure a secondary zoneZoneFilesApizones_zonefile_getGET/zones/{zoneId}/zonefileRetrieve a zone fileZoneFilesApizones_zonefile_putPUT/zones/{zoneId}/zonefileUpdates a zone with a fileZonesApizones_deleteDELETE/zones/{zoneId}Delete a zoneZonesApizones_find_by_idGET/zones/{zoneId}Retrieve a zoneZonesApizones_getGET/zonesRetrieve zonesZonesApizones_postPOST/zonesCreate a zoneZonesApizones_putPUT/zones/{zoneId}Ensure a zoneDocumentation For ModelsAll URIs are relative tohttps://dns.de-fra.ionos.comAPI models listAlgorithmCommonZoneCommonZoneReadCommonZoneReadListDnssecKeyDnssecKeyCreateDnssecKeyParametersDnssecKeyReadListDnssecKeyReadListMetadataErrorErrorMessagesKeyDataKeyParametersKskBitsLinksMetadataMetadataForSecondaryZoneRecordsMetadataWithStateFqdnZoneIdMetadataWithStateFqdnZoneIdAllOfMetadataWithStateNameserversMetadataWithStateNameserversAllOfNsecParametersProvisioningStateQuotaQuotaDetailRecordRecordCreateRecordEnsureRecordReadRecordReadListSecondaryZoneSecondaryZoneAllOfSecondaryZoneCreateSecondaryZoneEnsureSecondaryZoneReadSecondaryZoneReadAllOfSecondaryZoneReadListSecondaryZoneReadListAllOfSecondaryZoneRecordReadSecondaryZoneRecordReadListSecondaryZoneRecordReadListMetadataZoneZoneAllOfZoneCreateZoneEnsureZoneReadZoneReadAllOfZoneReadListZoneReadListAllOfZoneTransferPrimaryIpStatusZoneTransferPrimaryIpsStatusZskBits[Back to API list][Back to Model list]