All URIs are relative to https://dns.de-fra.ionos.com
Method HTTP request Description Delete /zones/{zoneId}/records/{recordId}
Get /zones/{zoneId}/records/{recordId}
Get /zones/{zoneId}/records
Post /zones/{zoneId}/records
Put /zones/{zoneId}/records/{recordId}
RecordsGet
Copy var result RecordReadList = RecordsGet(ctx)
.FilterZoneId(filterZoneId)
.FilterName(filterName)
.FilterState(filterState)
.Offset(offset)
.Limit(limit)
.Execute()
Retrieve all records
Example
Copy package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-dns"
)
func main () {
filterZoneId := TODO // string | Filter used to fetch only the records that contain specified zoneId. (optional)
filterName := "app" // string | Filter used to fetch only the records that contain specified record name. (optional)
filterState := openapiclient.ProvisioningState("PROVISIONING") // ProvisioningState | Filter used to fetch only the records that are in certain state. (optional)
offset := int32(56) // int32 | The first element (of the total list of elements) to include in the response. Use together with limit for pagination. (optional) (default to 0)
limit := int32(56) // int32 | The maximum number of elements to return. Use together with offset for pagination. (optional) (default to 100)
configuration := ionoscloud.NewConfiguration( "USERNAME" , "PASSWORD" , "TOKEN" , "HOST_URL" )
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.RecordsApi.RecordsGet(context.Background()).FilterZoneId(filterZoneId).FilterName(filterName).FilterState(filterState).Offset(offset).Limit(limit).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RecordsApi.RecordsGet``: %v \n" , err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v \n" , resp)
}
// response from `RecordsGet`: RecordReadList
fmt.Fprintf(os.Stdout, "Response from `RecordsApi.RecordsGet`: %v \n" , resource)
}
Path Parameters
Other Parameters
Other parameters are passed through a pointer to an apiRecordsGetRequest struct via the builder pattern
Name Type Description Notes Filter used to fetch only the records that contain specified zoneId.
Filter used to fetch only the records that contain specified record name.
Filter used to fetch only the records that are in certain state.
The first element (of the total list of elements) to include in the response. Use together with limit for pagination.
The maximum number of elements to return. Use together with offset for pagination.
Return type
RecordReadList
Content-Type : Not defined
ZonesRecordsDelete
Copy var result = ZonesRecordsDelete(ctx, zoneId, recordId)
.Execute()
Delete a record
Example
Copy package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-dns"
)
func main () {
zoneId := TODO // string | The ID (UUID) of the DNS zone.
recordId := TODO // string | The ID (UUID) of the record.
configuration := ionoscloud.NewConfiguration( "USERNAME" , "PASSWORD" , "TOKEN" , "HOST_URL" )
apiClient := ionoscloud.NewAPIClient(configuration)
resp, err := apiClient.RecordsApi.ZonesRecordsDelete(context.Background(), zoneId, recordId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RecordsApi.ZonesRecordsDelete``: %v \n" , err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v \n" , resp)
}
}
Path Parameters
Name Type Description Notes context for authentication, logging, cancellation, deadlines, tracing, etc.
The ID (UUID) of the DNS zone.
The ID (UUID) of the record.
Other Parameters
Other parameters are passed through a pointer to an apiZonesRecordsDeleteRequest struct via the builder pattern
Return type
(empty response body)
Content-Type : Not defined
ZonesRecordsFindById
Copy var result RecordRead = ZonesRecordsFindById(ctx, zoneId, recordId)
.Execute()
Retrieve a record
Example
Copy package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-dns"
)
func main () {
zoneId := TODO // string | The ID (UUID) of the DNS zone.
recordId := TODO // string | The ID (UUID) of the record.
configuration := ionoscloud.NewConfiguration( "USERNAME" , "PASSWORD" , "TOKEN" , "HOST_URL" )
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.RecordsApi.ZonesRecordsFindById(context.Background(), zoneId, recordId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RecordsApi.ZonesRecordsFindById``: %v \n" , err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v \n" , resp)
}
// response from `ZonesRecordsFindById`: RecordRead
fmt.Fprintf(os.Stdout, "Response from `RecordsApi.ZonesRecordsFindById`: %v \n" , resource)
}
Path Parameters
Name Type Description Notes context for authentication, logging, cancellation, deadlines, tracing, etc.
The ID (UUID) of the DNS zone.
The ID (UUID) of the record.
Other Parameters
Other parameters are passed through a pointer to an apiZonesRecordsFindByIdRequest struct via the builder pattern
Return type
RecordRead
Content-Type : Not defined
ZonesRecordsGet
Copy var result RecordReadList = ZonesRecordsGet(ctx, zoneId)
.Execute()
Retrieve records
Example
Copy package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-dns"
)
func main () {
zoneId := TODO // string | The ID (UUID) of the DNS zone.
configuration := ionoscloud.NewConfiguration( "USERNAME" , "PASSWORD" , "TOKEN" , "HOST_URL" )
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.RecordsApi.ZonesRecordsGet(context.Background(), zoneId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RecordsApi.ZonesRecordsGet``: %v \n" , err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v \n" , resp)
}
// response from `ZonesRecordsGet`: RecordReadList
fmt.Fprintf(os.Stdout, "Response from `RecordsApi.ZonesRecordsGet`: %v \n" , resource)
}
Path Parameters
Name Type Description Notes context for authentication, logging, cancellation, deadlines, tracing, etc.
The ID (UUID) of the DNS zone.
Other Parameters
Other parameters are passed through a pointer to an apiZonesRecordsGetRequest struct via the builder pattern
Return type
RecordReadList
Content-Type : Not defined
ZonesRecordsPost
Copy var result RecordRead = ZonesRecordsPost(ctx, zoneId)
.RecordCreate(recordCreate)
.Execute()
Create a record
Example
Copy package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-dns"
)
func main () {
zoneId := TODO // string | The ID (UUID) of the DNS zone.
recordCreate := *openapiclient.NewRecordCreate(*openapiclient.NewRecord("app", "Type_example", "1.2.3.4")) // RecordCreate | record
configuration := ionoscloud.NewConfiguration( "USERNAME" , "PASSWORD" , "TOKEN" , "HOST_URL" )
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.RecordsApi.ZonesRecordsPost(context.Background(), zoneId).RecordCreate(recordCreate).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RecordsApi.ZonesRecordsPost``: %v \n" , err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v \n" , resp)
}
// response from `ZonesRecordsPost`: RecordRead
fmt.Fprintf(os.Stdout, "Response from `RecordsApi.ZonesRecordsPost`: %v \n" , resource)
}
Path Parameters
Name Type Description Notes context for authentication, logging, cancellation, deadlines, tracing, etc.
The ID (UUID) of the DNS zone.
Other Parameters
Other parameters are passed through a pointer to an apiZonesRecordsPostRequest struct via the builder pattern
Return type
RecordRead
Content-Type : application/json
ZonesRecordsPut
Copy var result RecordRead = ZonesRecordsPut(ctx, zoneId, recordId)
.RecordEnsure(recordEnsure)
.Execute()
Ensure a record
Example
Copy package main
import (
"context"
"fmt"
"os"
ionoscloud "github.com/ionos-cloud/sdk-go-dns"
)
func main () {
zoneId := TODO // string | The ID (UUID) of the DNS zone.
recordId := TODO // string | The ID (UUID) of the DNS record.
recordEnsure := *openapiclient.NewRecordEnsure(*openapiclient.NewRecord("app", "Type_example", "1.2.3.4")) // RecordEnsure |
configuration := ionoscloud.NewConfiguration( "USERNAME" , "PASSWORD" , "TOKEN" , "HOST_URL" )
apiClient := ionoscloud.NewAPIClient(configuration)
resource, resp, err := apiClient.RecordsApi.ZonesRecordsPut(context.Background(), zoneId, recordId).RecordEnsure(recordEnsure).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RecordsApi.ZonesRecordsPut``: %v \n" , err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v \n" , resp)
}
// response from `ZonesRecordsPut`: RecordRead
fmt.Fprintf(os.Stdout, "Response from `RecordsApi.ZonesRecordsPut`: %v \n" , resource)
}
Path Parameters
Name Type Description Notes context for authentication, logging, cancellation, deadlines, tracing, etc.
The ID (UUID) of the DNS zone.
The ID (UUID) of the DNS record.
Other Parameters
Other parameters are passed through a pointer to an apiZonesRecordsPutRequest struct via the builder pattern
Return type
RecordRead
Content-Type : application/json