Go API client for ionoscloud

Cloud DNS service helps IONOS Cloud customers to automate DNS Zone and Record management.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.17.0
• Package version: 1.4.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://docs.ionos.com/support/general-information/contact-information

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./ionoscloud"

Authentication

All available server URLs are:

• https://dns.de-fra.ionos.com - Frankfurt

By default, https://dns.de-fra.ionos.com is used, however this can be overriden at authentication, either by setting the IONOS_API_URL environment variable or by specifying the hostUrl parameter when initializing the sdk client.

The username and password or the authentication token can be manually specified when initializing the sdk client:

client := ionoscloud.NewAPIClient(ionoscloud.NewConfiguration(username, password, token, hostUrl))

Environment variables can also be used. The sdk uses the following variables:

• IONOS_TOKEN - login via token. This is the recommended way to authenticate.
• IONOS_USERNAME - to specify the username used to login
• IONOS_PASSWORD - to specify the password
• IONOS_API_URL - to specify the API server URL

In this case, the client configuration needs to be initialized using NewConfigurationFromEnv().

client := ionoscloud.NewAPIClient(ionoscloud.NewConfigurationFromEnv())

Documentation for API Endpoints

All URIs are relative to https://dns.de-fra.ionos.com

API Endpoints table

Class	Method	HTTP request	Description
DNSSECApi	ZonesKeysDelete	Delete /zones/{zoneId}/keys	Delete a DNSSEC key
DNSSECApi	ZonesKeysGet	Get /zones/{zoneId}/keys	Retrieve a DNSSEC key
DNSSECApi	ZonesKeysPost	Post /zones/{zoneId}/keys	Create a DNSSEC key
QuotaApi	QuotaGet	Get /quota	Retrieve resources quota
RecordsApi	RecordsGet	Get /records	Retrieve all records from primary zones
RecordsApi	SecondaryzonesRecordsGet	Get /secondaryzones/{secondaryZoneId}/records	Retrieve records for a secondary zone
RecordsApi	ZonesRecordsDelete	Delete /zones/{zoneId}/records/{recordId}	Delete a record
RecordsApi	ZonesRecordsFindById	Get /zones/{zoneId}/records/{recordId}	Retrieve a record
RecordsApi	ZonesRecordsGet	Get /zones/{zoneId}/records	Retrieve records
RecordsApi	ZonesRecordsPost	Post /zones/{zoneId}/records	Create a record
RecordsApi	ZonesRecordsPut	Put /zones/{zoneId}/records/{recordId}	Update a record
ReverseRecordsApi	ReverserecordsDelete	Delete /reverserecords/{reverserecordId}	Delete a reverse DNS record
ReverseRecordsApi	ReverserecordsFindById	Get /reverserecords/{reverserecordId}	Retrieve a reverse DNS record
ReverseRecordsApi	ReverserecordsGet	Get /reverserecords	Retrieves existing reverse DNS records
ReverseRecordsApi	ReverserecordsPost	Post /reverserecords	Create a reverse DNS record
ReverseRecordsApi	ReverserecordsPut	Put /reverserecords/{reverserecordId}	Update a reverse DNS record
SecondaryZonesApi	SecondaryzonesAxfrGet	Get /secondaryzones/{secondaryZoneId}/axfr	Get status of zone transfer
SecondaryZonesApi	SecondaryzonesAxfrPut	Put /secondaryzones/{secondaryZoneId}/axfr	Start zone transfer
SecondaryZonesApi	SecondaryzonesDelete	Delete /secondaryzones/{secondaryZoneId}	Delete a secondary zone
SecondaryZonesApi	SecondaryzonesFindById	Get /secondaryzones/{secondaryZoneId}	Retrieve a secondary zone
SecondaryZonesApi	SecondaryzonesGet	Get /secondaryzones	Retrieve secondary zones
SecondaryZonesApi	SecondaryzonesPost	Post /secondaryzones	Create a secondary zone
SecondaryZonesApi	SecondaryzonesPut	Put /secondaryzones/{secondaryZoneId}	Update a secondary zone
ZoneFilesApi	ZonesZonefileGet	Get /zones/{zoneId}/zonefile	Retrieve a zone file
ZoneFilesApi	ZonesZonefilePut	Put /zones/{zoneId}/zonefile	Updates a zone with a file
ZonesApi	ZonesDelete	Delete /zones/{zoneId}	Delete a zone
ZonesApi	ZonesFindById	Get /zones/{zoneId}	Retrieve a zone
ZonesApi	ZonesGet	Get /zones	Retrieve zones
ZonesApi	ZonesPost	Post /zones	Create a zone
ZonesApi	ZonesPut	Put /zones/{zoneId}	Update a zone

Documentation For Models

All URIs are relative to https://dns.de-fra.ionos.com

API models list

• Algorithm
• CommonZone
• CommonZoneRead
• CommonZoneReadList
• DnssecKey
• DnssecKeyCreate
• DnssecKeyParameters
• DnssecKeyReadCreation
• DnssecKeyReadList
• DnssecKeyReadListMetadata
• DnssecKeyReadListProperties
• DnssecKeyReadListPropertiesKeyParameters
• DnssecKeyReadListPropertiesNsecParameters
• Error
• ErrorMessages
• KeyData
• KeyParameters
• KskBits
• Links
• Metadata
• MetadataForSecondaryZoneRecords
• MetadataWithStateFqdnZoneId
• MetadataWithStateFqdnZoneIdAllOf
• MetadataWithStateNameservers
• MetadataWithStateNameserversAllOf
• NsecMode
• NsecParameters
• ProvisioningState
• Quota
• QuotaDetail
• Record
• RecordCreate
• RecordEnsure
• RecordRead
• RecordReadList
• RecordType
• ReverseRecord
• ReverseRecordCreate
• ReverseRecordEnsure
• ReverseRecordRead
• ReverseRecordsReadList
• SecondaryZone
• SecondaryZoneAllOf
• SecondaryZoneCreate
• SecondaryZoneEnsure
• SecondaryZoneRead
• SecondaryZoneReadAllOf
• SecondaryZoneReadList
• SecondaryZoneReadListAllOf
• SecondaryZoneRecordRead
• SecondaryZoneRecordReadList
• SecondaryZoneRecordReadListMetadata
• Zone
• ZoneAllOf
• ZoneCreate
• ZoneEnsure
• ZoneRead
• ZoneReadAllOf
• ZoneReadList
• ZoneReadListAllOf
• ZoneTransferPrimaryIpStatus
• ZoneTransferPrimaryIpsStatus
• ZskBits

[Back to API list] [Back to Model list]