Categorygithub.com/ionos-developer/dns-sdk-go
modulepackage
0.0.5
Repository: https://github.com/ionos-developer/dns-sdk-go.git
Documentation: pkg.go.dev

# README

Go API client for dns

Working with the API

Every endpoint uses the X-API-Key header for authorization, to obtain the key please see the Official Documentation.

Please note that any zone or record updates might conflict with active services. In such cases, the DNS records belonging to the conflicting services will be deactivated.

Support

Support questions may be posted in English: API Beta Support.

Please note that in the Beta phase we offer support in the business Hours Mo-Fri 9:00-17:00 EET.

Release notes
  • Version 1.0.0 Exposed CRUD operations for customer zone.
  • Version 1.0.1 Added response body for UPDATE and CREATE record operations.

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.

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

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

import dns "github.com/ionos-developer/dns-sdk-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), dns.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), dns.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), dns.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), dns.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.hosting.ionos.com/dns

ClassMethodHTTP requestDescription
DynamicDNSApiActivateDynDnsPost /v1/dyndns
DynamicDNSApiDeleteDynDnsDelete /v1/dyndns/{bulkId}
DynamicDNSApiDisableDynDnsDelete /v1/dyndns
DynamicDNSApiUpdateDynDnsPut /v1/dyndns/{bulkId}
RecordsApiCreateRecordsPost /v1/zones/{zoneId}/records
RecordsApiDeleteRecordDelete /v1/zones/{zoneId}/records/{recordId}
RecordsApiGetRecordGet /v1/zones/{zoneId}/records/{recordId}
RecordsApiNormalizeRecordPost /v1/records/normalizer
RecordsApiUpdateRecordPut /v1/zones/{zoneId}/records/{recordId}
ZonesApiGetZoneGet /v1/zones/{zoneId}
ZonesApiGetZonesGet /v1/zones
ZonesApiPatchZonePatch /v1/zones/{zoneId}
ZonesApiUpdateZonePut /v1/zones/{zoneId}

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-API-Key and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewCustomerZone instantiates a new CustomerZone object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCustomerZoneWithDefaults instantiates a new CustomerZone object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDynamicDns instantiates a new DynamicDns object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDynamicDnsWithDefaults instantiates a new DynamicDns object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDynDnsRequest instantiates a new DynDnsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDynDnsRequestWithDefaults instantiates a new DynDnsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewModelError instantiates a new ModelError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewModelErrorWithDefaults instantiates a new ModelError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewRecord instantiates a new Record object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRecordResponse instantiates a new RecordResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRecordResponseWithDefaults instantiates a new RecordResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRecordTypesFromValue returns a pointer to a valid RecordTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewRecordUpdate instantiates a new RecordUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRecordUpdateWithDefaults instantiates a new RecordUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRecordWithDefaults instantiates a new Record object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewZone instantiates a new Zone object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewZoneTypesFromValue returns a pointer to a valid ZoneTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewZoneWithDefaults instantiates a new Zone object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Constants

List of recordTypes.
List of recordTypes.
List of recordTypes.
List of recordTypes.
List of recordTypes.
List of zoneTypes.
List of recordTypes.
List of zoneTypes.
List of recordTypes.
List of recordTypes.
List of recordTypes.

# Variables

All allowed values of RecordTypes enum.
All allowed values of ZoneTypes enum.
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

No description provided by the author
APIClient manages communication with the DNS API API v1.0.1 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
CustomerZone struct for CustomerZone.
DynamicDns struct for DynamicDns.
DynDnsRequest struct for DynDnsRequest.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
ModelError struct for ModelError.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Record struct for Record.
RecordResponse struct for RecordResponse.
RecordUpdate struct for RecordUpdate.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Zone struct for Zone.

# Type aliases

DynamicDNSApiService DynamicDNSApi service.
RecordsApiService RecordsApi service.
RecordTypes Holds supported dns record types.
ServerConfigurations stores multiple ServerConfiguration items.
ZonesApiService ZonesApi service.
ZoneTypes Represents the possible zone types.