Only this pageAll pages
Couldn't generate the PDF for 156 pages, generation stopped at 100.
Extend with 50 more pages.
1 of 100

release/v5

Loading...

Loading...

API

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Models

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Changelog

v5.1.11 (December, 2021)

Enhancements:

  • added Password field to UserPropertiesPut to allow user password update

Fixes:

  • fixed sporadic EOF error seen from server

  • fixed overwriting https with http for host endpoint that starts with http. It now supports both http and https schemas

Dependency-updates:

  • updated Go version from 1.13 to 1.17

5.1.10 (November, 2021)

Enhancements:

  • added support for maxResults query parameter on GET requests

5.1.9 (October, 2021)

Enhancements:

  • improved code in sync with Sonar Cloud requirements:

    • added global constant FilterQueryParam

    • renamed global constant FORMAT_STRING to FormatStringErr

5.1.8 (October, 2021)

Enhancements:

  • added support for filter query parameters on GET requests: Filter()

  • added support for overwriting the host-url value via IONOS_API_URL environment variable

  • added gofmt check's results

5.1.7 (September, 2021)

Features:

  • removed Public parameter from KubernetesClusterProperties

  • removed GatewayIp parameter from KubernetesNodePoolProperties

5.1.6 (September, 2021)

Documentation:

  • changed descriptions

5.1.5 (August, 2021)

Features:

  • added new parameter on APIResponse:

    • RequestTime

5.1.4 (July, 2021)

Features:

  • added new parameters on KubernetesClusterProperties, KubernetesClusterPropertiesForPost and KubernetesClusterPropertiesForPut:

    • ApiSubnetAllowList

    • S3Buckets

  • added new required parameter on KubernetesNodePoolLan: id

Introduction

Overview

IMPORTANT NOTE:

The Go SDK v5 is deprecated and no longer maintained. Please upgrade to v6, which uses the latest stable API version.

The Go SDK v5 will reach End of Life by September 30, 2023. After this date, the v5 API will not be accessible. If you require any assistance, please contact our support team.


The IONOS Cloud SDK for GO 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 GO . The SDK for GO wraps the IONOS Cloud API. 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.

Getting Started

An IONOS account is required for access to the Cloud API; credentials from your registration are used to authenticate against the IONOS Cloud API.

Installation

Install the Go language from from the official Go installation guide.

The GOPATH environment variable specifies the location of your Go workspace. It is likely the only environment variable you will have to set when developing Go code. This is an example of pointing to a workspace configured under your home directory:

mkdir -p ~/go/bin
export GOPATH=~/go
export GOBIN=$GOPATH/bin
export PATH=$PATH:$GOBIN

The following go command will download sdk-go to your configured GOPATH:

go get "github.com/ionos-cloud/sdk-go"

The source code of the package will be located here:

$GOPATH/src/github.com/ionos-cloud/sdk-go

Create main package file example.go:

package main

import (
    "fmt"
)

func main() {
}

Include the IONOS Cloud SDK for Go under the list of imports.

import(
    "fmt"

    "github.com/ionos-cloud/sdk-go"
)

Authentication

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, apiUrl))

Environment variables can also be used; the SDK uses the following variables:

  • IONOS_USERNAME - to specify the username used to login

  • IONOS_PASSWORD - to specify the password

  • IONOS_TOKEN - if an authentication token is being used

  • IONOS_API_URL - to overwrite the API endpoint: api.ionos.com - if it is not set, the default value will be used

In this case, the client configuration must be initialized using NewConfigurationFromEnv()

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

Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.

Environment Variables

Environment Variable
Description

IONOS_USERNAME

Specify the username used to login, to authenticate against the IONOS Cloud API

IONOS_PASSWORD

Specify the password used to login, to authenticate against the IONOS Cloud API

IONOS_TOKEN

Specify the token used to login, if a token is being used instead of username and password

IONOS_API_URL

Specify the API URL. It will overwrite the API endpoint default value api.ionos.com. Note: the host URL does not contain the /cloudapi/v5 path, so it should not be included in the IONOS_API_URL environment variable

Depth

Many of the List or Get operations will accept an optional depth argument. Setting this to a value between 0 and 5 affects the amount of data that is returned. The details returned vary depending on the resource being queried, but it generally follows this pattern. By default, the SDK sets the depth argument to the maximum value.

Depth
Description

0

Only direct properties are included. Children are not included.

1

Direct properties and children's references are returned.

2

Direct properties and children's properties are returned.

3

Direct properties, children's properties, and descendants' references are returned.

4

Direct properties, children's properties, and descendants' properties are returned.

5

Returns all available properties.

How to set Depth parameter:

⚠️ Please use this parameter with caution. We recommend using the default value and raising its value only if it is needed.

  • On the configuration level:

configuration := ionoscloud.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "URL")  
configuration.SetDepth(5)  

Using this method, the depth parameter will be set on all the API calls.

  • When calling a method:

request := apiClient.DataCenterApi.DatacentersGet(context.Background()).Depth(1)

Using this method, the depth parameter will be set on the current API call.

  • Using the default value:

If the depth parameter is not set, it will have the default value from the API that can be found here.

Note: The priority for setting the depth parameter is: set on function call > set on configuration level > set using the default value from the API

Pretty

The operations will also accept an optional pretty argument. Setting this to a value of true or false controls whether the response is pretty-printed (with indentation and new lines). By default, the SDK sets the pretty argument to true.

Changing the base URL

Base URL for the HTTP operation can be changed by using the following function:

requestProperties.SetURL("https://api.ionos.com/cloudapi/v5")

Feature Reference

The IONOS Cloud SDK for GO aims to offer access to all resources in the IONOS Cloud API, and has additional features to make integration easier:

  • Authentication for API calls

  • Asynchronous request handling

FAQ

  1. How can I open a bug report/feature request?

Bug reports and feature requests can be opened in the Issues repository: https://github.com/ionos-cloud/sdk-go/issues/new/choose

  1. Can I contribute to the GO SDK?

Pure SDKs are automatically generated using OpenAPI Generator and don’t support manual changes. If you require changes, please open an issue and we will try to address it.

Debugging

If you want to see the API call request and response messages, you need to set the Debug field in the Configuration struct:

package main

import "github.com/ionos-cloud/sdk-go/v5"

func main() {
    // create your configuration. replace username, password, token and url with correct values, or use NewConfigurationFromEnv()
    // if you have set your env variables as explained above
    cfg := ionoscloud.NewConfiguration("username", "password", "token", "hostUrl")
    // enable request and response logging
    cfg.Debug = true
    // create you api client with the configuration
    apiClient := ionoscloud.NewAPIClient(cfg)
}

⚠️ Note: We recommend you only set this field for debugging purposes. Disable it in your production environments because it can log sensitive data. It logs the full request and response without encryption, even for an HTTPS call. Verbose request and response logging can also significantly impact your application’s performance.

ContractApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Get /contracts

Retrieve a Contract

ContractsGet

var result Contract = ContractsGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Contract

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ContractApi.ContractsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ContractApi.ContractsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ContractsGet`: Contract
    fmt.Fprintf(os.Stdout, "Response from `ContractApi.ContractsGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiContractsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Contract

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DefaultApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Get /

Display API information

ApiInfoGet

var result Info = ApiInfoGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Display API information

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.ApiInfoGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.ApiInfoGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ApiInfoGet`: Info
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.ApiInfoGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiInfoGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Info

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

BackupUnitSSO

Properties

Name
Type
Description
Notes

Methods

NewBackupUnitSSO

func NewBackupUnitSSO() *BackupUnitSSO

NewBackupUnitSSO instantiates a new BackupUnitSSO 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

NewBackupUnitSSOWithDefaults

func NewBackupUnitSSOWithDefaults() *BackupUnitSSO

NewBackupUnitSSOWithDefaults instantiates a new BackupUnitSSO 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

GetSsoUrl

func (o *BackupUnitSSO) GetSsoUrl() string

GetSsoUrl returns the SsoUrl field if non-nil, zero value otherwise.

GetSsoUrlOk

func (o *BackupUnitSSO) GetSsoUrlOk() (*string, bool)

GetSsoUrlOk returns a tuple with the SsoUrl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSsoUrl

func (o *BackupUnitSSO) SetSsoUrl(v string)

SetSsoUrl sets SsoUrl field to given value.

HasSsoUrl

func (o *BackupUnitSSO) HasSsoUrl() bool

HasSsoUrl returns a boolean if a field has been set.

ErrorMessage

Properties

Name
Type
Description
Notes

Methods

NewErrorMessage

func NewErrorMessage() *ErrorMessage

NewErrorMessage instantiates a new ErrorMessage 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

NewErrorMessageWithDefaults

func NewErrorMessageWithDefaults() *ErrorMessage

NewErrorMessageWithDefaults instantiates a new ErrorMessage 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

GetErrorCode

func (o *ErrorMessage) GetErrorCode() string

GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise.

GetErrorCodeOk

func (o *ErrorMessage) GetErrorCodeOk() (*string, bool)

GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetErrorCode

func (o *ErrorMessage) SetErrorCode(v string)

SetErrorCode sets ErrorCode field to given value.

HasErrorCode

func (o *ErrorMessage) HasErrorCode() bool

HasErrorCode returns a boolean if a field has been set.

GetMessage

func (o *ErrorMessage) GetMessage() string

GetMessage returns the Message field if non-nil, zero value otherwise.

GetMessageOk

func (o *ErrorMessage) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMessage

func (o *ErrorMessage) SetMessage(v string)

SetMessage sets Message field to given value.

HasMessage

func (o *ErrorMessage) HasMessage() bool

HasMessage returns a boolean if a field has been set.

LabelResourceProperties

Properties

Name
Type
Description
Notes

Methods

NewLabelResourceProperties

func NewLabelResourceProperties() *LabelResourceProperties

NewLabelResourceProperties instantiates a new LabelResourceProperties 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

NewLabelResourcePropertiesWithDefaults

func NewLabelResourcePropertiesWithDefaults() *LabelResourceProperties

NewLabelResourcePropertiesWithDefaults instantiates a new LabelResourceProperties 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

GetKey

func (o *LabelResourceProperties) GetKey() string

GetKey returns the Key field if non-nil, zero value otherwise.

GetKeyOk

func (o *LabelResourceProperties) GetKeyOk() (*string, bool)

GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetKey

func (o *LabelResourceProperties) SetKey(v string)

SetKey sets Key field to given value.

HasKey

func (o *LabelResourceProperties) HasKey() bool

HasKey returns a boolean if a field has been set.

GetValue

func (o *LabelResourceProperties) GetValue() string

GetValue returns the Value field if non-nil, zero value otherwise.

GetValueOk

func (o *LabelResourceProperties) GetValueOk() (*string, bool)

GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetValue

func (o *LabelResourceProperties) SetValue(v string)

SetValue sets Value field to given value.

HasValue

func (o *LabelResourceProperties) HasValue() bool

HasValue returns a boolean if a field has been set.

KubernetesConfigProperties

Properties

Name
Type
Description
Notes

Methods

NewKubernetesConfigProperties

func NewKubernetesConfigProperties() *KubernetesConfigProperties

NewKubernetesConfigProperties instantiates a new KubernetesConfigProperties 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

NewKubernetesConfigPropertiesWithDefaults

func NewKubernetesConfigPropertiesWithDefaults() *KubernetesConfigProperties

NewKubernetesConfigPropertiesWithDefaults instantiates a new KubernetesConfigProperties 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

GetKubeconfig

func (o *KubernetesConfigProperties) GetKubeconfig() string

GetKubeconfig returns the Kubeconfig field if non-nil, zero value otherwise.

GetKubeconfigOk

func (o *KubernetesConfigProperties) GetKubeconfigOk() (*string, bool)

GetKubeconfigOk returns a tuple with the Kubeconfig field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetKubeconfig

func (o *KubernetesConfigProperties) SetKubeconfig(v string)

SetKubeconfig sets Kubeconfig field to given value.

HasKubeconfig

func (o *KubernetesConfigProperties) HasKubeconfig() bool

HasKubeconfig returns a boolean if a field has been set.

LoadbalancerEntities

Properties

Name
Type
Description
Notes

Methods

NewLoadbalancerEntities

func NewLoadbalancerEntities() *LoadbalancerEntities

NewLoadbalancerEntities instantiates a new LoadbalancerEntities 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

NewLoadbalancerEntitiesWithDefaults

func NewLoadbalancerEntitiesWithDefaults() *LoadbalancerEntities

NewLoadbalancerEntitiesWithDefaults instantiates a new LoadbalancerEntities 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

GetBalancednics

func (o *LoadbalancerEntities) GetBalancednics() BalancedNics

GetBalancednics returns the Balancednics field if non-nil, zero value otherwise.

GetBalancednicsOk

func (o *LoadbalancerEntities) GetBalancednicsOk() (*BalancedNics, bool)

GetBalancednicsOk returns a tuple with the Balancednics field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBalancednics

func (o *LoadbalancerEntities) SetBalancednics(v BalancedNics)

SetBalancednics sets Balancednics field to given value.

HasBalancednics

func (o *LoadbalancerEntities) HasBalancednics() bool

HasBalancednics returns a boolean if a field has been set.

KubernetesNodePoolLan

Properties

Name
Type
Description
Notes

Methods

NewKubernetesNodePoolLan

func NewKubernetesNodePoolLan(id int32, ) *KubernetesNodePoolLan

NewKubernetesNodePoolLan instantiates a new KubernetesNodePoolLan 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

NewKubernetesNodePoolLanWithDefaults

func NewKubernetesNodePoolLanWithDefaults() *KubernetesNodePoolLan

NewKubernetesNodePoolLanWithDefaults instantiates a new KubernetesNodePoolLan 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

GetId

func (o *KubernetesNodePoolLan) GetId() int32

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesNodePoolLan) GetIdOk() (*int32, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesNodePoolLan) SetId(v int32)

SetId sets Id field to given value.

SsoUrl

Pointer to string

The backup unit single sign on url

[optional] [readonly]

ErrorCode

Pointer to string

Application internal error code

[optional] [readonly]

Message

Pointer to string

Human readable message

[optional] [readonly]

Key

Pointer to string

A Label Key

[optional]

Value

Pointer to string

A Label Value

[optional]

Kubeconfig

Pointer to string

A Kubernetes Config file data

[optional]

Balancednics

Pointer to BalancedNics

[optional]

Id

int32

The LAN ID of an existing LAN at the related datacenter

ContractsGet
ApiInfoGet

KubernetesMaintenanceWindow

Properties

Name
Type
Description
Notes

DayOfTheWeek

Pointer to string

The day of the week for a maintenance window.

[optional]

Time

Pointer to string

The time to use for a maintenance window. Accepted formats are: HH:mm:ss; HH:mm:ss"Z"; HH:mm:ssZ. This time may varies by 15 minutes.

[optional]

Methods

NewKubernetesMaintenanceWindow

func NewKubernetesMaintenanceWindow() *KubernetesMaintenanceWindow

NewKubernetesMaintenanceWindow instantiates a new KubernetesMaintenanceWindow 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

NewKubernetesMaintenanceWindowWithDefaults

func NewKubernetesMaintenanceWindowWithDefaults() *KubernetesMaintenanceWindow

NewKubernetesMaintenanceWindowWithDefaults instantiates a new KubernetesMaintenanceWindow 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

GetDayOfTheWeek

func (o *KubernetesMaintenanceWindow) GetDayOfTheWeek() string

GetDayOfTheWeek returns the DayOfTheWeek field if non-nil, zero value otherwise.

GetDayOfTheWeekOk

func (o *KubernetesMaintenanceWindow) GetDayOfTheWeekOk() (*string, bool)

GetDayOfTheWeekOk returns a tuple with the DayOfTheWeek field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDayOfTheWeek

func (o *KubernetesMaintenanceWindow) SetDayOfTheWeek(v string)

SetDayOfTheWeek sets DayOfTheWeek field to given value.

HasDayOfTheWeek

func (o *KubernetesMaintenanceWindow) HasDayOfTheWeek() bool

HasDayOfTheWeek returns a boolean if a field has been set.

GetTime

func (o *KubernetesMaintenanceWindow) GetTime() string

GetTime returns the Time field if non-nil, zero value otherwise.

GetTimeOk

func (o *KubernetesMaintenanceWindow) GetTimeOk() (*string, bool)

GetTimeOk returns a tuple with the Time field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTime

func (o *KubernetesMaintenanceWindow) SetTime(v string)

SetTime sets Time field to given value.

HasTime

func (o *KubernetesMaintenanceWindow) HasTime() bool

HasTime returns a boolean if a field has been set.

GroupShareProperties

Properties

Name
Type
Description
Notes

EditPrivilege

Pointer to bool

edit privilege on a resource

[optional]

SharePrivilege

Pointer to bool

share privilege on a resource

[optional]

Methods

NewGroupShareProperties

func NewGroupShareProperties() *GroupShareProperties

NewGroupShareProperties instantiates a new GroupShareProperties 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

NewGroupSharePropertiesWithDefaults

func NewGroupSharePropertiesWithDefaults() *GroupShareProperties

NewGroupSharePropertiesWithDefaults instantiates a new GroupShareProperties 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

GetEditPrivilege

func (o *GroupShareProperties) GetEditPrivilege() bool

GetEditPrivilege returns the EditPrivilege field if non-nil, zero value otherwise.

GetEditPrivilegeOk

func (o *GroupShareProperties) GetEditPrivilegeOk() (*bool, bool)

GetEditPrivilegeOk returns a tuple with the EditPrivilege field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEditPrivilege

func (o *GroupShareProperties) SetEditPrivilege(v bool)

SetEditPrivilege sets EditPrivilege field to given value.

HasEditPrivilege

func (o *GroupShareProperties) HasEditPrivilege() bool

HasEditPrivilege returns a boolean if a field has been set.

GetSharePrivilege

func (o *GroupShareProperties) GetSharePrivilege() bool

GetSharePrivilege returns the SharePrivilege field if non-nil, zero value otherwise.

GetSharePrivilegeOk

func (o *GroupShareProperties) GetSharePrivilegeOk() (*bool, bool)

GetSharePrivilegeOk returns a tuple with the SharePrivilege field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSharePrivilege

func (o *GroupShareProperties) SetSharePrivilege(v bool)

SetSharePrivilege sets SharePrivilege field to given value.

HasSharePrivilege

func (o *GroupShareProperties) HasSharePrivilege() bool

HasSharePrivilege returns a boolean if a field has been set.

KubernetesAutoScaling

Properties

Name
Type
Description
Notes

MinNodeCount

Pointer to int32

The minimum number of worker nodes that the managed node group can scale in. Should be set together with 'maxNodeCount'. Value for this attribute must be greater than equal to 1 and less than equal to maxNodeCount.

[optional]

MaxNodeCount

Pointer to int32

The maximum number of worker nodes that the managed node pool can scale-out. Should be set together with 'minNodeCount'. Value for this attribute must be greater than equal to 1 and minNodeCount.

[optional]

Methods

NewKubernetesAutoScaling

func NewKubernetesAutoScaling() *KubernetesAutoScaling

NewKubernetesAutoScaling instantiates a new KubernetesAutoScaling 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

NewKubernetesAutoScalingWithDefaults

func NewKubernetesAutoScalingWithDefaults() *KubernetesAutoScaling

NewKubernetesAutoScalingWithDefaults instantiates a new KubernetesAutoScaling 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

GetMinNodeCount

func (o *KubernetesAutoScaling) GetMinNodeCount() int32

GetMinNodeCount returns the MinNodeCount field if non-nil, zero value otherwise.

GetMinNodeCountOk

func (o *KubernetesAutoScaling) GetMinNodeCountOk() (*int32, bool)

GetMinNodeCountOk returns a tuple with the MinNodeCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMinNodeCount

func (o *KubernetesAutoScaling) SetMinNodeCount(v int32)

SetMinNodeCount sets MinNodeCount field to given value.

HasMinNodeCount

func (o *KubernetesAutoScaling) HasMinNodeCount() bool

HasMinNodeCount returns a boolean if a field has been set.

GetMaxNodeCount

func (o *KubernetesAutoScaling) GetMaxNodeCount() int32

GetMaxNodeCount returns the MaxNodeCount field if non-nil, zero value otherwise.

GetMaxNodeCountOk

func (o *KubernetesAutoScaling) GetMaxNodeCountOk() (*int32, bool)

GetMaxNodeCountOk returns a tuple with the MaxNodeCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMaxNodeCount

func (o *KubernetesAutoScaling) SetMaxNodeCount(v int32)

SetMaxNodeCount sets MaxNodeCount field to given value.

HasMaxNodeCount

func (o *KubernetesAutoScaling) HasMaxNodeCount() bool

HasMaxNodeCount returns a boolean if a field has been set.

IPFailover

Properties

Name
Type
Description
Notes

Ip

Pointer to string

[optional]

NicUuid

Pointer to string

[optional]

Methods

NewIPFailover

func NewIPFailover() *IPFailover

NewIPFailover instantiates a new IPFailover 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

NewIPFailoverWithDefaults

func NewIPFailoverWithDefaults() *IPFailover

NewIPFailoverWithDefaults instantiates a new IPFailover 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

GetIp

func (o *IPFailover) GetIp() string

GetIp returns the Ip field if non-nil, zero value otherwise.

GetIpOk

func (o *IPFailover) GetIpOk() (*string, bool)

GetIpOk returns a tuple with the Ip field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIp

func (o *IPFailover) SetIp(v string)

SetIp sets Ip field to given value.

HasIp

func (o *IPFailover) HasIp() bool

HasIp returns a boolean if a field has been set.

GetNicUuid

func (o *IPFailover) GetNicUuid() string

GetNicUuid returns the NicUuid field if non-nil, zero value otherwise.

GetNicUuidOk

func (o *IPFailover) GetNicUuidOk() (*string, bool)

GetNicUuidOk returns a tuple with the NicUuid field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNicUuid

func (o *IPFailover) SetNicUuid(v string)

SetNicUuid sets NicUuid field to given value.

HasNicUuid

func (o *IPFailover) HasNicUuid() bool

HasNicUuid returns a boolean if a field has been set.

Error

Properties

Name
Type
Description
Notes

HttpStatus

Pointer to int32

HTTP status code of the operation

[optional] [readonly]

Messages

Pointer to

[optional]

Methods

NewError

func NewError() *Error

NewError instantiates a new Error 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

NewErrorWithDefaults

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error 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

GetHttpStatus

func (o *Error) GetHttpStatus() int32

GetHttpStatus returns the HttpStatus field if non-nil, zero value otherwise.

GetHttpStatusOk

func (o *Error) GetHttpStatusOk() (*int32, bool)

GetHttpStatusOk returns a tuple with the HttpStatus field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHttpStatus

func (o *Error) SetHttpStatus(v int32)

SetHttpStatus sets HttpStatus field to given value.

HasHttpStatus

func (o *Error) HasHttpStatus() bool

HasHttpStatus returns a boolean if a field has been set.

GetMessages

func (o *Error) GetMessages() []ErrorMessage

GetMessages returns the Messages field if non-nil, zero value otherwise.

GetMessagesOk

func (o *Error) GetMessagesOk() (*[]ErrorMessage, bool)

GetMessagesOk returns a tuple with the Messages field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMessages

func (o *Error) SetMessages(v []ErrorMessage)

SetMessages sets Messages field to given value.

HasMessages

func (o *Error) HasMessages() bool

HasMessages returns a boolean if a field has been set.

GroupEntities

Properties

Name
Type
Description
Notes

Users

Pointer to

[optional]

Resources

Pointer to

[optional]

Methods

NewGroupEntities

func NewGroupEntities() *GroupEntities

NewGroupEntities instantiates a new GroupEntities 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

NewGroupEntitiesWithDefaults

func NewGroupEntitiesWithDefaults() *GroupEntities

NewGroupEntitiesWithDefaults instantiates a new GroupEntities 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

GetUsers

func (o *GroupEntities) GetUsers() GroupMembers

GetUsers returns the Users field if non-nil, zero value otherwise.

GetUsersOk

func (o *GroupEntities) GetUsersOk() (*GroupMembers, bool)

GetUsersOk returns a tuple with the Users field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUsers

func (o *GroupEntities) SetUsers(v GroupMembers)

SetUsers sets Users field to given value.

HasUsers

func (o *GroupEntities) HasUsers() bool

HasUsers returns a boolean if a field has been set.

GetResources

func (o *GroupEntities) GetResources() ResourceGroups

GetResources returns the Resources field if non-nil, zero value otherwise.

GetResourcesOk

func (o *GroupEntities) GetResourcesOk() (*ResourceGroups, bool)

GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetResources

func (o *GroupEntities) SetResources(v ResourceGroups)

SetResources sets Resources field to given value.

HasResources

func (o *GroupEntities) HasResources() bool

HasResources returns a boolean if a field has been set.

Contract

Properties

Name
Type
Description
Notes

Type

Pointer to

The type of the resource

[optional]

Properties

Methods

NewContract

func NewContract(properties ContractProperties, ) *Contract

NewContract instantiates a new Contract 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

NewContractWithDefaults

func NewContractWithDefaults() *Contract

NewContractWithDefaults instantiates a new Contract 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

GetType

func (o *Contract) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Contract) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Contract) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Contract) HasType() bool

HasType returns a boolean if a field has been set.

GetProperties

func (o *Contract) GetProperties() ContractProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *Contract) GetPropertiesOk() (*ContractProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *Contract) SetProperties(v ContractProperties)

SetProperties sets Properties field to given value.

LanEntities

Properties

Name
Type
Description
Notes

Nics

Pointer to

[optional]

Methods

NewLanEntities

func NewLanEntities() *LanEntities

NewLanEntities instantiates a new LanEntities 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

NewLanEntitiesWithDefaults

func NewLanEntitiesWithDefaults() *LanEntities

NewLanEntitiesWithDefaults instantiates a new LanEntities 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

GetNics

func (o *LanEntities) GetNics() LanNics

GetNics returns the Nics field if non-nil, zero value otherwise.

GetNicsOk

func (o *LanEntities) GetNicsOk() (*LanNics, bool)

GetNicsOk returns a tuple with the Nics field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNics

func (o *LanEntities) SetNics(v LanNics)

SetNics sets Nics field to given value.

HasNics

func (o *LanEntities) HasNics() bool

HasNics returns a boolean if a field has been set.

KubernetesClusterEntities

Properties

Name
Type
Description
Notes

Nodepools

Pointer to

[optional]

Methods

NewKubernetesClusterEntities

func NewKubernetesClusterEntities() *KubernetesClusterEntities

NewKubernetesClusterEntities instantiates a new KubernetesClusterEntities 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

NewKubernetesClusterEntitiesWithDefaults

func NewKubernetesClusterEntitiesWithDefaults() *KubernetesClusterEntities

NewKubernetesClusterEntitiesWithDefaults instantiates a new KubernetesClusterEntities 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

GetNodepools

func (o *KubernetesClusterEntities) GetNodepools() KubernetesNodePools

GetNodepools returns the Nodepools field if non-nil, zero value otherwise.

GetNodepoolsOk

func (o *KubernetesClusterEntities) GetNodepoolsOk() (*KubernetesNodePools, bool)

GetNodepoolsOk returns a tuple with the Nodepools field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNodepools

func (o *KubernetesClusterEntities) SetNodepools(v KubernetesNodePools)

SetNodepools sets Nodepools field to given value.

HasNodepools

func (o *KubernetesClusterEntities) HasNodepools() bool

HasNodepools returns a boolean if a field has been set.

BackupUnitProperties

Properties

Name
Type
Description
Notes

Methods

NewBackupUnitProperties

func NewBackupUnitProperties(name string, ) *BackupUnitProperties

NewBackupUnitProperties instantiates a new BackupUnitProperties 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

NewBackupUnitPropertiesWithDefaults

func NewBackupUnitPropertiesWithDefaults() *BackupUnitProperties

NewBackupUnitPropertiesWithDefaults instantiates a new BackupUnitProperties 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

GetName

func (o *BackupUnitProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *BackupUnitProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *BackupUnitProperties) SetName(v string)

SetName sets Name field to given value.

GetPassword

func (o *BackupUnitProperties) GetPassword() string

GetPassword returns the Password field if non-nil, zero value otherwise.

GetPasswordOk

func (o *BackupUnitProperties) GetPasswordOk() (*string, bool)

GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPassword

func (o *BackupUnitProperties) SetPassword(v string)

SetPassword sets Password field to given value.

HasPassword

func (o *BackupUnitProperties) HasPassword() bool

HasPassword returns a boolean if a field has been set.

GetEmail

func (o *BackupUnitProperties) GetEmail() string

GetEmail returns the Email field if non-nil, zero value otherwise.

GetEmailOk

func (o *BackupUnitProperties) GetEmailOk() (*string, bool)

GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEmail

func (o *BackupUnitProperties) SetEmail(v string)

SetEmail sets Email field to given value.

HasEmail

func (o *BackupUnitProperties) HasEmail() bool

HasEmail returns a boolean if a field has been set.

BackupUnits

Properties

Name
Type
Description
Notes

Methods

NewBackupUnits

func NewBackupUnits() *BackupUnits

NewBackupUnits instantiates a new BackupUnits 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

NewBackupUnitsWithDefaults

func NewBackupUnitsWithDefaults() *BackupUnits

NewBackupUnitsWithDefaults instantiates a new BackupUnits 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

GetId

func (o *BackupUnits) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *BackupUnits) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *BackupUnits) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *BackupUnits) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *BackupUnits) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *BackupUnits) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *BackupUnits) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *BackupUnits) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *BackupUnits) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *BackupUnits) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *BackupUnits) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *BackupUnits) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *BackupUnits) GetItems() []BackupUnit

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *BackupUnits) GetItemsOk() (*[]BackupUnit, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *BackupUnits) SetItems(v []BackupUnit)

SetItems sets Items field to given value.

HasItems

func (o *BackupUnits) HasItems() bool

HasItems returns a boolean if a field has been set.

DataCenterEntities

Properties

Name
Type
Description
Notes

Methods

NewDataCenterEntities

func NewDataCenterEntities() *DataCenterEntities

NewDataCenterEntities instantiates a new DataCenterEntities 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

NewDataCenterEntitiesWithDefaults

func NewDataCenterEntitiesWithDefaults() *DataCenterEntities

NewDataCenterEntitiesWithDefaults instantiates a new DataCenterEntities 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

GetServers

func (o *DataCenterEntities) GetServers() Servers

GetServers returns the Servers field if non-nil, zero value otherwise.

GetServersOk

func (o *DataCenterEntities) GetServersOk() (*Servers, bool)

GetServersOk returns a tuple with the Servers field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetServers

func (o *DataCenterEntities) SetServers(v Servers)

SetServers sets Servers field to given value.

HasServers

func (o *DataCenterEntities) HasServers() bool

HasServers returns a boolean if a field has been set.

GetVolumes

func (o *DataCenterEntities) GetVolumes() Volumes

GetVolumes returns the Volumes field if non-nil, zero value otherwise.

GetVolumesOk

func (o *DataCenterEntities) GetVolumesOk() (*Volumes, bool)

GetVolumesOk returns a tuple with the Volumes field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVolumes

func (o *DataCenterEntities) SetVolumes(v Volumes)

SetVolumes sets Volumes field to given value.

HasVolumes

func (o *DataCenterEntities) HasVolumes() bool

HasVolumes returns a boolean if a field has been set.

GetLoadbalancers

func (o *DataCenterEntities) GetLoadbalancers() Loadbalancers

GetLoadbalancers returns the Loadbalancers field if non-nil, zero value otherwise.

GetLoadbalancersOk

func (o *DataCenterEntities) GetLoadbalancersOk() (*Loadbalancers, bool)

GetLoadbalancersOk returns a tuple with the Loadbalancers field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLoadbalancers

func (o *DataCenterEntities) SetLoadbalancers(v Loadbalancers)

SetLoadbalancers sets Loadbalancers field to given value.

HasLoadbalancers

func (o *DataCenterEntities) HasLoadbalancers() bool

HasLoadbalancers returns a boolean if a field has been set.

GetLans

func (o *DataCenterEntities) GetLans() Lans

GetLans returns the Lans field if non-nil, zero value otherwise.

GetLansOk

func (o *DataCenterEntities) GetLansOk() (*Lans, bool)

GetLansOk returns a tuple with the Lans field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLans

func (o *DataCenterEntities) SetLans(v Lans)

SetLans sets Lans field to given value.

HasLans

func (o *DataCenterEntities) HasLans() bool

HasLans returns a boolean if a field has been set.

GroupShare

Properties

Name
Type
Description
Notes

Methods

NewGroupShare

func NewGroupShare(properties GroupShareProperties, ) *GroupShare

NewGroupShare instantiates a new GroupShare 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

NewGroupShareWithDefaults

func NewGroupShareWithDefaults() *GroupShare

NewGroupShareWithDefaults instantiates a new GroupShare 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

GetId

func (o *GroupShare) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *GroupShare) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *GroupShare) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *GroupShare) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *GroupShare) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *GroupShare) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *GroupShare) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *GroupShare) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *GroupShare) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *GroupShare) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *GroupShare) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *GroupShare) HasHref() bool

HasHref returns a boolean if a field has been set.

GetProperties

func (o *GroupShare) GetProperties() GroupShareProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *GroupShare) GetPropertiesOk() (*GroupShareProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *GroupShare) SetProperties(v GroupShareProperties)

SetProperties sets Properties field to given value.

Info

Properties

Name
Type
Description
Notes

Methods

NewInfo

func NewInfo() *Info

NewInfo instantiates a new Info 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

NewInfoWithDefaults

func NewInfoWithDefaults() *Info

NewInfoWithDefaults instantiates a new Info 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

GetHref

func (o *Info) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Info) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Info) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Info) HasHref() bool

HasHref returns a boolean if a field has been set.

GetName

func (o *Info) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *Info) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *Info) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *Info) HasName() bool

HasName returns a boolean if a field has been set.

GetVersion

func (o *Info) GetVersion() string

GetVersion returns the Version field if non-nil, zero value otherwise.

GetVersionOk

func (o *Info) GetVersionOk() (*string, bool)

GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVersion

func (o *Info) SetVersion(v string)

SetVersion sets Version field to given value.

HasVersion

func (o *Info) HasVersion() bool

HasVersion returns a boolean if a field has been set.

ConnectableDatacenter

Properties

Name
Type
Description
Notes

Methods

NewConnectableDatacenter

func NewConnectableDatacenter() *ConnectableDatacenter

NewConnectableDatacenter instantiates a new ConnectableDatacenter 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

NewConnectableDatacenterWithDefaults

func NewConnectableDatacenterWithDefaults() *ConnectableDatacenter

NewConnectableDatacenterWithDefaults instantiates a new ConnectableDatacenter 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

GetId

func (o *ConnectableDatacenter) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *ConnectableDatacenter) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *ConnectableDatacenter) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *ConnectableDatacenter) HasId() bool

HasId returns a boolean if a field has been set.

GetName

func (o *ConnectableDatacenter) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *ConnectableDatacenter) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *ConnectableDatacenter) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *ConnectableDatacenter) HasName() bool

HasName returns a boolean if a field has been set.

GetLocation

func (o *ConnectableDatacenter) GetLocation() string

GetLocation returns the Location field if non-nil, zero value otherwise.

GetLocationOk

func (o *ConnectableDatacenter) GetLocationOk() (*string, bool)

GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLocation

func (o *ConnectableDatacenter) SetLocation(v string)

SetLocation sets Location field to given value.

HasLocation

func (o *ConnectableDatacenter) HasLocation() bool

HasLocation returns a boolean if a field has been set.

KubernetesNodeProperties

Properties

Name
Type
Description
Notes

Methods

NewKubernetesNodeProperties

func NewKubernetesNodeProperties(name string, k8sVersion string, ) *KubernetesNodeProperties

NewKubernetesNodeProperties instantiates a new KubernetesNodeProperties 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

NewKubernetesNodePropertiesWithDefaults

func NewKubernetesNodePropertiesWithDefaults() *KubernetesNodeProperties

NewKubernetesNodePropertiesWithDefaults instantiates a new KubernetesNodeProperties 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

GetName

func (o *KubernetesNodeProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *KubernetesNodeProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *KubernetesNodeProperties) SetName(v string)

SetName sets Name field to given value.

GetPublicIP

func (o *KubernetesNodeProperties) GetPublicIP() string

GetPublicIP returns the PublicIP field if non-nil, zero value otherwise.

GetPublicIPOk

func (o *KubernetesNodeProperties) GetPublicIPOk() (*string, bool)

GetPublicIPOk returns a tuple with the PublicIP field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPublicIP

func (o *KubernetesNodeProperties) SetPublicIP(v string)

SetPublicIP sets PublicIP field to given value.

HasPublicIP

func (o *KubernetesNodeProperties) HasPublicIP() bool

HasPublicIP returns a boolean if a field has been set.

GetPrivateIP

func (o *KubernetesNodeProperties) GetPrivateIP() string

GetPrivateIP returns the PrivateIP field if non-nil, zero value otherwise.

GetPrivateIPOk

func (o *KubernetesNodeProperties) GetPrivateIPOk() (*string, bool)

GetPrivateIPOk returns a tuple with the PrivateIP field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPrivateIP

func (o *KubernetesNodeProperties) SetPrivateIP(v string)

SetPrivateIP sets PrivateIP field to given value.

HasPrivateIP

func (o *KubernetesNodeProperties) HasPrivateIP() bool

HasPrivateIP returns a boolean if a field has been set.

GetK8sVersion

func (o *KubernetesNodeProperties) GetK8sVersion() string

GetK8sVersion returns the K8sVersion field if non-nil, zero value otherwise.

GetK8sVersionOk

func (o *KubernetesNodeProperties) GetK8sVersionOk() (*string, bool)

GetK8sVersionOk returns a tuple with the K8sVersion field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sVersion

func (o *KubernetesNodeProperties) SetK8sVersion(v string)

SetK8sVersion sets K8sVersion field to given value.

Labels

Properties

Name
Type
Description
Notes

Methods

NewLabels

func NewLabels() *Labels

NewLabels instantiates a new Labels 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

NewLabelsWithDefaults

func NewLabelsWithDefaults() *Labels

NewLabelsWithDefaults instantiates a new Labels 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

GetId

func (o *Labels) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Labels) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Labels) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Labels) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Labels) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Labels) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Labels) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *Labels) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Labels) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Labels) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Labels) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Labels) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *Labels) GetItems() []Label

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *Labels) GetItemsOk() (*[]Label, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *Labels) SetItems(v []Label)

SetItems sets Items field to given value.

HasItems

func (o *Labels) HasItems() bool

HasItems returns a boolean if a field has been set.

Name

string

A name of that resource (only alphanumeric characters are acceptable)

Password

Pointer to string

the password associated to that resource

[optional]

Email

Pointer to string

The email associated with the backup unit. Bear in mind that this email does not be the same email as of the user.

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to string

The type of object that has been created

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []BackupUnit

Array of items in that collection

[optional] [readonly]

Servers

Pointer to Servers

[optional]

Volumes

Pointer to Volumes

[optional]

Loadbalancers

Pointer to Loadbalancers

[optional]

Lans

Pointer to Lans

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

resource as generic type

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Properties

GroupShareProperties

Href

Pointer to string

API entry point

[optional] [readonly]

Name

Pointer to string

Name of the API

[optional] [readonly]

Version

Pointer to string

Version of the API

[optional] [readonly]

Id

Pointer to string

[optional]

Name

Pointer to string

[optional]

Location

Pointer to string

[optional]

Name

string

A Kubernetes Node Name.

PublicIP

Pointer to string

A valid public IP.

[optional]

PrivateIP

Pointer to string

A valid private IP.

[optional]

K8sVersion

string

The kubernetes version in which a nodepool is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions.

Id

Pointer to string

Unique representation for Label as a collection of resource.

[optional] [readonly]

Type

Pointer to string

The type of resource within a collection

[optional] [readonly]

Href

Pointer to string

URL to the collection representation (absolute path)

[optional] [readonly]

Items

Pointer to []Label

Array of items in that collection

[optional] [readonly]

[]ErrorMessage
GroupMembers
ResourceGroups
Type
ContractProperties
LanNics
KubernetesNodePools

LoadbalancerProperties

Properties

Name
Type
Description
Notes

Name

Pointer to string

A name of that resource

[optional]

Ip

Pointer to string

IPv4 address of the loadbalancer. All attached NICs will inherit this IP. Leaving value null will assign IP automatically

[optional]

Dhcp

Pointer to bool

Indicates if the loadbalancer will reserve an IP using DHCP

[optional]

Methods

NewLoadbalancerProperties

func NewLoadbalancerProperties() *LoadbalancerProperties

NewLoadbalancerProperties instantiates a new LoadbalancerProperties 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

NewLoadbalancerPropertiesWithDefaults

func NewLoadbalancerPropertiesWithDefaults() *LoadbalancerProperties

NewLoadbalancerPropertiesWithDefaults instantiates a new LoadbalancerProperties 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

GetName

func (o *LoadbalancerProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *LoadbalancerProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *LoadbalancerProperties) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *LoadbalancerProperties) HasName() bool

HasName returns a boolean if a field has been set.

GetIp

func (o *LoadbalancerProperties) GetIp() string

GetIp returns the Ip field if non-nil, zero value otherwise.

GetIpOk

func (o *LoadbalancerProperties) GetIpOk() (*string, bool)

GetIpOk returns a tuple with the Ip field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIp

func (o *LoadbalancerProperties) SetIp(v string)

SetIp sets Ip field to given value.

HasIp

func (o *LoadbalancerProperties) HasIp() bool

HasIp returns a boolean if a field has been set.

GetDhcp

func (o *LoadbalancerProperties) GetDhcp() bool

GetDhcp returns the Dhcp field if non-nil, zero value otherwise.

GetDhcpOk

func (o *LoadbalancerProperties) GetDhcpOk() (*bool, bool)

GetDhcpOk returns a tuple with the Dhcp field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDhcp

func (o *LoadbalancerProperties) SetDhcp(v bool)

SetDhcp sets Dhcp field to given value.

HasDhcp

func (o *LoadbalancerProperties) HasDhcp() bool

HasDhcp returns a boolean if a field has been set.

ContractProperties

Properties

Name
Type
Description
Notes

ContractNumber

Pointer to int64

contract number

[optional] [readonly]

Owner

Pointer to string

owner of the contract

[optional] [readonly]

Status

Pointer to string

status of the contract

[optional] [readonly]

RegDomain

Pointer to string

Registration domain of the contract

[optional] [readonly]

ResourceLimits

Pointer to

[optional]

Methods

NewContractProperties

func NewContractProperties() *ContractProperties

NewContractProperties instantiates a new ContractProperties 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

NewContractPropertiesWithDefaults

func NewContractPropertiesWithDefaults() *ContractProperties

NewContractPropertiesWithDefaults instantiates a new ContractProperties 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

GetContractNumber

func (o *ContractProperties) GetContractNumber() int64

GetContractNumber returns the ContractNumber field if non-nil, zero value otherwise.

GetContractNumberOk

func (o *ContractProperties) GetContractNumberOk() (*int64, bool)

GetContractNumberOk returns a tuple with the ContractNumber field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetContractNumber

func (o *ContractProperties) SetContractNumber(v int64)

SetContractNumber sets ContractNumber field to given value.

HasContractNumber

func (o *ContractProperties) HasContractNumber() bool

HasContractNumber returns a boolean if a field has been set.

GetOwner

func (o *ContractProperties) GetOwner() string

GetOwner returns the Owner field if non-nil, zero value otherwise.

GetOwnerOk

func (o *ContractProperties) GetOwnerOk() (*string, bool)

GetOwnerOk returns a tuple with the Owner field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOwner

func (o *ContractProperties) SetOwner(v string)

SetOwner sets Owner field to given value.

HasOwner

func (o *ContractProperties) HasOwner() bool

HasOwner returns a boolean if a field has been set.

GetStatus

func (o *ContractProperties) GetStatus() string

GetStatus returns the Status field if non-nil, zero value otherwise.

GetStatusOk

func (o *ContractProperties) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStatus

func (o *ContractProperties) SetStatus(v string)

SetStatus sets Status field to given value.

HasStatus

func (o *ContractProperties) HasStatus() bool

HasStatus returns a boolean if a field has been set.

GetRegDomain

func (o *ContractProperties) GetRegDomain() string

GetRegDomain returns the RegDomain field if non-nil, zero value otherwise.

GetRegDomainOk

func (o *ContractProperties) GetRegDomainOk() (*string, bool)

GetRegDomainOk returns a tuple with the RegDomain field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRegDomain

func (o *ContractProperties) SetRegDomain(v string)

SetRegDomain sets RegDomain field to given value.

HasRegDomain

func (o *ContractProperties) HasRegDomain() bool

HasRegDomain returns a boolean if a field has been set.

GetResourceLimits

func (o *ContractProperties) GetResourceLimits() ResourceLimits

GetResourceLimits returns the ResourceLimits field if non-nil, zero value otherwise.

GetResourceLimitsOk

func (o *ContractProperties) GetResourceLimitsOk() (*ResourceLimits, bool)

GetResourceLimitsOk returns a tuple with the ResourceLimits field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetResourceLimits

func (o *ContractProperties) SetResourceLimits(v ResourceLimits)

SetResourceLimits sets ResourceLimits field to given value.

HasResourceLimits

func (o *ContractProperties) HasResourceLimits() bool

HasResourceLimits returns a boolean if a field has been set.

KubernetesNodePoolForPut

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier.

[optional] [readonly]

Type

Pointer to string

The type of object

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to

[optional]

Properties

Methods

NewKubernetesNodePoolForPut

func NewKubernetesNodePoolForPut(properties KubernetesNodePoolPropertiesForPut, ) *KubernetesNodePoolForPut

NewKubernetesNodePoolForPut instantiates a new KubernetesNodePoolForPut 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

NewKubernetesNodePoolForPutWithDefaults

func NewKubernetesNodePoolForPutWithDefaults() *KubernetesNodePoolForPut

NewKubernetesNodePoolForPutWithDefaults instantiates a new KubernetesNodePoolForPut 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

GetId

func (o *KubernetesNodePoolForPut) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesNodePoolForPut) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesNodePoolForPut) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesNodePoolForPut) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesNodePoolForPut) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesNodePoolForPut) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesNodePoolForPut) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesNodePoolForPut) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesNodePoolForPut) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesNodePoolForPut) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesNodePoolForPut) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesNodePoolForPut) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *KubernetesNodePoolForPut) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *KubernetesNodePoolForPut) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *KubernetesNodePoolForPut) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *KubernetesNodePoolForPut) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *KubernetesNodePoolForPut) GetProperties() KubernetesNodePoolPropertiesForPut

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *KubernetesNodePoolForPut) GetPropertiesOk() (*KubernetesNodePoolPropertiesForPut, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *KubernetesNodePoolForPut) SetProperties(v KubernetesNodePoolPropertiesForPut)

SetProperties sets Properties field to given value.

KubernetesConfig

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier.

[optional] [readonly]

Type

Pointer to string

The type of object

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Properties

Methods

NewKubernetesConfig

func NewKubernetesConfig(properties KubernetesConfigProperties, ) *KubernetesConfig

NewKubernetesConfig instantiates a new KubernetesConfig 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

NewKubernetesConfigWithDefaults

func NewKubernetesConfigWithDefaults() *KubernetesConfig

NewKubernetesConfigWithDefaults instantiates a new KubernetesConfig 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

GetId

func (o *KubernetesConfig) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesConfig) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesConfig) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesConfig) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesConfig) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesConfig) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesConfig) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesConfig) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesConfig) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesConfig) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesConfig) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesConfig) HasHref() bool

HasHref returns a boolean if a field has been set.

GetProperties

func (o *KubernetesConfig) GetProperties() KubernetesConfigProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *KubernetesConfig) GetPropertiesOk() (*KubernetesConfigProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *KubernetesConfig) SetProperties(v KubernetesConfigProperties)

SetProperties sets Properties field to given value.

Groups

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to

The type of the resource

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to

Array of items in that collection

[optional] [readonly]

Methods

NewGroups

func NewGroups() *Groups

NewGroups instantiates a new Groups 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

NewGroupsWithDefaults

func NewGroupsWithDefaults() *Groups

NewGroupsWithDefaults instantiates a new Groups 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

GetId

func (o *Groups) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Groups) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Groups) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Groups) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Groups) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Groups) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Groups) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Groups) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Groups) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Groups) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Groups) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Groups) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *Groups) GetItems() []Group

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *Groups) GetItemsOk() (*[]Group, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *Groups) SetItems(v []Group)

SetItems sets Items field to given value.

HasItems

func (o *Groups) HasItems() bool

HasItems returns a boolean if a field has been set.

IpBlockProperties

Properties

Name
Type
Description
Notes

Ips

Pointer to []string

A collection of IPs associated with the IP Block

[optional] [readonly]

Location

string

Location of that IP Block. Property cannot be modified after creation (disallowed in update requests)

Size

int32

The size of the IP block

Name

Pointer to string

A name of that resource

[optional]

IpConsumers

Pointer to

Read-Only attribute. Lists consumption detail of an individual ip

[optional] [readonly]

Methods

NewIpBlockProperties

func NewIpBlockProperties(location string, size int32, ) *IpBlockProperties

NewIpBlockProperties instantiates a new IpBlockProperties 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

NewIpBlockPropertiesWithDefaults

func NewIpBlockPropertiesWithDefaults() *IpBlockProperties

NewIpBlockPropertiesWithDefaults instantiates a new IpBlockProperties 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

GetIps

func (o *IpBlockProperties) GetIps() []string

GetIps returns the Ips field if non-nil, zero value otherwise.

GetIpsOk

func (o *IpBlockProperties) GetIpsOk() (*[]string, bool)

GetIpsOk returns a tuple with the Ips field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIps

func (o *IpBlockProperties) SetIps(v []string)

SetIps sets Ips field to given value.

HasIps

func (o *IpBlockProperties) HasIps() bool

HasIps returns a boolean if a field has been set.

GetLocation

func (o *IpBlockProperties) GetLocation() string

GetLocation returns the Location field if non-nil, zero value otherwise.

GetLocationOk

func (o *IpBlockProperties) GetLocationOk() (*string, bool)

GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLocation

func (o *IpBlockProperties) SetLocation(v string)

SetLocation sets Location field to given value.

GetSize

func (o *IpBlockProperties) GetSize() int32

GetSize returns the Size field if non-nil, zero value otherwise.

GetSizeOk

func (o *IpBlockProperties) GetSizeOk() (*int32, bool)

GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSize

func (o *IpBlockProperties) SetSize(v int32)

SetSize sets Size field to given value.

GetName

func (o *IpBlockProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *IpBlockProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *IpBlockProperties) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *IpBlockProperties) HasName() bool

HasName returns a boolean if a field has been set.

GetIpConsumers

func (o *IpBlockProperties) GetIpConsumers() []IpConsumer

GetIpConsumers returns the IpConsumers field if non-nil, zero value otherwise.

GetIpConsumersOk

func (o *IpBlockProperties) GetIpConsumersOk() (*[]IpConsumer, bool)

GetIpConsumersOk returns a tuple with the IpConsumers field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIpConsumers

func (o *IpBlockProperties) SetIpConsumers(v []IpConsumer)

SetIpConsumers sets IpConsumers field to given value.

HasIpConsumers

func (o *IpBlockProperties) HasIpConsumers() bool

HasIpConsumers returns a boolean if a field has been set.

Group

Properties

Name
Type
Description
Notes

Methods

NewGroup

func NewGroup(properties GroupProperties, ) *Group

NewGroup instantiates a new Group 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

NewGroupWithDefaults

func NewGroupWithDefaults() *Group

NewGroupWithDefaults instantiates a new Group 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

GetId

func (o *Group) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Group) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Group) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Group) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Group) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Group) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Group) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Group) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Group) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Group) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Group) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Group) HasHref() bool

HasHref returns a boolean if a field has been set.

GetProperties

func (o *Group) GetProperties() GroupProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *Group) GetPropertiesOk() (*GroupProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *Group) SetProperties(v GroupProperties)

SetProperties sets Properties field to given value.

GetEntities

func (o *Group) GetEntities() GroupEntities

GetEntities returns the Entities field if non-nil, zero value otherwise.

GetEntitiesOk

func (o *Group) GetEntitiesOk() (*GroupEntities, bool)

GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEntities

func (o *Group) SetEntities(v GroupEntities)

SetEntities sets Entities field to given value.

HasEntities

func (o *Group) HasEntities() bool

HasEntities returns a boolean if a field has been set.

BackupUnit

Properties

Name
Type
Description
Notes

Methods

NewBackupUnit

func NewBackupUnit(properties BackupUnitProperties, ) *BackupUnit

NewBackupUnit instantiates a new BackupUnit 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

NewBackupUnitWithDefaults

func NewBackupUnitWithDefaults() *BackupUnit

NewBackupUnitWithDefaults instantiates a new BackupUnit 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

GetId

func (o *BackupUnit) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *BackupUnit) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *BackupUnit) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *BackupUnit) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *BackupUnit) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *BackupUnit) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *BackupUnit) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *BackupUnit) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *BackupUnit) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *BackupUnit) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *BackupUnit) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *BackupUnit) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *BackupUnit) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *BackupUnit) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *BackupUnit) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *BackupUnit) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *BackupUnit) GetProperties() BackupUnitProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *BackupUnit) GetPropertiesOk() (*BackupUnitProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *BackupUnit) SetProperties(v BackupUnitProperties)

SetProperties sets Properties field to given value.

Images

Properties

Name
Type
Description
Notes

Methods

NewImages

func NewImages() *Images

NewImages instantiates a new Images 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

NewImagesWithDefaults

func NewImagesWithDefaults() *Images

NewImagesWithDefaults instantiates a new Images 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

GetId

func (o *Images) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Images) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Images) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Images) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Images) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Images) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Images) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Images) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Images) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Images) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Images) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Images) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *Images) GetItems() []Image

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *Images) GetItemsOk() (*[]Image, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *Images) SetItems(v []Image)

SetItems sets Items field to given value.

HasItems

func (o *Images) HasItems() bool

HasItems returns a boolean if a field has been set.

GroupMembers

Properties

Name
Type
Description
Notes

Methods

NewGroupMembers

func NewGroupMembers() *GroupMembers

NewGroupMembers instantiates a new GroupMembers 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

NewGroupMembersWithDefaults

func NewGroupMembersWithDefaults() *GroupMembers

NewGroupMembersWithDefaults instantiates a new GroupMembers 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

GetId

func (o *GroupMembers) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *GroupMembers) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *GroupMembers) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *GroupMembers) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *GroupMembers) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *GroupMembers) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *GroupMembers) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *GroupMembers) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *GroupMembers) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *GroupMembers) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *GroupMembers) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *GroupMembers) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *GroupMembers) GetItems() []User

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *GroupMembers) GetItemsOk() (*[]User, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *GroupMembers) SetItems(v []User)

SetItems sets Items field to given value.

HasItems

func (o *GroupMembers) HasItems() bool

HasItems returns a boolean if a field has been set.

GroupShares

Properties

Name
Type
Description
Notes

Methods

NewGroupShares

func NewGroupShares() *GroupShares

NewGroupShares instantiates a new GroupShares 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

NewGroupSharesWithDefaults

func NewGroupSharesWithDefaults() *GroupShares

NewGroupSharesWithDefaults instantiates a new GroupShares 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

GetId

func (o *GroupShares) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *GroupShares) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *GroupShares) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *GroupShares) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *GroupShares) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *GroupShares) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *GroupShares) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *GroupShares) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *GroupShares) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *GroupShares) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *GroupShares) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *GroupShares) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *GroupShares) GetItems() []GroupShare

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *GroupShares) GetItemsOk() (*[]GroupShare, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *GroupShares) SetItems(v []GroupShare)

SetItems sets Items field to given value.

HasItems

func (o *GroupShares) HasItems() bool

HasItems returns a boolean if a field has been set.

KubernetesClusterPropertiesForPut

Properties

Name
Type
Description
Notes

Methods

NewKubernetesClusterPropertiesForPut

func NewKubernetesClusterPropertiesForPut(name string, ) *KubernetesClusterPropertiesForPut

NewKubernetesClusterPropertiesForPut instantiates a new KubernetesClusterPropertiesForPut 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

NewKubernetesClusterPropertiesForPutWithDefaults

func NewKubernetesClusterPropertiesForPutWithDefaults() *KubernetesClusterPropertiesForPut

NewKubernetesClusterPropertiesForPutWithDefaults instantiates a new KubernetesClusterPropertiesForPut 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

GetName

func (o *KubernetesClusterPropertiesForPut) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *KubernetesClusterPropertiesForPut) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *KubernetesClusterPropertiesForPut) SetName(v string)

SetName sets Name field to given value.

GetK8sVersion

func (o *KubernetesClusterPropertiesForPut) GetK8sVersion() string

GetK8sVersion returns the K8sVersion field if non-nil, zero value otherwise.

GetK8sVersionOk

func (o *KubernetesClusterPropertiesForPut) GetK8sVersionOk() (*string, bool)

GetK8sVersionOk returns a tuple with the K8sVersion field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sVersion

func (o *KubernetesClusterPropertiesForPut) SetK8sVersion(v string)

SetK8sVersion sets K8sVersion field to given value.

HasK8sVersion

func (o *KubernetesClusterPropertiesForPut) HasK8sVersion() bool

HasK8sVersion returns a boolean if a field has been set.

GetMaintenanceWindow

func (o *KubernetesClusterPropertiesForPut) GetMaintenanceWindow() KubernetesMaintenanceWindow

GetMaintenanceWindow returns the MaintenanceWindow field if non-nil, zero value otherwise.

GetMaintenanceWindowOk

func (o *KubernetesClusterPropertiesForPut) GetMaintenanceWindowOk() (*KubernetesMaintenanceWindow, bool)

GetMaintenanceWindowOk returns a tuple with the MaintenanceWindow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMaintenanceWindow

func (o *KubernetesClusterPropertiesForPut) SetMaintenanceWindow(v KubernetesMaintenanceWindow)

SetMaintenanceWindow sets MaintenanceWindow field to given value.

HasMaintenanceWindow

func (o *KubernetesClusterPropertiesForPut) HasMaintenanceWindow() bool

HasMaintenanceWindow returns a boolean if a field has been set.

GetApiSubnetAllowList

func (o *KubernetesClusterPropertiesForPut) GetApiSubnetAllowList() []string

GetApiSubnetAllowList returns the ApiSubnetAllowList field if non-nil, zero value otherwise.

GetApiSubnetAllowListOk

func (o *KubernetesClusterPropertiesForPut) GetApiSubnetAllowListOk() (*[]string, bool)

GetApiSubnetAllowListOk returns a tuple with the ApiSubnetAllowList field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetApiSubnetAllowList

func (o *KubernetesClusterPropertiesForPut) SetApiSubnetAllowList(v []string)

SetApiSubnetAllowList sets ApiSubnetAllowList field to given value.

HasApiSubnetAllowList

func (o *KubernetesClusterPropertiesForPut) HasApiSubnetAllowList() bool

HasApiSubnetAllowList returns a boolean if a field has been set.

GetS3Buckets

func (o *KubernetesClusterPropertiesForPut) GetS3Buckets() []S3Bucket

GetS3Buckets returns the S3Buckets field if non-nil, zero value otherwise.

GetS3BucketsOk

func (o *KubernetesClusterPropertiesForPut) GetS3BucketsOk() (*[]S3Bucket, bool)

GetS3BucketsOk returns a tuple with the S3Buckets field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetS3Buckets

func (o *KubernetesClusterPropertiesForPut) SetS3Buckets(v []S3Bucket)

SetS3Buckets sets S3Buckets field to given value.

HasS3Buckets

func (o *KubernetesClusterPropertiesForPut) HasS3Buckets() bool

HasS3Buckets returns a boolean if a field has been set.

KubernetesClusters

Properties

Name
Type
Description
Notes

Methods

NewKubernetesClusters

func NewKubernetesClusters() *KubernetesClusters

NewKubernetesClusters instantiates a new KubernetesClusters 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

NewKubernetesClustersWithDefaults

func NewKubernetesClustersWithDefaults() *KubernetesClusters

NewKubernetesClustersWithDefaults instantiates a new KubernetesClusters 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

GetId

func (o *KubernetesClusters) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesClusters) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesClusters) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesClusters) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesClusters) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesClusters) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesClusters) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesClusters) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesClusters) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesClusters) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesClusters) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesClusters) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *KubernetesClusters) GetItems() []KubernetesCluster

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *KubernetesClusters) GetItemsOk() (*[]KubernetesCluster, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *KubernetesClusters) SetItems(v []KubernetesCluster)

SetItems sets Items field to given value.

HasItems

func (o *KubernetesClusters) HasItems() bool

HasItems returns a boolean if a field has been set.

FirewallRule

Properties

Name
Type
Description
Notes

Methods

NewFirewallRule

func NewFirewallRule(properties FirewallruleProperties, ) *FirewallRule

NewFirewallRule instantiates a new FirewallRule 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

NewFirewallRuleWithDefaults

func NewFirewallRuleWithDefaults() *FirewallRule

NewFirewallRuleWithDefaults instantiates a new FirewallRule 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

GetId

func (o *FirewallRule) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *FirewallRule) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *FirewallRule) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *FirewallRule) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *FirewallRule) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *FirewallRule) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *FirewallRule) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *FirewallRule) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *FirewallRule) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *FirewallRule) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *FirewallRule) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *FirewallRule) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *FirewallRule) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *FirewallRule) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *FirewallRule) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *FirewallRule) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *FirewallRule) GetProperties() FirewallruleProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *FirewallRule) GetPropertiesOk() (*FirewallruleProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *FirewallRule) SetProperties(v FirewallruleProperties)

SetProperties sets Properties field to given value.

KubernetesNode

Properties

Name
Type
Description
Notes

Methods

NewKubernetesNode

func NewKubernetesNode(properties KubernetesNodeProperties, ) *KubernetesNode

NewKubernetesNode instantiates a new KubernetesNode 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

NewKubernetesNodeWithDefaults

func NewKubernetesNodeWithDefaults() *KubernetesNode

NewKubernetesNodeWithDefaults instantiates a new KubernetesNode 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

GetId

func (o *KubernetesNode) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesNode) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesNode) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesNode) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesNode) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesNode) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesNode) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesNode) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesNode) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesNode) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesNode) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesNode) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *KubernetesNode) GetMetadata() KubernetesNodeMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *KubernetesNode) GetMetadataOk() (*KubernetesNodeMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *KubernetesNode) SetMetadata(v KubernetesNodeMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *KubernetesNode) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *KubernetesNode) GetProperties() KubernetesNodeProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *KubernetesNode) GetPropertiesOk() (*KubernetesNodeProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *KubernetesNode) SetProperties(v KubernetesNodeProperties)

SetProperties sets Properties field to given value.

KubernetesNodes

Properties

Name
Type
Description
Notes

Methods

NewKubernetesNodes

func NewKubernetesNodes() *KubernetesNodes

NewKubernetesNodes instantiates a new KubernetesNodes 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

NewKubernetesNodesWithDefaults

func NewKubernetesNodesWithDefaults() *KubernetesNodes

NewKubernetesNodesWithDefaults instantiates a new KubernetesNodes 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

GetId

func (o *KubernetesNodes) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesNodes) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesNodes) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesNodes) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesNodes) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesNodes) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesNodes) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesNodes) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesNodes) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesNodes) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesNodes) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesNodes) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *KubernetesNodes) GetItems() []KubernetesNode

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *KubernetesNodes) GetItemsOk() (*[]KubernetesNode, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *KubernetesNodes) SetItems(v []KubernetesNode)

SetItems sets Items field to given value.

HasItems

func (o *KubernetesNodes) HasItems() bool

HasItems returns a boolean if a field has been set.

LabelResource

Properties

Name
Type
Description
Notes

Methods

NewLabelResource

func NewLabelResource(properties LabelResourceProperties, ) *LabelResource

NewLabelResource instantiates a new LabelResource 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

NewLabelResourceWithDefaults

func NewLabelResourceWithDefaults() *LabelResource

NewLabelResourceWithDefaults instantiates a new LabelResource 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

GetId

func (o *LabelResource) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *LabelResource) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *LabelResource) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *LabelResource) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *LabelResource) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *LabelResource) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *LabelResource) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *LabelResource) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *LabelResource) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *LabelResource) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *LabelResource) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *LabelResource) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *LabelResource) GetMetadata() NoStateMetaData

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *LabelResource) GetMetadataOk() (*NoStateMetaData, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *LabelResource) SetMetadata(v NoStateMetaData)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *LabelResource) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *LabelResource) GetProperties() LabelResourceProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *LabelResource) GetPropertiesOk() (*LabelResourceProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *LabelResource) SetProperties(v LabelResourceProperties)

SetProperties sets Properties field to given value.

LabelProperties

Properties

Name
Type
Description
Notes

Methods

NewLabelProperties

func NewLabelProperties() *LabelProperties

NewLabelProperties instantiates a new LabelProperties 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

NewLabelPropertiesWithDefaults

func NewLabelPropertiesWithDefaults() *LabelProperties

NewLabelPropertiesWithDefaults instantiates a new LabelProperties 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

GetKey

func (o *LabelProperties) GetKey() string

GetKey returns the Key field if non-nil, zero value otherwise.

GetKeyOk

func (o *LabelProperties) GetKeyOk() (*string, bool)

GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetKey

func (o *LabelProperties) SetKey(v string)

SetKey sets Key field to given value.

HasKey

func (o *LabelProperties) HasKey() bool

HasKey returns a boolean if a field has been set.

GetValue

func (o *LabelProperties) GetValue() string

GetValue returns the Value field if non-nil, zero value otherwise.

GetValueOk

func (o *LabelProperties) GetValueOk() (*string, bool)

GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetValue

func (o *LabelProperties) SetValue(v string)

SetValue sets Value field to given value.

HasValue

func (o *LabelProperties) HasValue() bool

HasValue returns a boolean if a field has been set.

GetResourceId

func (o *LabelProperties) GetResourceId() string

GetResourceId returns the ResourceId field if non-nil, zero value otherwise.

GetResourceIdOk

func (o *LabelProperties) GetResourceIdOk() (*string, bool)

GetResourceIdOk returns a tuple with the ResourceId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetResourceId

func (o *LabelProperties) SetResourceId(v string)

SetResourceId sets ResourceId field to given value.

HasResourceId

func (o *LabelProperties) HasResourceId() bool

HasResourceId returns a boolean if a field has been set.

GetResourceType

func (o *LabelProperties) GetResourceType() string

GetResourceType returns the ResourceType field if non-nil, zero value otherwise.

GetResourceTypeOk

func (o *LabelProperties) GetResourceTypeOk() (*string, bool)

GetResourceTypeOk returns a tuple with the ResourceType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetResourceType

func (o *LabelProperties) SetResourceType(v string)

SetResourceType sets ResourceType field to given value.

HasResourceType

func (o *LabelProperties) HasResourceType() bool

HasResourceType returns a boolean if a field has been set.

GetResourceHref

func (o *LabelProperties) GetResourceHref() string

GetResourceHref returns the ResourceHref field if non-nil, zero value otherwise.

GetResourceHrefOk

func (o *LabelProperties) GetResourceHrefOk() (*string, bool)

GetResourceHrefOk returns a tuple with the ResourceHref field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetResourceHref

func (o *LabelProperties) SetResourceHref(v string)

SetResourceHref sets ResourceHref field to given value.

HasResourceHref

func (o *LabelProperties) HasResourceHref() bool

HasResourceHref returns a boolean if a field has been set.

KubernetesNodePools

Properties

Name
Type
Description
Notes

Methods

NewKubernetesNodePools

func NewKubernetesNodePools() *KubernetesNodePools

NewKubernetesNodePools instantiates a new KubernetesNodePools 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

NewKubernetesNodePoolsWithDefaults

func NewKubernetesNodePoolsWithDefaults() *KubernetesNodePools

NewKubernetesNodePoolsWithDefaults instantiates a new KubernetesNodePools 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

GetId

func (o *KubernetesNodePools) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesNodePools) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesNodePools) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesNodePools) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesNodePools) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesNodePools) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesNodePools) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesNodePools) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesNodePools) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesNodePools) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesNodePools) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesNodePools) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *KubernetesNodePools) GetItems() []KubernetesNodePool

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *KubernetesNodePools) GetItemsOk() (*[]KubernetesNodePool, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *KubernetesNodePools) SetItems(v []KubernetesNodePool)

SetItems sets Items field to given value.

HasItems

func (o *KubernetesNodePools) HasItems() bool

HasItems returns a boolean if a field has been set.

GroupUsers

Properties

Name
Type
Description
Notes

Methods

NewGroupUsers

func NewGroupUsers() *GroupUsers

NewGroupUsers instantiates a new GroupUsers 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

NewGroupUsersWithDefaults

func NewGroupUsersWithDefaults() *GroupUsers

NewGroupUsersWithDefaults instantiates a new GroupUsers 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

GetId

func (o *GroupUsers) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *GroupUsers) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *GroupUsers) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *GroupUsers) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *GroupUsers) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *GroupUsers) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *GroupUsers) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *GroupUsers) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *GroupUsers) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *GroupUsers) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *GroupUsers) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *GroupUsers) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *GroupUsers) GetItems() []Group

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *GroupUsers) GetItemsOk() (*[]Group, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *GroupUsers) SetItems(v []Group)

SetItems sets Items field to given value.

HasItems

func (o *GroupUsers) HasItems() bool

HasItems returns a boolean if a field has been set.

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of the resource

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Properties

GroupProperties

Entities

Pointer to GroupEntities

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to string

The type of object that has been created

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

BackupUnitProperties

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []Image

Array of items in that collection

[optional] [readonly]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []User

Array of items in that collection

[optional] [readonly]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

Share representing groups and resource relationship

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []GroupShare

Array of items in that collection

[optional] [readonly]

Name

string

A Kubernetes Cluster Name. Valid Kubernetes Cluster name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

K8sVersion

Pointer to string

The kubernetes version in which a cluster is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions.

[optional]

MaintenanceWindow

Pointer to KubernetesMaintenanceWindow

[optional]

ApiSubnetAllowList

Pointer to []string

Access to the K8s API server is restricted to these CIDRs. Cluster-internal traffic is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6.

[optional]

S3Buckets

Pointer to []S3Bucket

List of S3 bucket configured for K8s usage. For now it contains only one S3 bucket used to store K8s API audit logs

[optional]

Id

Pointer to string

Unique representation for Kubernetes Cluster as a collection on a resource.

[optional] [readonly]

Type

Pointer to string

The type of object that has been created

[optional] [readonly]

Href

Pointer to string

URL to the collection representation (absolute path)

[optional] [readonly]

Items

Pointer to []KubernetesCluster

Array of items in that collection

[optional] [readonly]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

FirewallruleProperties

Id

Pointer to string

The resource's unique identifier.

[optional] [readonly]

Type

Pointer to string

The type of object

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to KubernetesNodeMetadata

[optional]

Properties

KubernetesNodeProperties

Id

Pointer to string

Unique representation for Kubernetes Node Pool as a collection on a resource.

[optional] [readonly]

Type

Pointer to string

The type of resource within a collection

[optional] [readonly]

Href

Pointer to string

URL to the collection representation (absolute path)

[optional] [readonly]

Items

Pointer to []KubernetesNode

Array of items in that collection

[optional] [readonly]

Id

Pointer to string

Label on a resource is identified using label key.

[optional] [readonly]

Type

Pointer to string

The type of object that has been created

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to NoStateMetaData

[optional]

Properties

LabelResourceProperties

Key

Pointer to string

A Label Key

[optional]

Value

Pointer to string

A Label Value

[optional]

ResourceId

Pointer to string

The id of the resource

[optional]

ResourceType

Pointer to string

The type of the resource on which the label is applied.

[optional]

ResourceHref

Pointer to string

URL to the Resource (absolute path) on which the label is applied.

[optional]

Id

Pointer to string

Unique representation for Kubernetes Node Pool as a collection on a resource.

[optional] [readonly]

Type

Pointer to string

The type of object that has been created

[optional] [readonly]

Href

Pointer to string

URL to the collection representation (absolute path)

[optional] [readonly]

Items

Pointer to []KubernetesNodePool

Array of items in that collection

[optional] [readonly]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of the resource

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []Group

Array of items in that collection

[optional] [readonly]

ResourceLimits
DatacenterElementMetadata
KubernetesNodePoolPropertiesForPut
KubernetesConfigProperties
Type
[]Group
[]IpConsumer

DatacenterProperties

Properties

Name
Type
Description
Notes

Name

Pointer to string

A name of that resource

[optional]

Description

Pointer to string

A description for the datacenter, e.g. staging, production

[optional]

Location

string

The physical location where the datacenter will be created. This will be where all of your servers live. Property cannot be modified after datacenter creation (disallowed in update requests)

Version

Pointer to int32

The version of that Data Center. Gets incremented with every change

[optional] [readonly]

Features

Pointer to []string

List of features supported by the location this data center is part of

[optional] [readonly]

SecAuthProtection

Pointer to bool

Boolean value representing if the data center requires extra protection e.g. two factor protection

[optional]

Methods

NewDatacenterProperties

func NewDatacenterProperties(location string, ) *DatacenterProperties

NewDatacenterProperties instantiates a new DatacenterProperties 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

NewDatacenterPropertiesWithDefaults

func NewDatacenterPropertiesWithDefaults() *DatacenterProperties

NewDatacenterPropertiesWithDefaults instantiates a new DatacenterProperties 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

GetName

func (o *DatacenterProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *DatacenterProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *DatacenterProperties) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *DatacenterProperties) HasName() bool

HasName returns a boolean if a field has been set.

GetDescription

func (o *DatacenterProperties) GetDescription() string

GetDescription returns the Description field if non-nil, zero value otherwise.

GetDescriptionOk

func (o *DatacenterProperties) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDescription

func (o *DatacenterProperties) SetDescription(v string)

SetDescription sets Description field to given value.

HasDescription

func (o *DatacenterProperties) HasDescription() bool

HasDescription returns a boolean if a field has been set.

GetLocation

func (o *DatacenterProperties) GetLocation() string

GetLocation returns the Location field if non-nil, zero value otherwise.

GetLocationOk

func (o *DatacenterProperties) GetLocationOk() (*string, bool)

GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLocation

func (o *DatacenterProperties) SetLocation(v string)

SetLocation sets Location field to given value.

GetVersion

func (o *DatacenterProperties) GetVersion() int32

GetVersion returns the Version field if non-nil, zero value otherwise.

GetVersionOk

func (o *DatacenterProperties) GetVersionOk() (*int32, bool)

GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVersion

func (o *DatacenterProperties) SetVersion(v int32)

SetVersion sets Version field to given value.

HasVersion

func (o *DatacenterProperties) HasVersion() bool

HasVersion returns a boolean if a field has been set.

GetFeatures

func (o *DatacenterProperties) GetFeatures() []string

GetFeatures returns the Features field if non-nil, zero value otherwise.

GetFeaturesOk

func (o *DatacenterProperties) GetFeaturesOk() (*[]string, bool)

GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFeatures

func (o *DatacenterProperties) SetFeatures(v []string)

SetFeatures sets Features field to given value.

HasFeatures

func (o *DatacenterProperties) HasFeatures() bool

HasFeatures returns a boolean if a field has been set.

GetSecAuthProtection

func (o *DatacenterProperties) GetSecAuthProtection() bool

GetSecAuthProtection returns the SecAuthProtection field if non-nil, zero value otherwise.

GetSecAuthProtectionOk

func (o *DatacenterProperties) GetSecAuthProtectionOk() (*bool, bool)

GetSecAuthProtectionOk returns a tuple with the SecAuthProtection field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSecAuthProtection

func (o *DatacenterProperties) SetSecAuthProtection(v bool)

SetSecAuthProtection sets SecAuthProtection field to given value.

HasSecAuthProtection

func (o *DatacenterProperties) HasSecAuthProtection() bool

HasSecAuthProtection returns a boolean if a field has been set.

IpBlock

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to

[optional]

Properties

Methods

NewIpBlock

func NewIpBlock(properties IpBlockProperties, ) *IpBlock

NewIpBlock instantiates a new IpBlock 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

NewIpBlockWithDefaults

func NewIpBlockWithDefaults() *IpBlock

NewIpBlockWithDefaults instantiates a new IpBlock 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

GetId

func (o *IpBlock) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *IpBlock) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *IpBlock) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *IpBlock) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *IpBlock) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *IpBlock) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *IpBlock) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *IpBlock) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *IpBlock) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *IpBlock) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *IpBlock) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *IpBlock) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *IpBlock) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *IpBlock) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *IpBlock) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *IpBlock) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *IpBlock) GetProperties() IpBlockProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *IpBlock) GetPropertiesOk() (*IpBlockProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *IpBlock) SetProperties(v IpBlockProperties)

SetProperties sets Properties field to given value.

KubernetesClusterPropertiesForPost

Properties

Name
Type
Description
Notes

Name

string

A Kubernetes Cluster Name. Valid Kubernetes Cluster name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

K8sVersion

Pointer to string

The kubernetes version in which a cluster is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions.

[optional]

MaintenanceWindow

Pointer to

[optional]

ApiSubnetAllowList

Pointer to []string

Access to the K8s API server is restricted to these CIDRs. Cluster-internal traffic is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6.

[optional]

S3Buckets

Pointer to

List of S3 bucket configured for K8s usage. For now it contains only one S3 bucket used to store K8s API audit logs

[optional]

Methods

NewKubernetesClusterPropertiesForPost

func NewKubernetesClusterPropertiesForPost(name string, ) *KubernetesClusterPropertiesForPost

NewKubernetesClusterPropertiesForPost instantiates a new KubernetesClusterPropertiesForPost 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

NewKubernetesClusterPropertiesForPostWithDefaults

func NewKubernetesClusterPropertiesForPostWithDefaults() *KubernetesClusterPropertiesForPost

NewKubernetesClusterPropertiesForPostWithDefaults instantiates a new KubernetesClusterPropertiesForPost 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

GetName

func (o *KubernetesClusterPropertiesForPost) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *KubernetesClusterPropertiesForPost) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *KubernetesClusterPropertiesForPost) SetName(v string)

SetName sets Name field to given value.

GetK8sVersion

func (o *KubernetesClusterPropertiesForPost) GetK8sVersion() string

GetK8sVersion returns the K8sVersion field if non-nil, zero value otherwise.

GetK8sVersionOk

func (o *KubernetesClusterPropertiesForPost) GetK8sVersionOk() (*string, bool)

GetK8sVersionOk returns a tuple with the K8sVersion field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sVersion

func (o *KubernetesClusterPropertiesForPost) SetK8sVersion(v string)

SetK8sVersion sets K8sVersion field to given value.

HasK8sVersion

func (o *KubernetesClusterPropertiesForPost) HasK8sVersion() bool

HasK8sVersion returns a boolean if a field has been set.

GetMaintenanceWindow

func (o *KubernetesClusterPropertiesForPost) GetMaintenanceWindow() KubernetesMaintenanceWindow

GetMaintenanceWindow returns the MaintenanceWindow field if non-nil, zero value otherwise.

GetMaintenanceWindowOk

func (o *KubernetesClusterPropertiesForPost) GetMaintenanceWindowOk() (*KubernetesMaintenanceWindow, bool)

GetMaintenanceWindowOk returns a tuple with the MaintenanceWindow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMaintenanceWindow

func (o *KubernetesClusterPropertiesForPost) SetMaintenanceWindow(v KubernetesMaintenanceWindow)

SetMaintenanceWindow sets MaintenanceWindow field to given value.

HasMaintenanceWindow

func (o *KubernetesClusterPropertiesForPost) HasMaintenanceWindow() bool

HasMaintenanceWindow returns a boolean if a field has been set.

GetApiSubnetAllowList

func (o *KubernetesClusterPropertiesForPost) GetApiSubnetAllowList() []string

GetApiSubnetAllowList returns the ApiSubnetAllowList field if non-nil, zero value otherwise.

GetApiSubnetAllowListOk

func (o *KubernetesClusterPropertiesForPost) GetApiSubnetAllowListOk() (*[]string, bool)

GetApiSubnetAllowListOk returns a tuple with the ApiSubnetAllowList field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetApiSubnetAllowList

func (o *KubernetesClusterPropertiesForPost) SetApiSubnetAllowList(v []string)

SetApiSubnetAllowList sets ApiSubnetAllowList field to given value.

HasApiSubnetAllowList

func (o *KubernetesClusterPropertiesForPost) HasApiSubnetAllowList() bool

HasApiSubnetAllowList returns a boolean if a field has been set.

GetS3Buckets

func (o *KubernetesClusterPropertiesForPost) GetS3Buckets() []S3Bucket

GetS3Buckets returns the S3Buckets field if non-nil, zero value otherwise.

GetS3BucketsOk

func (o *KubernetesClusterPropertiesForPost) GetS3BucketsOk() (*[]S3Bucket, bool)

GetS3BucketsOk returns a tuple with the S3Buckets field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetS3Buckets

func (o *KubernetesClusterPropertiesForPost) SetS3Buckets(v []S3Bucket)

SetS3Buckets sets S3Buckets field to given value.

HasS3Buckets

func (o *KubernetesClusterPropertiesForPost) HasS3Buckets() bool

HasS3Buckets returns a boolean if a field has been set.

Label

Properties

Name
Type
Description
Notes

Id

Pointer to string

Label is identified using standard URN.

[optional] [readonly]

Type

Pointer to string

The type of object that has been created

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to

[optional]

Properties

Methods

NewLabel

func NewLabel(properties LabelProperties, ) *Label

NewLabel instantiates a new Label 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

NewLabelWithDefaults

func NewLabelWithDefaults() *Label

NewLabelWithDefaults instantiates a new Label 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

GetId

func (o *Label) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Label) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Label) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Label) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Label) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Label) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Label) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *Label) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Label) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Label) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Label) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Label) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *Label) GetMetadata() NoStateMetaData

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *Label) GetMetadataOk() (*NoStateMetaData, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *Label) SetMetadata(v NoStateMetaData)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *Label) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *Label) GetProperties() LabelProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *Label) GetPropertiesOk() (*LabelProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *Label) SetProperties(v LabelProperties)

SetProperties sets Properties field to given value.

KubernetesNodePool

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier.

[optional] [readonly]

Type

Pointer to string

The type of object

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to

[optional]

Properties

Methods

NewKubernetesNodePool

func NewKubernetesNodePool(properties KubernetesNodePoolProperties, ) *KubernetesNodePool

NewKubernetesNodePool instantiates a new KubernetesNodePool 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

NewKubernetesNodePoolWithDefaults

func NewKubernetesNodePoolWithDefaults() *KubernetesNodePool

NewKubernetesNodePoolWithDefaults instantiates a new KubernetesNodePool 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

GetId

func (o *KubernetesNodePool) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesNodePool) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesNodePool) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesNodePool) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesNodePool) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesNodePool) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesNodePool) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesNodePool) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesNodePool) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesNodePool) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesNodePool) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesNodePool) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *KubernetesNodePool) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *KubernetesNodePool) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *KubernetesNodePool) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *KubernetesNodePool) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *KubernetesNodePool) GetProperties() KubernetesNodePoolProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *KubernetesNodePool) GetPropertiesOk() (*KubernetesNodePoolProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *KubernetesNodePool) SetProperties(v KubernetesNodePoolProperties)

SetProperties sets Properties field to given value.

KubernetesNodePoolForPost

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier.

[optional] [readonly]

Type

Pointer to string

The type of object

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to

[optional]

Properties

Methods

NewKubernetesNodePoolForPost

func NewKubernetesNodePoolForPost(properties KubernetesNodePoolPropertiesForPost, ) *KubernetesNodePoolForPost

NewKubernetesNodePoolForPost instantiates a new KubernetesNodePoolForPost 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

NewKubernetesNodePoolForPostWithDefaults

func NewKubernetesNodePoolForPostWithDefaults() *KubernetesNodePoolForPost

NewKubernetesNodePoolForPostWithDefaults instantiates a new KubernetesNodePoolForPost 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

GetId

func (o *KubernetesNodePoolForPost) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesNodePoolForPost) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesNodePoolForPost) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesNodePoolForPost) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesNodePoolForPost) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesNodePoolForPost) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesNodePoolForPost) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesNodePoolForPost) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesNodePoolForPost) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesNodePoolForPost) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesNodePoolForPost) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesNodePoolForPost) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *KubernetesNodePoolForPost) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *KubernetesNodePoolForPost) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *KubernetesNodePoolForPost) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *KubernetesNodePoolForPost) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *KubernetesNodePoolForPost) GetProperties() KubernetesNodePoolPropertiesForPost

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *KubernetesNodePoolForPost) GetPropertiesOk() (*KubernetesNodePoolPropertiesForPost, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *KubernetesNodePoolForPost) SetProperties(v KubernetesNodePoolPropertiesForPost)

SetProperties sets Properties field to given value.

AttachedVolumes

Properties

Name
Type
Description
Notes

Methods

NewAttachedVolumes

func NewAttachedVolumes() *AttachedVolumes

NewAttachedVolumes instantiates a new AttachedVolumes 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

NewAttachedVolumesWithDefaults

func NewAttachedVolumesWithDefaults() *AttachedVolumes

NewAttachedVolumesWithDefaults instantiates a new AttachedVolumes 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

GetId

func (o *AttachedVolumes) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *AttachedVolumes) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *AttachedVolumes) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *AttachedVolumes) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *AttachedVolumes) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *AttachedVolumes) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *AttachedVolumes) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *AttachedVolumes) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *AttachedVolumes) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *AttachedVolumes) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *AttachedVolumes) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *AttachedVolumes) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *AttachedVolumes) GetItems() []Volume

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *AttachedVolumes) GetItemsOk() (*[]Volume, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *AttachedVolumes) SetItems(v []Volume)

SetItems sets Items field to given value.

HasItems

func (o *AttachedVolumes) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *AttachedVolumes) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *AttachedVolumes) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *AttachedVolumes) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *AttachedVolumes) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *AttachedVolumes) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *AttachedVolumes) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *AttachedVolumes) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *AttachedVolumes) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *AttachedVolumes) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *AttachedVolumes) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *AttachedVolumes) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *AttachedVolumes) HasLinks() bool

HasLinks returns a boolean if a field has been set.

BalancedNics

Properties

Name
Type
Description
Notes

Methods

NewBalancedNics

func NewBalancedNics() *BalancedNics

NewBalancedNics instantiates a new BalancedNics 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

NewBalancedNicsWithDefaults

func NewBalancedNicsWithDefaults() *BalancedNics

NewBalancedNicsWithDefaults instantiates a new BalancedNics 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

GetId

func (o *BalancedNics) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *BalancedNics) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *BalancedNics) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *BalancedNics) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *BalancedNics) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *BalancedNics) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *BalancedNics) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *BalancedNics) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *BalancedNics) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *BalancedNics) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *BalancedNics) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *BalancedNics) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *BalancedNics) GetItems() []Nic

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *BalancedNics) GetItemsOk() (*[]Nic, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *BalancedNics) SetItems(v []Nic)

SetItems sets Items field to given value.

HasItems

func (o *BalancedNics) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *BalancedNics) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *BalancedNics) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *BalancedNics) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *BalancedNics) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *BalancedNics) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *BalancedNics) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *BalancedNics) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *BalancedNics) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *BalancedNics) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *BalancedNics) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *BalancedNics) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *BalancedNics) HasLinks() bool

HasLinks returns a boolean if a field has been set.

Cdroms

Properties

Name
Type
Description
Notes

Methods

NewCdroms

func NewCdroms() *Cdroms

NewCdroms instantiates a new Cdroms 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

NewCdromsWithDefaults

func NewCdromsWithDefaults() *Cdroms

NewCdromsWithDefaults instantiates a new Cdroms 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

GetId

func (o *Cdroms) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Cdroms) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Cdroms) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Cdroms) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Cdroms) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Cdroms) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Cdroms) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Cdroms) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Cdroms) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Cdroms) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Cdroms) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Cdroms) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *Cdroms) GetItems() []Image

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *Cdroms) GetItemsOk() (*[]Image, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *Cdroms) SetItems(v []Image)

SetItems sets Items field to given value.

HasItems

func (o *Cdroms) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *Cdroms) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *Cdroms) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *Cdroms) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *Cdroms) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *Cdroms) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *Cdroms) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *Cdroms) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *Cdroms) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *Cdroms) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *Cdroms) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *Cdroms) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *Cdroms) HasLinks() bool

HasLinks returns a boolean if a field has been set.

Datacenter

Properties

Name
Type
Description
Notes

Methods

NewDatacenter

func NewDatacenter(properties DatacenterProperties, ) *Datacenter

NewDatacenter instantiates a new Datacenter 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

NewDatacenterWithDefaults

func NewDatacenterWithDefaults() *Datacenter

NewDatacenterWithDefaults instantiates a new Datacenter 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

GetId

func (o *Datacenter) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Datacenter) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Datacenter) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Datacenter) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Datacenter) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Datacenter) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Datacenter) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Datacenter) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Datacenter) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Datacenter) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Datacenter) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Datacenter) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *Datacenter) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *Datacenter) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *Datacenter) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *Datacenter) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *Datacenter) GetProperties() DatacenterProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *Datacenter) GetPropertiesOk() (*DatacenterProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *Datacenter) SetProperties(v DatacenterProperties)

SetProperties sets Properties field to given value.

GetEntities

func (o *Datacenter) GetEntities() DataCenterEntities

GetEntities returns the Entities field if non-nil, zero value otherwise.

GetEntitiesOk

func (o *Datacenter) GetEntitiesOk() (*DataCenterEntities, bool)

GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEntities

func (o *Datacenter) SetEntities(v DataCenterEntities)

SetEntities sets Entities field to given value.

HasEntities

func (o *Datacenter) HasEntities() bool

HasEntities returns a boolean if a field has been set.

KubernetesCluster

Properties

Name
Type
Description
Notes

Methods

NewKubernetesCluster

func NewKubernetesCluster(properties KubernetesClusterProperties, ) *KubernetesCluster

NewKubernetesCluster instantiates a new KubernetesCluster 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

NewKubernetesClusterWithDefaults

func NewKubernetesClusterWithDefaults() *KubernetesCluster

NewKubernetesClusterWithDefaults instantiates a new KubernetesCluster 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

GetId

func (o *KubernetesCluster) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesCluster) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesCluster) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesCluster) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesCluster) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesCluster) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesCluster) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesCluster) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesCluster) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesCluster) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesCluster) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesCluster) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *KubernetesCluster) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *KubernetesCluster) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *KubernetesCluster) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *KubernetesCluster) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *KubernetesCluster) GetProperties() KubernetesClusterProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *KubernetesCluster) GetPropertiesOk() (*KubernetesClusterProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *KubernetesCluster) SetProperties(v KubernetesClusterProperties)

SetProperties sets Properties field to given value.

GetEntities

func (o *KubernetesCluster) GetEntities() KubernetesClusterEntities

GetEntities returns the Entities field if non-nil, zero value otherwise.

GetEntitiesOk

func (o *KubernetesCluster) GetEntitiesOk() (*KubernetesClusterEntities, bool)

GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEntities

func (o *KubernetesCluster) SetEntities(v KubernetesClusterEntities)

SetEntities sets Entities field to given value.

HasEntities

func (o *KubernetesCluster) HasEntities() bool

HasEntities returns a boolean if a field has been set.

KubernetesClusterForPut

Properties

Name
Type
Description
Notes

Methods

NewKubernetesClusterForPut

func NewKubernetesClusterForPut(properties KubernetesClusterPropertiesForPut, ) *KubernetesClusterForPut

NewKubernetesClusterForPut instantiates a new KubernetesClusterForPut 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

NewKubernetesClusterForPutWithDefaults

func NewKubernetesClusterForPutWithDefaults() *KubernetesClusterForPut

NewKubernetesClusterForPutWithDefaults instantiates a new KubernetesClusterForPut 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

GetId

func (o *KubernetesClusterForPut) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesClusterForPut) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesClusterForPut) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesClusterForPut) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesClusterForPut) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesClusterForPut) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesClusterForPut) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesClusterForPut) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesClusterForPut) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesClusterForPut) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesClusterForPut) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesClusterForPut) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *KubernetesClusterForPut) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *KubernetesClusterForPut) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *KubernetesClusterForPut) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *KubernetesClusterForPut) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *KubernetesClusterForPut) GetProperties() KubernetesClusterPropertiesForPut

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *KubernetesClusterForPut) GetPropertiesOk() (*KubernetesClusterPropertiesForPut, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *KubernetesClusterForPut) SetProperties(v KubernetesClusterPropertiesForPut)

SetProperties sets Properties field to given value.

GetEntities

func (o *KubernetesClusterForPut) GetEntities() KubernetesClusterEntities

GetEntities returns the Entities field if non-nil, zero value otherwise.

GetEntitiesOk

func (o *KubernetesClusterForPut) GetEntitiesOk() (*KubernetesClusterEntities, bool)

GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEntities

func (o *KubernetesClusterForPut) SetEntities(v KubernetesClusterEntities)

SetEntities sets Entities field to given value.

HasEntities

func (o *KubernetesClusterForPut) HasEntities() bool

HasEntities returns a boolean if a field has been set.

Loadbalancer

Properties

Name
Type
Description
Notes

Methods

NewLoadbalancer

func NewLoadbalancer(properties LoadbalancerProperties, ) *Loadbalancer

NewLoadbalancer instantiates a new Loadbalancer 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

NewLoadbalancerWithDefaults

func NewLoadbalancerWithDefaults() *Loadbalancer

NewLoadbalancerWithDefaults instantiates a new Loadbalancer 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

GetId

func (o *Loadbalancer) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Loadbalancer) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Loadbalancer) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Loadbalancer) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Loadbalancer) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Loadbalancer) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Loadbalancer) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Loadbalancer) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Loadbalancer) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Loadbalancer) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Loadbalancer) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Loadbalancer) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *Loadbalancer) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *Loadbalancer) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *Loadbalancer) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *Loadbalancer) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *Loadbalancer) GetProperties() LoadbalancerProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *Loadbalancer) GetPropertiesOk() (*LoadbalancerProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *Loadbalancer) SetProperties(v LoadbalancerProperties)

SetProperties sets Properties field to given value.

GetEntities

func (o *Loadbalancer) GetEntities() LoadbalancerEntities

GetEntities returns the Entities field if non-nil, zero value otherwise.

GetEntitiesOk

func (o *Loadbalancer) GetEntitiesOk() (*LoadbalancerEntities, bool)

GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEntities

func (o *Loadbalancer) SetEntities(v LoadbalancerEntities)

SetEntities sets Entities field to given value.

HasEntities

func (o *Loadbalancer) HasEntities() bool

HasEntities returns a boolean if a field has been set.

Lan

Properties

Name
Type
Description
Notes

Methods

NewLan

func NewLan(properties LanProperties, ) *Lan

NewLan instantiates a new Lan 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

NewLanWithDefaults

func NewLanWithDefaults() *Lan

NewLanWithDefaults instantiates a new Lan 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

GetId

func (o *Lan) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Lan) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Lan) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Lan) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Lan) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Lan) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Lan) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Lan) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Lan) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Lan) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Lan) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Lan) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *Lan) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *Lan) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *Lan) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *Lan) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *Lan) GetProperties() LanProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *Lan) GetPropertiesOk() (*LanProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *Lan) SetProperties(v LanProperties)

SetProperties sets Properties field to given value.

GetEntities

func (o *Lan) GetEntities() LanEntities

GetEntities returns the Entities field if non-nil, zero value otherwise.

GetEntitiesOk

func (o *Lan) GetEntitiesOk() (*LanEntities, bool)

GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEntities

func (o *Lan) SetEntities(v LanEntities)

SetEntities sets Entities field to given value.

HasEntities

func (o *Lan) HasEntities() bool

HasEntities returns a boolean if a field has been set.

LanPost

Properties

Name
Type
Description
Notes

Methods

NewLanPost

func NewLanPost(properties LanPropertiesPost, ) *LanPost

NewLanPost instantiates a new LanPost 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

NewLanPostWithDefaults

func NewLanPostWithDefaults() *LanPost

NewLanPostWithDefaults instantiates a new LanPost 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

GetId

func (o *LanPost) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *LanPost) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *LanPost) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *LanPost) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *LanPost) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *LanPost) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *LanPost) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *LanPost) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *LanPost) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *LanPost) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *LanPost) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *LanPost) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *LanPost) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *LanPost) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *LanPost) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *LanPost) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetEntities

func (o *LanPost) GetEntities() LanEntities

GetEntities returns the Entities field if non-nil, zero value otherwise.

GetEntitiesOk

func (o *LanPost) GetEntitiesOk() (*LanEntities, bool)

GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEntities

func (o *LanPost) SetEntities(v LanEntities)

SetEntities sets Entities field to given value.

HasEntities

func (o *LanPost) HasEntities() bool

HasEntities returns a boolean if a field has been set.

GetProperties

func (o *LanPost) GetProperties() LanPropertiesPost

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *LanPost) GetPropertiesOk() (*LanPropertiesPost, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *LanPost) SetProperties(v LanPropertiesPost)

SetProperties sets Properties field to given value.

KubernetesClusterForPost

Properties

Name
Type
Description
Notes

Methods

NewKubernetesClusterForPost

func NewKubernetesClusterForPost(properties KubernetesClusterPropertiesForPost, ) *KubernetesClusterForPost

NewKubernetesClusterForPost instantiates a new KubernetesClusterForPost 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

NewKubernetesClusterForPostWithDefaults

func NewKubernetesClusterForPostWithDefaults() *KubernetesClusterForPost

NewKubernetesClusterForPostWithDefaults instantiates a new KubernetesClusterForPost 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

GetId

func (o *KubernetesClusterForPost) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *KubernetesClusterForPost) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *KubernetesClusterForPost) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *KubernetesClusterForPost) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *KubernetesClusterForPost) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *KubernetesClusterForPost) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *KubernetesClusterForPost) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *KubernetesClusterForPost) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *KubernetesClusterForPost) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *KubernetesClusterForPost) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *KubernetesClusterForPost) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *KubernetesClusterForPost) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *KubernetesClusterForPost) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *KubernetesClusterForPost) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *KubernetesClusterForPost) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *KubernetesClusterForPost) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *KubernetesClusterForPost) GetProperties() KubernetesClusterPropertiesForPost

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *KubernetesClusterForPost) GetPropertiesOk() (*KubernetesClusterPropertiesForPost, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *KubernetesClusterForPost) SetProperties(v KubernetesClusterPropertiesForPost)

SetProperties sets Properties field to given value.

GetEntities

func (o *KubernetesClusterForPost) GetEntities() KubernetesClusterEntities

GetEntities returns the Entities field if non-nil, zero value otherwise.

GetEntitiesOk

func (o *KubernetesClusterForPost) GetEntitiesOk() (*KubernetesClusterEntities, bool)

GetEntitiesOk returns a tuple with the Entities field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEntities

func (o *KubernetesClusterForPost) SetEntities(v KubernetesClusterEntities)

SetEntities sets Entities field to given value.

HasEntities

func (o *KubernetesClusterForPost) HasEntities() bool

HasEntities returns a boolean if a field has been set.

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []Volume

Array of items in that collection

[optional] [readonly]

Offset

Pointer to float32

the offset (if specified in the request)

[optional]

Limit

Pointer to float32

the limit (if specified in the request)

[optional]

Links

Pointer to PaginationLinks

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []Nic

Array of items in that collection

[optional] [readonly]

Offset

Pointer to float32

the offset (if specified in the request)

[optional]

Limit

Pointer to float32

the limit (if specified in the request)

[optional]

Links

Pointer to PaginationLinks

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []Image

Array of items in that collection

[optional] [readonly]

Offset

Pointer to float32

the offset (if specified in the request)

[optional]

Limit

Pointer to float32

the limit (if specified in the request)

[optional]

Links

Pointer to PaginationLinks

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

DatacenterProperties

Entities

Pointer to DataCenterEntities

[optional]

Id

Pointer to string

The resource's unique identifier.

[optional] [readonly]

Type

Pointer to string

The type of object

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

KubernetesClusterProperties

Entities

Pointer to KubernetesClusterEntities

[optional]

Id

Pointer to string

The resource's unique identifier.

[optional] [readonly]

Type

Pointer to string

The type of object

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

KubernetesClusterPropertiesForPut

Entities

Pointer to KubernetesClusterEntities

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

LoadbalancerProperties

Entities

Pointer to LoadbalancerEntities

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

LanProperties

Entities

Pointer to LanEntities

[optional]

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Entities

Pointer to LanEntities

[optional]

Properties

LanPropertiesPost

Id

Pointer to string

The resource's unique identifier.

[optional] [readonly]

Type

Pointer to string

The type of object

[optional] [readonly]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

KubernetesClusterPropertiesForPost

Entities

Pointer to KubernetesClusterEntities

[optional]

Type
DatacenterElementMetadata
IpBlockProperties
KubernetesMaintenanceWindow
[]S3Bucket
NoStateMetaData
LabelProperties
DatacenterElementMetadata
KubernetesNodePoolProperties
DatacenterElementMetadata
KubernetesNodePoolPropertiesForPost

IpBlocks

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to

Array of items in that collection

[optional] [readonly]

Offset

Pointer to float32

the offset specified in the request (or, if none was specified, the default offset of 0)

[optional]

Limit

Pointer to float32

the limit specified in the request (or, if none was specified use the endpoint's default pagination limit)

[optional]

Links

Pointer to

[optional]

Methods

NewIpBlocks

func NewIpBlocks() *IpBlocks

NewIpBlocks instantiates a new IpBlocks 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

NewIpBlocksWithDefaults

func NewIpBlocksWithDefaults() *IpBlocks

NewIpBlocksWithDefaults instantiates a new IpBlocks 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

GetId

func (o *IpBlocks) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *IpBlocks) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *IpBlocks) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *IpBlocks) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *IpBlocks) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *IpBlocks) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *IpBlocks) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *IpBlocks) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *IpBlocks) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *IpBlocks) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *IpBlocks) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *IpBlocks) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *IpBlocks) GetItems() []IpBlock

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *IpBlocks) GetItemsOk() (*[]IpBlock, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *IpBlocks) SetItems(v []IpBlock)

SetItems sets Items field to given value.

HasItems

func (o *IpBlocks) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *IpBlocks) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *IpBlocks) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *IpBlocks) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *IpBlocks) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *IpBlocks) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *IpBlocks) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *IpBlocks) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *IpBlocks) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *IpBlocks) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *IpBlocks) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *IpBlocks) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *IpBlocks) HasLinks() bool

HasLinks returns a boolean if a field has been set.

LabelResources

Properties

Name
Type
Description
Notes

Id

Pointer to string

Unique representation for Label as a collection on a resource.

[optional] [readonly]

Type

Pointer to string

The type of resource within a collection

[optional] [readonly]

Href

Pointer to string

URL to the collection representation (absolute path)

[optional] [readonly]

Items

Pointer to

Array of items in that collection

[optional] [readonly]

Offset

Pointer to float32

the offset (if specified in the request)

[optional]

Limit

Pointer to float32

the limit (if specified in the request)

[optional]

Links

Pointer to

[optional]

Methods

NewLabelResources

func NewLabelResources() *LabelResources

NewLabelResources instantiates a new LabelResources 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

NewLabelResourcesWithDefaults

func NewLabelResourcesWithDefaults() *LabelResources

NewLabelResourcesWithDefaults instantiates a new LabelResources 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

GetId

func (o *LabelResources) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *LabelResources) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *LabelResources) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *LabelResources) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *LabelResources) GetType() string

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *LabelResources) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *LabelResources) SetType(v string)

SetType sets Type field to given value.

HasType

func (o *LabelResources) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *LabelResources) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *LabelResources) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *LabelResources) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *LabelResources) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *LabelResources) GetItems() []LabelResource

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *LabelResources) GetItemsOk() (*[]LabelResource, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *LabelResources) SetItems(v []LabelResource)

SetItems sets Items field to given value.

HasItems

func (o *LabelResources) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *LabelResources) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *LabelResources) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *LabelResources) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *LabelResources) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *LabelResources) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *LabelResources) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *LabelResources) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *LabelResources) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *LabelResources) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *LabelResources) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *LabelResources) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *LabelResources) HasLinks() bool

HasLinks returns a boolean if a field has been set.

KubernetesClusterProperties

Properties

Name
Type
Description
Notes

Name

string

A Kubernetes Cluster Name. Valid Kubernetes Cluster name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

K8sVersion

Pointer to string

The kubernetes version in which a cluster is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions.

[optional]

MaintenanceWindow

Pointer to

[optional]

AvailableUpgradeVersions

Pointer to []string

List of available versions for upgrading the cluster

[optional]

ViableNodePoolVersions

Pointer to []string

List of versions that may be used for node pools under this cluster

[optional]

ApiSubnetAllowList

Pointer to []string

Access to the K8s API server is restricted to these CIDRs. Cluster-internal traffic is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6.

[optional]

S3Buckets

Pointer to

List of S3 bucket configured for K8s usage. For now it contains only one S3 bucket used to store K8s API audit logs

[optional]

Methods

NewKubernetesClusterProperties

func NewKubernetesClusterProperties(name string, ) *KubernetesClusterProperties

NewKubernetesClusterProperties instantiates a new KubernetesClusterProperties 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

NewKubernetesClusterPropertiesWithDefaults

func NewKubernetesClusterPropertiesWithDefaults() *KubernetesClusterProperties

NewKubernetesClusterPropertiesWithDefaults instantiates a new KubernetesClusterProperties 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

GetName

func (o *KubernetesClusterProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *KubernetesClusterProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *KubernetesClusterProperties) SetName(v string)

SetName sets Name field to given value.

GetK8sVersion

func (o *KubernetesClusterProperties) GetK8sVersion() string

GetK8sVersion returns the K8sVersion field if non-nil, zero value otherwise.

GetK8sVersionOk

func (o *KubernetesClusterProperties) GetK8sVersionOk() (*string, bool)

GetK8sVersionOk returns a tuple with the K8sVersion field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sVersion

func (o *KubernetesClusterProperties) SetK8sVersion(v string)

SetK8sVersion sets K8sVersion field to given value.

HasK8sVersion

func (o *KubernetesClusterProperties) HasK8sVersion() bool

HasK8sVersion returns a boolean if a field has been set.

GetMaintenanceWindow

func (o *KubernetesClusterProperties) GetMaintenanceWindow() KubernetesMaintenanceWindow

GetMaintenanceWindow returns the MaintenanceWindow field if non-nil, zero value otherwise.

GetMaintenanceWindowOk

func (o *KubernetesClusterProperties) GetMaintenanceWindowOk() (*KubernetesMaintenanceWindow, bool)

GetMaintenanceWindowOk returns a tuple with the MaintenanceWindow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMaintenanceWindow

func (o *KubernetesClusterProperties) SetMaintenanceWindow(v KubernetesMaintenanceWindow)

SetMaintenanceWindow sets MaintenanceWindow field to given value.

HasMaintenanceWindow

func (o *KubernetesClusterProperties) HasMaintenanceWindow() bool

HasMaintenanceWindow returns a boolean if a field has been set.

GetAvailableUpgradeVersions

func (o *KubernetesClusterProperties) GetAvailableUpgradeVersions() []string

GetAvailableUpgradeVersions returns the AvailableUpgradeVersions field if non-nil, zero value otherwise.

GetAvailableUpgradeVersionsOk

func (o *KubernetesClusterProperties) GetAvailableUpgradeVersionsOk() (*[]string, bool)

GetAvailableUpgradeVersionsOk returns a tuple with the AvailableUpgradeVersions field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAvailableUpgradeVersions

func (o *KubernetesClusterProperties) SetAvailableUpgradeVersions(v []string)

SetAvailableUpgradeVersions sets AvailableUpgradeVersions field to given value.

HasAvailableUpgradeVersions

func (o *KubernetesClusterProperties) HasAvailableUpgradeVersions() bool

HasAvailableUpgradeVersions returns a boolean if a field has been set.

GetViableNodePoolVersions

func (o *KubernetesClusterProperties) GetViableNodePoolVersions() []string

GetViableNodePoolVersions returns the ViableNodePoolVersions field if non-nil, zero value otherwise.

GetViableNodePoolVersionsOk

func (o *KubernetesClusterProperties) GetViableNodePoolVersionsOk() (*[]string, bool)

GetViableNodePoolVersionsOk returns a tuple with the ViableNodePoolVersions field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetViableNodePoolVersions

func (o *KubernetesClusterProperties) SetViableNodePoolVersions(v []string)

SetViableNodePoolVersions sets ViableNodePoolVersions field to given value.

HasViableNodePoolVersions

func (o *KubernetesClusterProperties) HasViableNodePoolVersions() bool

HasViableNodePoolVersions returns a boolean if a field has been set.

GetApiSubnetAllowList

func (o *KubernetesClusterProperties) GetApiSubnetAllowList() []string

GetApiSubnetAllowList returns the ApiSubnetAllowList field if non-nil, zero value otherwise.

GetApiSubnetAllowListOk

func (o *KubernetesClusterProperties) GetApiSubnetAllowListOk() (*[]string, bool)

GetApiSubnetAllowListOk returns a tuple with the ApiSubnetAllowList field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetApiSubnetAllowList

func (o *KubernetesClusterProperties) SetApiSubnetAllowList(v []string)

SetApiSubnetAllowList sets ApiSubnetAllowList field to given value.

HasApiSubnetAllowList

func (o *KubernetesClusterProperties) HasApiSubnetAllowList() bool

HasApiSubnetAllowList returns a boolean if a field has been set.

GetS3Buckets

func (o *KubernetesClusterProperties) GetS3Buckets() []S3Bucket

GetS3Buckets returns the S3Buckets field if non-nil, zero value otherwise.

GetS3BucketsOk

func (o *KubernetesClusterProperties) GetS3BucketsOk() (*[]S3Bucket, bool)

GetS3BucketsOk returns a tuple with the S3Buckets field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetS3Buckets

func (o *KubernetesClusterProperties) SetS3Buckets(v []S3Bucket)

SetS3Buckets sets S3Buckets field to given value.

HasS3Buckets

func (o *KubernetesClusterProperties) HasS3Buckets() bool

HasS3Buckets returns a boolean if a field has been set.

Lans

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to

Array of items in lans collection

[optional] [readonly]

Offset

Pointer to float32

the offset (if specified in the request)

[optional]

Limit

Pointer to float32

the limit (if specified in the request)

[optional]

Links

Pointer to

[optional]

Methods

NewLans

func NewLans() *Lans

NewLans instantiates a new Lans 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

NewLansWithDefaults

func NewLansWithDefaults() *Lans

NewLansWithDefaults instantiates a new Lans 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

GetId

func (o *Lans) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Lans) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Lans) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Lans) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Lans) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Lans) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Lans) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Lans) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Lans) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Lans) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Lans) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Lans) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *Lans) GetItems() []Lan

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *Lans) GetItemsOk() (*[]Lan, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *Lans) SetItems(v []Lan)

SetItems sets Items field to given value.

HasItems

func (o *Lans) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *Lans) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *Lans) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *Lans) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *Lans) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *Lans) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *Lans) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *Lans) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *Lans) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *Lans) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *Lans) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *Lans) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *Lans) HasLinks() bool

HasLinks returns a boolean if a field has been set.

LanNics

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to

Array of items in that collection

[optional] [readonly]

Offset

Pointer to float32

the offset (if specified in the request)

[optional]

Limit

Pointer to float32

the limit (if specified in the request)

[optional]

Links

Pointer to

[optional]

Methods

NewLanNics

func NewLanNics() *LanNics

NewLanNics instantiates a new LanNics 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

NewLanNicsWithDefaults

func NewLanNicsWithDefaults() *LanNics

NewLanNicsWithDefaults instantiates a new LanNics 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

GetId

func (o *LanNics) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *LanNics) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *LanNics) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *LanNics) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *LanNics) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *LanNics) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *LanNics) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *LanNics) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *LanNics) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *LanNics) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *LanNics) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *LanNics) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *LanNics) GetItems() []Nic

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *LanNics) GetItemsOk() (*[]Nic, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *LanNics) SetItems(v []Nic)

SetItems sets Items field to given value.

HasItems

func (o *LanNics) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *LanNics) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *LanNics) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *LanNics) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *LanNics) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *LanNics) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *LanNics) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *LanNics) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *LanNics) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *LanNics) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *LanNics) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *LanNics) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *LanNics) HasLinks() bool

HasLinks returns a boolean if a field has been set.

KubernetesNodeMetadata

Properties

Name
Type
Description
Notes

Etag

Pointer to string

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

[optional] [readonly]

CreatedDate

Pointer to

The last time the resource was created

[optional] [readonly]

LastModifiedDate

Pointer to

The last time the resource has been modified

[optional] [readonly]

State

Pointer to string

State of the resource.

[optional] [readonly]

LastSoftwareUpdatedDate

Pointer to

The last time the software updated on node.

[optional] [readonly]

Methods

NewKubernetesNodeMetadata

func NewKubernetesNodeMetadata() *KubernetesNodeMetadata

NewKubernetesNodeMetadata instantiates a new KubernetesNodeMetadata 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

NewKubernetesNodeMetadataWithDefaults

func NewKubernetesNodeMetadataWithDefaults() *KubernetesNodeMetadata

NewKubernetesNodeMetadataWithDefaults instantiates a new KubernetesNodeMetadata 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

GetEtag

func (o *KubernetesNodeMetadata) GetEtag() string

GetEtag returns the Etag field if non-nil, zero value otherwise.

GetEtagOk

func (o *KubernetesNodeMetadata) GetEtagOk() (*string, bool)

GetEtagOk returns a tuple with the Etag field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEtag

func (o *KubernetesNodeMetadata) SetEtag(v string)

SetEtag sets Etag field to given value.

HasEtag

func (o *KubernetesNodeMetadata) HasEtag() bool

HasEtag returns a boolean if a field has been set.

GetCreatedDate

func (o *KubernetesNodeMetadata) GetCreatedDate() time.Time

GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise.

GetCreatedDateOk

func (o *KubernetesNodeMetadata) GetCreatedDateOk() (*time.Time, bool)

GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreatedDate

func (o *KubernetesNodeMetadata) SetCreatedDate(v time.Time)

SetCreatedDate sets CreatedDate field to given value.

HasCreatedDate

func (o *KubernetesNodeMetadata) HasCreatedDate() bool

HasCreatedDate returns a boolean if a field has been set.

GetLastModifiedDate

func (o *KubernetesNodeMetadata) GetLastModifiedDate() time.Time

GetLastModifiedDate returns the LastModifiedDate field if non-nil, zero value otherwise.

GetLastModifiedDateOk

func (o *KubernetesNodeMetadata) GetLastModifiedDateOk() (*time.Time, bool)

GetLastModifiedDateOk returns a tuple with the LastModifiedDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLastModifiedDate

func (o *KubernetesNodeMetadata) SetLastModifiedDate(v time.Time)

SetLastModifiedDate sets LastModifiedDate field to given value.

HasLastModifiedDate

func (o *KubernetesNodeMetadata) HasLastModifiedDate() bool

HasLastModifiedDate returns a boolean if a field has been set.

GetState

func (o *KubernetesNodeMetadata) GetState() string

GetState returns the State field if non-nil, zero value otherwise.

GetStateOk

func (o *KubernetesNodeMetadata) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetState

func (o *KubernetesNodeMetadata) SetState(v string)

SetState sets State field to given value.

HasState

func (o *KubernetesNodeMetadata) HasState() bool

HasState returns a boolean if a field has been set.

GetLastSoftwareUpdatedDate

func (o *KubernetesNodeMetadata) GetLastSoftwareUpdatedDate() time.Time

GetLastSoftwareUpdatedDate returns the LastSoftwareUpdatedDate field if non-nil, zero value otherwise.

GetLastSoftwareUpdatedDateOk

func (o *KubernetesNodeMetadata) GetLastSoftwareUpdatedDateOk() (*time.Time, bool)

GetLastSoftwareUpdatedDateOk returns a tuple with the LastSoftwareUpdatedDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLastSoftwareUpdatedDate

func (o *KubernetesNodeMetadata) SetLastSoftwareUpdatedDate(v time.Time)

SetLastSoftwareUpdatedDate sets LastSoftwareUpdatedDate field to given value.

HasLastSoftwareUpdatedDate

func (o *KubernetesNodeMetadata) HasLastSoftwareUpdatedDate() bool

HasLastSoftwareUpdatedDate returns a boolean if a field has been set.

LanProperties

Properties

Name
Type
Description
Notes

Name

Pointer to string

A name of that resource

[optional]

IpFailover

Pointer to

IP failover configurations for lan

[optional]

Pcc

Pointer to string

Unique identifier of the private cross connect the given LAN is connected to if any

[optional]

Public

Pointer to bool

Does this LAN faces the public Internet or not

[optional]

Methods

NewLanProperties

func NewLanProperties() *LanProperties

NewLanProperties instantiates a new LanProperties 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

NewLanPropertiesWithDefaults

func NewLanPropertiesWithDefaults() *LanProperties

NewLanPropertiesWithDefaults instantiates a new LanProperties 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

GetName

func (o *LanProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *LanProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *LanProperties) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *LanProperties) HasName() bool

HasName returns a boolean if a field has been set.

GetIpFailover

func (o *LanProperties) GetIpFailover() []IPFailover

GetIpFailover returns the IpFailover field if non-nil, zero value otherwise.

GetIpFailoverOk

func (o *LanProperties) GetIpFailoverOk() (*[]IPFailover, bool)

GetIpFailoverOk returns a tuple with the IpFailover field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIpFailover

func (o *LanProperties) SetIpFailover(v []IPFailover)

SetIpFailover sets IpFailover field to given value.

HasIpFailover

func (o *LanProperties) HasIpFailover() bool

HasIpFailover returns a boolean if a field has been set.

GetPcc

func (o *LanProperties) GetPcc() string

GetPcc returns the Pcc field if non-nil, zero value otherwise.

GetPccOk

func (o *LanProperties) GetPccOk() (*string, bool)

GetPccOk returns a tuple with the Pcc field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPcc

func (o *LanProperties) SetPcc(v string)

SetPcc sets Pcc field to given value.

HasPcc

func (o *LanProperties) HasPcc() bool

HasPcc returns a boolean if a field has been set.

GetPublic

func (o *LanProperties) GetPublic() bool

GetPublic returns the Public field if non-nil, zero value otherwise.

GetPublicOk

func (o *LanProperties) GetPublicOk() (*bool, bool)

GetPublicOk returns a tuple with the Public field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPublic

func (o *LanProperties) SetPublic(v bool)

SetPublic sets Public field to given value.

HasPublic

func (o *LanProperties) HasPublic() bool

HasPublic returns a boolean if a field has been set.

LanPropertiesPost

Properties

Name
Type
Description
Notes

Name

Pointer to string

A name of that resource

[optional]

IpFailover

Pointer to

IP failover configurations for lan

[optional]

Pcc

Pointer to string

Unique identifier of the private cross connect the given LAN is connected to if any

[optional]

Public

Pointer to bool

Does this LAN faces the public Internet or not

[optional]

Methods

NewLanPropertiesPost

func NewLanPropertiesPost() *LanPropertiesPost

NewLanPropertiesPost instantiates a new LanPropertiesPost 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

NewLanPropertiesPostWithDefaults

func NewLanPropertiesPostWithDefaults() *LanPropertiesPost

NewLanPropertiesPostWithDefaults instantiates a new LanPropertiesPost 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

GetName

func (o *LanPropertiesPost) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *LanPropertiesPost) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *LanPropertiesPost) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *LanPropertiesPost) HasName() bool

HasName returns a boolean if a field has been set.

GetIpFailover

func (o *LanPropertiesPost) GetIpFailover() []IPFailover

GetIpFailover returns the IpFailover field if non-nil, zero value otherwise.

GetIpFailoverOk

func (o *LanPropertiesPost) GetIpFailoverOk() (*[]IPFailover, bool)

GetIpFailoverOk returns a tuple with the IpFailover field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIpFailover

func (o *LanPropertiesPost) SetIpFailover(v []IPFailover)

SetIpFailover sets IpFailover field to given value.

HasIpFailover

func (o *LanPropertiesPost) HasIpFailover() bool

HasIpFailover returns a boolean if a field has been set.

GetPcc

func (o *LanPropertiesPost) GetPcc() string

GetPcc returns the Pcc field if non-nil, zero value otherwise.

GetPccOk

func (o *LanPropertiesPost) GetPccOk() (*string, bool)

GetPccOk returns a tuple with the Pcc field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPcc

func (o *LanPropertiesPost) SetPcc(v string)

SetPcc sets Pcc field to given value.

HasPcc

func (o *LanPropertiesPost) HasPcc() bool

HasPcc returns a boolean if a field has been set.

GetPublic

func (o *LanPropertiesPost) GetPublic() bool

GetPublic returns the Public field if non-nil, zero value otherwise.

GetPublicOk

func (o *LanPropertiesPost) GetPublicOk() (*bool, bool)

GetPublicOk returns a tuple with the Public field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPublic

func (o *LanPropertiesPost) SetPublic(v bool)

SetPublic sets Public field to given value.

HasPublic

func (o *LanPropertiesPost) HasPublic() bool

HasPublic returns a boolean if a field has been set.

Image

Properties

Name
Type
Description
Notes

Methods

NewImage

func NewImage(properties ImageProperties, ) *Image

NewImage instantiates a new Image 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

NewImageWithDefaults

func NewImageWithDefaults() *Image

NewImageWithDefaults instantiates a new Image 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

GetId

func (o *Image) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Image) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Image) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Image) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Image) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Image) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Image) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Image) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Image) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Image) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Image) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Image) HasHref() bool

HasHref returns a boolean if a field has been set.

GetMetadata

func (o *Image) GetMetadata() DatacenterElementMetadata

GetMetadata returns the Metadata field if non-nil, zero value otherwise.

GetMetadataOk

func (o *Image) GetMetadataOk() (*DatacenterElementMetadata, bool)

GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetadata

func (o *Image) SetMetadata(v DatacenterElementMetadata)

SetMetadata sets Metadata field to given value.

HasMetadata

func (o *Image) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

GetProperties

func (o *Image) GetProperties() ImageProperties

GetProperties returns the Properties field if non-nil, zero value otherwise.

GetPropertiesOk

func (o *Image) GetPropertiesOk() (*ImageProperties, bool)

GetPropertiesOk returns a tuple with the Properties field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProperties

func (o *Image) SetProperties(v ImageProperties)

SetProperties sets Properties field to given value.

Datacenters

Properties

Name
Type
Description
Notes

Methods

NewDatacenters

func NewDatacenters() *Datacenters

NewDatacenters instantiates a new Datacenters 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

NewDatacentersWithDefaults

func NewDatacentersWithDefaults() *Datacenters

NewDatacentersWithDefaults instantiates a new Datacenters 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

GetId

func (o *Datacenters) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Datacenters) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Datacenters) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *Datacenters) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *Datacenters) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *Datacenters) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *Datacenters) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *Datacenters) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *Datacenters) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *Datacenters) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *Datacenters) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *Datacenters) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *Datacenters) GetItems() []Datacenter

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *Datacenters) GetItemsOk() (*[]Datacenter, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *Datacenters) SetItems(v []Datacenter)

SetItems sets Items field to given value.

HasItems

func (o *Datacenters) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *Datacenters) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *Datacenters) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *Datacenters) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *Datacenters) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *Datacenters) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *Datacenters) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *Datacenters) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *Datacenters) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *Datacenters) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *Datacenters) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *Datacenters) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *Datacenters) HasLinks() bool

HasLinks returns a boolean if a field has been set.

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Metadata

Pointer to DatacenterElementMetadata

[optional]

Properties

ImageProperties

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to Type

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to []Datacenter

Array of items in that collection

[optional] [readonly]

Offset

Pointer to float32

the offset (if specified in the request)

[optional]

Limit

Pointer to float32

the limit (if specified in the request)

[optional]

Links

Pointer to PaginationLinks

[optional]

Type
[]IpBlock
PaginationLinks
[]LabelResource
PaginationLinks
KubernetesMaintenanceWindow
[]S3Bucket
Type
[]Lan
PaginationLinks
Type
[]Nic
PaginationLinks
time.Time
time.Time
time.Time
[]IPFailover
[]IPFailover

FirewallruleProperties

Properties

Name
Type
Description
Notes

Name

Pointer to string

A name of that resource

[optional]

Protocol

string

The protocol for the rule. Property cannot be modified after creation (disallowed in update requests)

SourceMac

Pointer to string

Only traffic originating from the respective MAC address is allowed. Valid format: aa:bb:cc:dd:ee:ff. Value null allows all source MAC address

[optional]

SourceIp

Pointer to string

Only traffic originating from the respective IPv4 address is allowed. Value null allows all source IPs

[optional]

TargetIp

Pointer to string

In case the target NIC has multiple IP addresses, only traffic directed to the respective IP address of the NIC is allowed. Value null allows all target IPs

[optional]

IcmpCode

Pointer to int32

Defines the allowed code (from 0 to 254) if protocol ICMP is chosen. Value null allows all codes

[optional]

IcmpType

Pointer to int32

Defines the allowed type (from 0 to 254) if the protocol ICMP is chosen. Value null allows all types

[optional]

PortRangeStart

Pointer to int32

Defines the start range of the allowed port (from 1 to 65534) if protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd value null to allow all ports

[optional]

PortRangeEnd

Pointer to int32

Defines the end range of the allowed port (from 1 to 65534) if the protocol TCP or UDP is chosen. Leave portRangeStart and portRangeEnd null to allow all ports

[optional]

Methods

NewFirewallruleProperties

func NewFirewallruleProperties(protocol string, ) *FirewallruleProperties

NewFirewallruleProperties instantiates a new FirewallruleProperties 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

NewFirewallrulePropertiesWithDefaults

func NewFirewallrulePropertiesWithDefaults() *FirewallruleProperties

NewFirewallrulePropertiesWithDefaults instantiates a new FirewallruleProperties 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

GetName

func (o *FirewallruleProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *FirewallruleProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *FirewallruleProperties) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *FirewallruleProperties) HasName() bool

HasName returns a boolean if a field has been set.

GetProtocol

func (o *FirewallruleProperties) GetProtocol() string

GetProtocol returns the Protocol field if non-nil, zero value otherwise.

GetProtocolOk

func (o *FirewallruleProperties) GetProtocolOk() (*string, bool)

GetProtocolOk returns a tuple with the Protocol field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProtocol

func (o *FirewallruleProperties) SetProtocol(v string)

SetProtocol sets Protocol field to given value.

GetSourceMac

func (o *FirewallruleProperties) GetSourceMac() string

GetSourceMac returns the SourceMac field if non-nil, zero value otherwise.

GetSourceMacOk

func (o *FirewallruleProperties) GetSourceMacOk() (*string, bool)

GetSourceMacOk returns a tuple with the SourceMac field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSourceMac

func (o *FirewallruleProperties) SetSourceMac(v string)

SetSourceMac sets SourceMac field to given value.

HasSourceMac

func (o *FirewallruleProperties) HasSourceMac() bool

HasSourceMac returns a boolean if a field has been set.

GetSourceIp

func (o *FirewallruleProperties) GetSourceIp() string

GetSourceIp returns the SourceIp field if non-nil, zero value otherwise.

GetSourceIpOk

func (o *FirewallruleProperties) GetSourceIpOk() (*string, bool)

GetSourceIpOk returns a tuple with the SourceIp field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSourceIp

func (o *FirewallruleProperties) SetSourceIp(v string)

SetSourceIp sets SourceIp field to given value.

HasSourceIp

func (o *FirewallruleProperties) HasSourceIp() bool

HasSourceIp returns a boolean if a field has been set.

GetTargetIp

func (o *FirewallruleProperties) GetTargetIp() string

GetTargetIp returns the TargetIp field if non-nil, zero value otherwise.

GetTargetIpOk

func (o *FirewallruleProperties) GetTargetIpOk() (*string, bool)

GetTargetIpOk returns a tuple with the TargetIp field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTargetIp

func (o *FirewallruleProperties) SetTargetIp(v string)

SetTargetIp sets TargetIp field to given value.

HasTargetIp

func (o *FirewallruleProperties) HasTargetIp() bool

HasTargetIp returns a boolean if a field has been set.

GetIcmpCode

func (o *FirewallruleProperties) GetIcmpCode() int32

GetIcmpCode returns the IcmpCode field if non-nil, zero value otherwise.

GetIcmpCodeOk

func (o *FirewallruleProperties) GetIcmpCodeOk() (*int32, bool)

GetIcmpCodeOk returns a tuple with the IcmpCode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIcmpCode

func (o *FirewallruleProperties) SetIcmpCode(v int32)

SetIcmpCode sets IcmpCode field to given value.

HasIcmpCode

func (o *FirewallruleProperties) HasIcmpCode() bool

HasIcmpCode returns a boolean if a field has been set.

GetIcmpType

func (o *FirewallruleProperties) GetIcmpType() int32

GetIcmpType returns the IcmpType field if non-nil, zero value otherwise.

GetIcmpTypeOk

func (o *FirewallruleProperties) GetIcmpTypeOk() (*int32, bool)

GetIcmpTypeOk returns a tuple with the IcmpType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIcmpType

func (o *FirewallruleProperties) SetIcmpType(v int32)

SetIcmpType sets IcmpType field to given value.

HasIcmpType

func (o *FirewallruleProperties) HasIcmpType() bool

HasIcmpType returns a boolean if a field has been set.

GetPortRangeStart

func (o *FirewallruleProperties) GetPortRangeStart() int32

GetPortRangeStart returns the PortRangeStart field if non-nil, zero value otherwise.

GetPortRangeStartOk

func (o *FirewallruleProperties) GetPortRangeStartOk() (*int32, bool)

GetPortRangeStartOk returns a tuple with the PortRangeStart field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPortRangeStart

func (o *FirewallruleProperties) SetPortRangeStart(v int32)

SetPortRangeStart sets PortRangeStart field to given value.

HasPortRangeStart

func (o *FirewallruleProperties) HasPortRangeStart() bool

HasPortRangeStart returns a boolean if a field has been set.

GetPortRangeEnd

func (o *FirewallruleProperties) GetPortRangeEnd() int32

GetPortRangeEnd returns the PortRangeEnd field if non-nil, zero value otherwise.

GetPortRangeEndOk

func (o *FirewallruleProperties) GetPortRangeEndOk() (*int32, bool)

GetPortRangeEndOk returns a tuple with the PortRangeEnd field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPortRangeEnd

func (o *FirewallruleProperties) SetPortRangeEnd(v int32)

SetPortRangeEnd sets PortRangeEnd field to given value.

HasPortRangeEnd

func (o *FirewallruleProperties) HasPortRangeEnd() bool

HasPortRangeEnd returns a boolean if a field has been set.

IpConsumer

Properties

Name
Type
Description
Notes

Ip

Pointer to string

[optional]

Mac

Pointer to string

[optional]

NicId

Pointer to string

[optional]

ServerId

Pointer to string

[optional]

ServerName

Pointer to string

[optional]

DatacenterId

Pointer to string

[optional]

DatacenterName

Pointer to string

[optional]

K8sNodePoolUuid

Pointer to string

[optional]

K8sClusterUuid

Pointer to string

[optional]

Methods

NewIpConsumer

func NewIpConsumer() *IpConsumer

NewIpConsumer instantiates a new IpConsumer 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

NewIpConsumerWithDefaults

func NewIpConsumerWithDefaults() *IpConsumer

NewIpConsumerWithDefaults instantiates a new IpConsumer 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

GetIp

func (o *IpConsumer) GetIp() string

GetIp returns the Ip field if non-nil, zero value otherwise.

GetIpOk

func (o *IpConsumer) GetIpOk() (*string, bool)

GetIpOk returns a tuple with the Ip field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetIp

func (o *IpConsumer) SetIp(v string)

SetIp sets Ip field to given value.

HasIp

func (o *IpConsumer) HasIp() bool

HasIp returns a boolean if a field has been set.

GetMac

func (o *IpConsumer) GetMac() string

GetMac returns the Mac field if non-nil, zero value otherwise.

GetMacOk

func (o *IpConsumer) GetMacOk() (*string, bool)

GetMacOk returns a tuple with the Mac field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMac

func (o *IpConsumer) SetMac(v string)

SetMac sets Mac field to given value.

HasMac

func (o *IpConsumer) HasMac() bool

HasMac returns a boolean if a field has been set.

GetNicId

func (o *IpConsumer) GetNicId() string

GetNicId returns the NicId field if non-nil, zero value otherwise.

GetNicIdOk

func (o *IpConsumer) GetNicIdOk() (*string, bool)

GetNicIdOk returns a tuple with the NicId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNicId

func (o *IpConsumer) SetNicId(v string)

SetNicId sets NicId field to given value.

HasNicId

func (o *IpConsumer) HasNicId() bool

HasNicId returns a boolean if a field has been set.

GetServerId

func (o *IpConsumer) GetServerId() string

GetServerId returns the ServerId field if non-nil, zero value otherwise.

GetServerIdOk

func (o *IpConsumer) GetServerIdOk() (*string, bool)

GetServerIdOk returns a tuple with the ServerId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetServerId

func (o *IpConsumer) SetServerId(v string)

SetServerId sets ServerId field to given value.

HasServerId

func (o *IpConsumer) HasServerId() bool

HasServerId returns a boolean if a field has been set.

GetServerName

func (o *IpConsumer) GetServerName() string

GetServerName returns the ServerName field if non-nil, zero value otherwise.

GetServerNameOk

func (o *IpConsumer) GetServerNameOk() (*string, bool)

GetServerNameOk returns a tuple with the ServerName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetServerName

func (o *IpConsumer) SetServerName(v string)

SetServerName sets ServerName field to given value.

HasServerName

func (o *IpConsumer) HasServerName() bool

HasServerName returns a boolean if a field has been set.

GetDatacenterId

func (o *IpConsumer) GetDatacenterId() string

GetDatacenterId returns the DatacenterId field if non-nil, zero value otherwise.

GetDatacenterIdOk

func (o *IpConsumer) GetDatacenterIdOk() (*string, bool)

GetDatacenterIdOk returns a tuple with the DatacenterId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDatacenterId

func (o *IpConsumer) SetDatacenterId(v string)

SetDatacenterId sets DatacenterId field to given value.

HasDatacenterId

func (o *IpConsumer) HasDatacenterId() bool

HasDatacenterId returns a boolean if a field has been set.

GetDatacenterName

func (o *IpConsumer) GetDatacenterName() string

GetDatacenterName returns the DatacenterName field if non-nil, zero value otherwise.

GetDatacenterNameOk

func (o *IpConsumer) GetDatacenterNameOk() (*string, bool)

GetDatacenterNameOk returns a tuple with the DatacenterName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDatacenterName

func (o *IpConsumer) SetDatacenterName(v string)

SetDatacenterName sets DatacenterName field to given value.

HasDatacenterName

func (o *IpConsumer) HasDatacenterName() bool

HasDatacenterName returns a boolean if a field has been set.

GetK8sNodePoolUuid

func (o *IpConsumer) GetK8sNodePoolUuid() string

GetK8sNodePoolUuid returns the K8sNodePoolUuid field if non-nil, zero value otherwise.

GetK8sNodePoolUuidOk

func (o *IpConsumer) GetK8sNodePoolUuidOk() (*string, bool)

GetK8sNodePoolUuidOk returns a tuple with the K8sNodePoolUuid field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sNodePoolUuid

func (o *IpConsumer) SetK8sNodePoolUuid(v string)

SetK8sNodePoolUuid sets K8sNodePoolUuid field to given value.

HasK8sNodePoolUuid

func (o *IpConsumer) HasK8sNodePoolUuid() bool

HasK8sNodePoolUuid returns a boolean if a field has been set.

GetK8sClusterUuid

func (o *IpConsumer) GetK8sClusterUuid() string

GetK8sClusterUuid returns the K8sClusterUuid field if non-nil, zero value otherwise.

GetK8sClusterUuidOk

func (o *IpConsumer) GetK8sClusterUuidOk() (*string, bool)

GetK8sClusterUuidOk returns a tuple with the K8sClusterUuid field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sClusterUuid

func (o *IpConsumer) SetK8sClusterUuid(v string)

SetK8sClusterUuid sets K8sClusterUuid field to given value.

HasK8sClusterUuid

func (o *IpConsumer) HasK8sClusterUuid() bool

HasK8sClusterUuid returns a boolean if a field has been set.

DatacenterElementMetadata

Properties

Name
Type
Description
Notes

Etag

Pointer to string

Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.

[optional] [readonly]

CreatedDate

Pointer to

The last time the resource was created

[optional] [readonly]

CreatedBy

Pointer to string

The user who created the resource.

[optional] [readonly]

CreatedByUserId

Pointer to string

The user id of the user who has created the resource.

[optional] [readonly]

LastModifiedDate

Pointer to

The last time the resource has been modified

[optional] [readonly]

LastModifiedBy

Pointer to string

The user who last modified the resource.

[optional] [readonly]

LastModifiedByUserId

Pointer to string

The user id of the user who has last modified the resource.

[optional] [readonly]

State

Pointer to string

State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool

[optional] [readonly]

Methods

NewDatacenterElementMetadata

func NewDatacenterElementMetadata() *DatacenterElementMetadata

NewDatacenterElementMetadata instantiates a new DatacenterElementMetadata 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

NewDatacenterElementMetadataWithDefaults

func NewDatacenterElementMetadataWithDefaults() *DatacenterElementMetadata

NewDatacenterElementMetadataWithDefaults instantiates a new DatacenterElementMetadata 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

GetEtag

func (o *DatacenterElementMetadata) GetEtag() string

GetEtag returns the Etag field if non-nil, zero value otherwise.

GetEtagOk

func (o *DatacenterElementMetadata) GetEtagOk() (*string, bool)

GetEtagOk returns a tuple with the Etag field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEtag

func (o *DatacenterElementMetadata) SetEtag(v string)

SetEtag sets Etag field to given value.

HasEtag

func (o *DatacenterElementMetadata) HasEtag() bool

HasEtag returns a boolean if a field has been set.

GetCreatedDate

func (o *DatacenterElementMetadata) GetCreatedDate() time.Time

GetCreatedDate returns the CreatedDate field if non-nil, zero value otherwise.

GetCreatedDateOk

func (o *DatacenterElementMetadata) GetCreatedDateOk() (*time.Time, bool)

GetCreatedDateOk returns a tuple with the CreatedDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreatedDate

func (o *DatacenterElementMetadata) SetCreatedDate(v time.Time)

SetCreatedDate sets CreatedDate field to given value.

HasCreatedDate

func (o *DatacenterElementMetadata) HasCreatedDate() bool

HasCreatedDate returns a boolean if a field has been set.

GetCreatedBy

func (o *DatacenterElementMetadata) GetCreatedBy() string

GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise.

GetCreatedByOk

func (o *DatacenterElementMetadata) GetCreatedByOk() (*string, bool)

GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreatedBy

func (o *DatacenterElementMetadata) SetCreatedBy(v string)

SetCreatedBy sets CreatedBy field to given value.

HasCreatedBy

func (o *DatacenterElementMetadata) HasCreatedBy() bool

HasCreatedBy returns a boolean if a field has been set.

GetCreatedByUserId

func (o *DatacenterElementMetadata) GetCreatedByUserId() string

GetCreatedByUserId returns the CreatedByUserId field if non-nil, zero value otherwise.

GetCreatedByUserIdOk

func (o *DatacenterElementMetadata) GetCreatedByUserIdOk() (*string, bool)

GetCreatedByUserIdOk returns a tuple with the CreatedByUserId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreatedByUserId

func (o *DatacenterElementMetadata) SetCreatedByUserId(v string)

SetCreatedByUserId sets CreatedByUserId field to given value.

HasCreatedByUserId

func (o *DatacenterElementMetadata) HasCreatedByUserId() bool

HasCreatedByUserId returns a boolean if a field has been set.

GetLastModifiedDate

func (o *DatacenterElementMetadata) GetLastModifiedDate() time.Time

GetLastModifiedDate returns the LastModifiedDate field if non-nil, zero value otherwise.

GetLastModifiedDateOk

func (o *DatacenterElementMetadata) GetLastModifiedDateOk() (*time.Time, bool)

GetLastModifiedDateOk returns a tuple with the LastModifiedDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLastModifiedDate

func (o *DatacenterElementMetadata) SetLastModifiedDate(v time.Time)

SetLastModifiedDate sets LastModifiedDate field to given value.

HasLastModifiedDate

func (o *DatacenterElementMetadata) HasLastModifiedDate() bool

HasLastModifiedDate returns a boolean if a field has been set.

GetLastModifiedBy

func (o *DatacenterElementMetadata) GetLastModifiedBy() string

GetLastModifiedBy returns the LastModifiedBy field if non-nil, zero value otherwise.

GetLastModifiedByOk

func (o *DatacenterElementMetadata) GetLastModifiedByOk() (*string, bool)

GetLastModifiedByOk returns a tuple with the LastModifiedBy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLastModifiedBy

func (o *DatacenterElementMetadata) SetLastModifiedBy(v string)

SetLastModifiedBy sets LastModifiedBy field to given value.

HasLastModifiedBy

func (o *DatacenterElementMetadata) HasLastModifiedBy() bool

HasLastModifiedBy returns a boolean if a field has been set.

GetLastModifiedByUserId

func (o *DatacenterElementMetadata) GetLastModifiedByUserId() string

GetLastModifiedByUserId returns the LastModifiedByUserId field if non-nil, zero value otherwise.

GetLastModifiedByUserIdOk

func (o *DatacenterElementMetadata) GetLastModifiedByUserIdOk() (*string, bool)

GetLastModifiedByUserIdOk returns a tuple with the LastModifiedByUserId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLastModifiedByUserId

func (o *DatacenterElementMetadata) SetLastModifiedByUserId(v string)

SetLastModifiedByUserId sets LastModifiedByUserId field to given value.

HasLastModifiedByUserId

func (o *DatacenterElementMetadata) HasLastModifiedByUserId() bool

HasLastModifiedByUserId returns a boolean if a field has been set.

GetState

func (o *DatacenterElementMetadata) GetState() string

GetState returns the State field if non-nil, zero value otherwise.

GetStateOk

func (o *DatacenterElementMetadata) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetState

func (o *DatacenterElementMetadata) SetState(v string)

SetState sets State field to given value.

HasState

func (o *DatacenterElementMetadata) HasState() bool

HasState returns a boolean if a field has been set.

GroupProperties

Properties

Name
Type
Description
Notes

Methods

NewGroupProperties

func NewGroupProperties() *GroupProperties

NewGroupProperties instantiates a new GroupProperties 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

NewGroupPropertiesWithDefaults

func NewGroupPropertiesWithDefaults() *GroupProperties

NewGroupPropertiesWithDefaults instantiates a new GroupProperties 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

GetName

func (o *GroupProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *GroupProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *GroupProperties) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *GroupProperties) HasName() bool

HasName returns a boolean if a field has been set.

GetCreateDataCenter

func (o *GroupProperties) GetCreateDataCenter() bool

GetCreateDataCenter returns the CreateDataCenter field if non-nil, zero value otherwise.

GetCreateDataCenterOk

func (o *GroupProperties) GetCreateDataCenterOk() (*bool, bool)

GetCreateDataCenterOk returns a tuple with the CreateDataCenter field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreateDataCenter

func (o *GroupProperties) SetCreateDataCenter(v bool)

SetCreateDataCenter sets CreateDataCenter field to given value.

HasCreateDataCenter

func (o *GroupProperties) HasCreateDataCenter() bool

HasCreateDataCenter returns a boolean if a field has been set.

GetCreateSnapshot

func (o *GroupProperties) GetCreateSnapshot() bool

GetCreateSnapshot returns the CreateSnapshot field if non-nil, zero value otherwise.

GetCreateSnapshotOk

func (o *GroupProperties) GetCreateSnapshotOk() (*bool, bool)

GetCreateSnapshotOk returns a tuple with the CreateSnapshot field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreateSnapshot

func (o *GroupProperties) SetCreateSnapshot(v bool)

SetCreateSnapshot sets CreateSnapshot field to given value.

HasCreateSnapshot

func (o *GroupProperties) HasCreateSnapshot() bool

HasCreateSnapshot returns a boolean if a field has been set.

GetReserveIp

func (o *GroupProperties) GetReserveIp() bool

GetReserveIp returns the ReserveIp field if non-nil, zero value otherwise.

GetReserveIpOk

func (o *GroupProperties) GetReserveIpOk() (*bool, bool)

GetReserveIpOk returns a tuple with the ReserveIp field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetReserveIp

func (o *GroupProperties) SetReserveIp(v bool)

SetReserveIp sets ReserveIp field to given value.

HasReserveIp

func (o *GroupProperties) HasReserveIp() bool

HasReserveIp returns a boolean if a field has been set.

GetAccessActivityLog

func (o *GroupProperties) GetAccessActivityLog() bool

GetAccessActivityLog returns the AccessActivityLog field if non-nil, zero value otherwise.

GetAccessActivityLogOk

func (o *GroupProperties) GetAccessActivityLogOk() (*bool, bool)

GetAccessActivityLogOk returns a tuple with the AccessActivityLog field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAccessActivityLog

func (o *GroupProperties) SetAccessActivityLog(v bool)

SetAccessActivityLog sets AccessActivityLog field to given value.

HasAccessActivityLog

func (o *GroupProperties) HasAccessActivityLog() bool

HasAccessActivityLog returns a boolean if a field has been set.

GetCreatePcc

func (o *GroupProperties) GetCreatePcc() bool

GetCreatePcc returns the CreatePcc field if non-nil, zero value otherwise.

GetCreatePccOk

func (o *GroupProperties) GetCreatePccOk() (*bool, bool)

GetCreatePccOk returns a tuple with the CreatePcc field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreatePcc

func (o *GroupProperties) SetCreatePcc(v bool)

SetCreatePcc sets CreatePcc field to given value.

HasCreatePcc

func (o *GroupProperties) HasCreatePcc() bool

HasCreatePcc returns a boolean if a field has been set.

GetS3Privilege

func (o *GroupProperties) GetS3Privilege() bool

GetS3Privilege returns the S3Privilege field if non-nil, zero value otherwise.

GetS3PrivilegeOk

func (o *GroupProperties) GetS3PrivilegeOk() (*bool, bool)

GetS3PrivilegeOk returns a tuple with the S3Privilege field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetS3Privilege

func (o *GroupProperties) SetS3Privilege(v bool)

SetS3Privilege sets S3Privilege field to given value.

HasS3Privilege

func (o *GroupProperties) HasS3Privilege() bool

HasS3Privilege returns a boolean if a field has been set.

GetCreateBackupUnit

func (o *GroupProperties) GetCreateBackupUnit() bool

GetCreateBackupUnit returns the CreateBackupUnit field if non-nil, zero value otherwise.

GetCreateBackupUnitOk

func (o *GroupProperties) GetCreateBackupUnitOk() (*bool, bool)

GetCreateBackupUnitOk returns a tuple with the CreateBackupUnit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreateBackupUnit

func (o *GroupProperties) SetCreateBackupUnit(v bool)

SetCreateBackupUnit sets CreateBackupUnit field to given value.

HasCreateBackupUnit

func (o *GroupProperties) HasCreateBackupUnit() bool

HasCreateBackupUnit returns a boolean if a field has been set.

GetCreateInternetAccess

func (o *GroupProperties) GetCreateInternetAccess() bool

GetCreateInternetAccess returns the CreateInternetAccess field if non-nil, zero value otherwise.

GetCreateInternetAccessOk

func (o *GroupProperties) GetCreateInternetAccessOk() (*bool, bool)

GetCreateInternetAccessOk returns a tuple with the CreateInternetAccess field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreateInternetAccess

func (o *GroupProperties) SetCreateInternetAccess(v bool)

SetCreateInternetAccess sets CreateInternetAccess field to given value.

HasCreateInternetAccess

func (o *GroupProperties) HasCreateInternetAccess() bool

HasCreateInternetAccess returns a boolean if a field has been set.

GetCreateK8sCluster

func (o *GroupProperties) GetCreateK8sCluster() bool

GetCreateK8sCluster returns the CreateK8sCluster field if non-nil, zero value otherwise.

GetCreateK8sClusterOk

func (o *GroupProperties) GetCreateK8sClusterOk() (*bool, bool)

GetCreateK8sClusterOk returns a tuple with the CreateK8sCluster field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreateK8sCluster

func (o *GroupProperties) SetCreateK8sCluster(v bool)

SetCreateK8sCluster sets CreateK8sCluster field to given value.

HasCreateK8sCluster

func (o *GroupProperties) HasCreateK8sCluster() bool

HasCreateK8sCluster returns a boolean if a field has been set.

KubernetesNodePoolPropertiesForPut

Properties

Name
Type
Description
Notes

Methods

NewKubernetesNodePoolPropertiesForPut

func NewKubernetesNodePoolPropertiesForPut(nodeCount int32, ) *KubernetesNodePoolPropertiesForPut

NewKubernetesNodePoolPropertiesForPut instantiates a new KubernetesNodePoolPropertiesForPut 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

NewKubernetesNodePoolPropertiesForPutWithDefaults

func NewKubernetesNodePoolPropertiesForPutWithDefaults() *KubernetesNodePoolPropertiesForPut

NewKubernetesNodePoolPropertiesForPutWithDefaults instantiates a new KubernetesNodePoolPropertiesForPut 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

GetName

func (o *KubernetesNodePoolPropertiesForPut) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *KubernetesNodePoolPropertiesForPut) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *KubernetesNodePoolPropertiesForPut) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *KubernetesNodePoolPropertiesForPut) HasName() bool

HasName returns a boolean if a field has been set.

GetNodeCount

func (o *KubernetesNodePoolPropertiesForPut) GetNodeCount() int32

GetNodeCount returns the NodeCount field if non-nil, zero value otherwise.

GetNodeCountOk

func (o *KubernetesNodePoolPropertiesForPut) GetNodeCountOk() (*int32, bool)

GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNodeCount

func (o *KubernetesNodePoolPropertiesForPut) SetNodeCount(v int32)

SetNodeCount sets NodeCount field to given value.

GetK8sVersion

func (o *KubernetesNodePoolPropertiesForPut) GetK8sVersion() string

GetK8sVersion returns the K8sVersion field if non-nil, zero value otherwise.

GetK8sVersionOk

func (o *KubernetesNodePoolPropertiesForPut) GetK8sVersionOk() (*string, bool)

GetK8sVersionOk returns a tuple with the K8sVersion field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sVersion

func (o *KubernetesNodePoolPropertiesForPut) SetK8sVersion(v string)

SetK8sVersion sets K8sVersion field to given value.

HasK8sVersion

func (o *KubernetesNodePoolPropertiesForPut) HasK8sVersion() bool

HasK8sVersion returns a boolean if a field has been set.

GetMaintenanceWindow

func (o *KubernetesNodePoolPropertiesForPut) GetMaintenanceWindow() KubernetesMaintenanceWindow

GetMaintenanceWindow returns the MaintenanceWindow field if non-nil, zero value otherwise.

GetMaintenanceWindowOk

func (o *KubernetesNodePoolPropertiesForPut) GetMaintenanceWindowOk() (*KubernetesMaintenanceWindow, bool)

GetMaintenanceWindowOk returns a tuple with the MaintenanceWindow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMaintenanceWindow

func (o *KubernetesNodePoolPropertiesForPut) SetMaintenanceWindow(v KubernetesMaintenanceWindow)

SetMaintenanceWindow sets MaintenanceWindow field to given value.

HasMaintenanceWindow

func (o *KubernetesNodePoolPropertiesForPut) HasMaintenanceWindow() bool

HasMaintenanceWindow returns a boolean if a field has been set.

GetAutoScaling

func (o *KubernetesNodePoolPropertiesForPut) GetAutoScaling() KubernetesAutoScaling

GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise.

GetAutoScalingOk

func (o *KubernetesNodePoolPropertiesForPut) GetAutoScalingOk() (*KubernetesAutoScaling, bool)

GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAutoScaling

func (o *KubernetesNodePoolPropertiesForPut) SetAutoScaling(v KubernetesAutoScaling)

SetAutoScaling sets AutoScaling field to given value.

HasAutoScaling

func (o *KubernetesNodePoolPropertiesForPut) HasAutoScaling() bool

HasAutoScaling returns a boolean if a field has been set.

GetLans

func (o *KubernetesNodePoolPropertiesForPut) GetLans() []KubernetesNodePoolLan

GetLans returns the Lans field if non-nil, zero value otherwise.

GetLansOk

func (o *KubernetesNodePoolPropertiesForPut) GetLansOk() (*[]KubernetesNodePoolLan, bool)

GetLansOk returns a tuple with the Lans field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLans

func (o *KubernetesNodePoolPropertiesForPut) SetLans(v []KubernetesNodePoolLan)

SetLans sets Lans field to given value.

HasLans

func (o *KubernetesNodePoolPropertiesForPut) HasLans() bool

HasLans returns a boolean if a field has been set.

GetLabels

func (o *KubernetesNodePoolPropertiesForPut) GetLabels() map[string]string

GetLabels returns the Labels field if non-nil, zero value otherwise.

GetLabelsOk

func (o *KubernetesNodePoolPropertiesForPut) GetLabelsOk() (*map[string]string, bool)

GetLabelsOk returns a tuple with the Labels field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLabels

func (o *KubernetesNodePoolPropertiesForPut) SetLabels(v map[string]string)

SetLabels sets Labels field to given value.

HasLabels

func (o *KubernetesNodePoolPropertiesForPut) HasLabels() bool

HasLabels returns a boolean if a field has been set.

GetAnnotations

func (o *KubernetesNodePoolPropertiesForPut) GetAnnotations() map[string]string

GetAnnotations returns the Annotations field if non-nil, zero value otherwise.

GetAnnotationsOk

func (o *KubernetesNodePoolPropertiesForPut) GetAnnotationsOk() (*map[string]string, bool)

GetAnnotationsOk returns a tuple with the Annotations field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAnnotations

func (o *KubernetesNodePoolPropertiesForPut) SetAnnotations(v map[string]string)

SetAnnotations sets Annotations field to given value.

HasAnnotations

func (o *KubernetesNodePoolPropertiesForPut) HasAnnotations() bool

HasAnnotations returns a boolean if a field has been set.

GetPublicIps

func (o *KubernetesNodePoolPropertiesForPut) GetPublicIps() []string

GetPublicIps returns the PublicIps field if non-nil, zero value otherwise.

GetPublicIpsOk

func (o *KubernetesNodePoolPropertiesForPut) GetPublicIpsOk() (*[]string, bool)

GetPublicIpsOk returns a tuple with the PublicIps field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPublicIps

func (o *KubernetesNodePoolPropertiesForPut) SetPublicIps(v []string)

SetPublicIps sets PublicIps field to given value.

HasPublicIps

func (o *KubernetesNodePoolPropertiesForPut) HasPublicIps() bool

HasPublicIps returns a boolean if a field has been set.

Name

Pointer to string

A name of that resource

[optional]

CreateDataCenter

Pointer to bool

create data center privilege

[optional]

CreateSnapshot

Pointer to bool

create snapshot privilege

[optional]

ReserveIp

Pointer to bool

reserve ip block privilege

[optional]

AccessActivityLog

Pointer to bool

activity log access privilege

[optional]

CreatePcc

Pointer to bool

create pcc privilege

[optional]

S3Privilege

Pointer to bool

S3 privilege

[optional]

CreateBackupUnit

Pointer to bool

create backup unit privilege

[optional]

CreateInternetAccess

Pointer to bool

create internet access privilege

[optional]

CreateK8sCluster

Pointer to bool

create kubernetes cluster privilege

[optional]

Name

Pointer to string

A Kubernetes Node Pool Name. Valid Kubernetes Node Pool name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

[optional]

NodeCount

int32

Number of nodes part of the Node Pool

K8sVersion

Pointer to string

The kubernetes version in which a nodepool is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions.

[optional]

MaintenanceWindow

Pointer to KubernetesMaintenanceWindow

[optional]

AutoScaling

Pointer to KubernetesAutoScaling

[optional]

Lans

Pointer to []KubernetesNodePoolLan

array of additional LANs attached to worker nodes

[optional]

Labels

Pointer to map[string]string

map of labels attached to node pool

[optional]

Annotations

Pointer to map[string]string

map of annotations attached to node pool

[optional]

PublicIps

Pointer to []string

Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes.

[optional]

time.Time
time.Time

FirewallRules

Properties

Name
Type
Description
Notes

Id

Pointer to string

The resource's unique identifier

[optional] [readonly]

Type

Pointer to

The type of object that has been created

[optional]

Href

Pointer to string

URL to the object representation (absolute path)

[optional] [readonly]

Items

Pointer to

Array of items in that collection

[optional] [readonly]

Offset

Pointer to float32

the offset (if specified in the request)

[optional]

Limit

Pointer to float32

the limit (if specified in the request)

[optional]

Links

Pointer to

[optional]

Methods

NewFirewallRules

func NewFirewallRules() *FirewallRules

NewFirewallRules instantiates a new FirewallRules 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

NewFirewallRulesWithDefaults

func NewFirewallRulesWithDefaults() *FirewallRules

NewFirewallRulesWithDefaults instantiates a new FirewallRules 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

GetId

func (o *FirewallRules) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *FirewallRules) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *FirewallRules) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *FirewallRules) HasId() bool

HasId returns a boolean if a field has been set.

GetType

func (o *FirewallRules) GetType() Type

GetType returns the Type field if non-nil, zero value otherwise.

GetTypeOk

func (o *FirewallRules) GetTypeOk() (*Type, bool)

GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetType

func (o *FirewallRules) SetType(v Type)

SetType sets Type field to given value.

HasType

func (o *FirewallRules) HasType() bool

HasType returns a boolean if a field has been set.

GetHref

func (o *FirewallRules) GetHref() string

GetHref returns the Href field if non-nil, zero value otherwise.

GetHrefOk

func (o *FirewallRules) GetHrefOk() (*string, bool)

GetHrefOk returns a tuple with the Href field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHref

func (o *FirewallRules) SetHref(v string)

SetHref sets Href field to given value.

HasHref

func (o *FirewallRules) HasHref() bool

HasHref returns a boolean if a field has been set.

GetItems

func (o *FirewallRules) GetItems() []FirewallRule

GetItems returns the Items field if non-nil, zero value otherwise.

GetItemsOk

func (o *FirewallRules) GetItemsOk() (*[]FirewallRule, bool)

GetItemsOk returns a tuple with the Items field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetItems

func (o *FirewallRules) SetItems(v []FirewallRule)

SetItems sets Items field to given value.

HasItems

func (o *FirewallRules) HasItems() bool

HasItems returns a boolean if a field has been set.

GetOffset

func (o *FirewallRules) GetOffset() float32

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *FirewallRules) GetOffsetOk() (*float32, bool)

GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *FirewallRules) SetOffset(v float32)

SetOffset sets Offset field to given value.

HasOffset

func (o *FirewallRules) HasOffset() bool

HasOffset returns a boolean if a field has been set.

GetLimit

func (o *FirewallRules) GetLimit() float32

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *FirewallRules) GetLimitOk() (*float32, bool)

GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *FirewallRules) SetLimit(v float32)

SetLimit sets Limit field to given value.

HasLimit

func (o *FirewallRules) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetLinks

func (o *FirewallRules) GetLinks() PaginationLinks

GetLinks returns the Links field if non-nil, zero value otherwise.

GetLinksOk

func (o *FirewallRules) GetLinksOk() (*PaginationLinks, bool)

GetLinksOk returns a tuple with the Links field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLinks

func (o *FirewallRules) SetLinks(v PaginationLinks)

SetLinks sets Links field to given value.

HasLinks

func (o *FirewallRules) HasLinks() bool

HasLinks returns a boolean if a field has been set.

LocationApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

LocationsFindByRegionId

List Locations within a region

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiLocationsFindByRegionIdRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

LocationsFindByRegionIdAndId

Retrieve a Location

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiLocationsFindByRegionIdAndIdRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

LocationsGet

List Locations

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiLocationsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

Type
[]FirewallRule
PaginationLinks

LocationsFindByRegionId

Get /locations/{regionId}

List Locations within a region

LocationsFindByRegionIdAndId

Get /locations/{regionId}/{locationId}

Retrieve a Location

LocationsGet

Get /locations

List Locations

var result Locations = LocationsFindByRegionId(ctx, regionId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    regionId := "regionId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LocationApi.LocationsFindByRegionId(context.Background(), regionId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LocationApi.LocationsFindByRegionId``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LocationsFindByRegionId`: Locations
    fmt.Fprintf(os.Stdout, "Response from `LocationApi.LocationsFindByRegionId`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

regionId

string

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result Location = LocationsFindByRegionIdAndId(ctx, regionId, locationId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    regionId := "regionId_example" // string | 
    locationId := "locationId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LocationApi.LocationsFindByRegionIdAndId(context.Background(), regionId, locationId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LocationApi.LocationsFindByRegionIdAndId``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LocationsFindByRegionIdAndId`: Location
    fmt.Fprintf(os.Stdout, "Response from `LocationApi.LocationsFindByRegionIdAndId`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

regionId

string

locationId

string

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result Locations = LocationsGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LocationApi.LocationsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LocationApi.LocationsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LocationsGet`: Locations
    fmt.Fprintf(os.Stdout, "Response from `LocationApi.LocationsGet`: %v\n", resp)
}

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Locations
Location
Locations

KubernetesNodePoolPropertiesForPost

Properties

Name
Type
Description
Notes

Name

string

A Kubernetes Node Pool Name. Valid Kubernetes Node Pool name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

DatacenterId

string

A valid uuid of the datacenter on which user has access

NodeCount

int32

Number of nodes part of the Node Pool

CpuFamily

string

A valid cpu family name

CoresCount

int32

Number of cores for node

RamSize

int32

RAM size for node, minimum size is 2048MB. Ram size must be set to multiple of 1024MB.

AvailabilityZone

string

The availability zone in which the target VM should exist

StorageType

string

Hardware type of the volume

StorageSize

int32

The size of the volume in GB. The size should be greater than 10GB.

K8sVersion

Pointer to string

The kubernetes version in which a nodepool is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions.

[optional]

MaintenanceWindow

Pointer to

[optional]

AutoScaling

Pointer to

[optional]

Lans

Pointer to

array of additional LANs attached to worker nodes

[optional]

Labels

Pointer to map[string]string

map of labels attached to node pool

[optional]

Annotations

Pointer to map[string]string

map of annotations attached to node pool

[optional]

PublicIps

Pointer to []string

Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes.

[optional]

Methods

NewKubernetesNodePoolPropertiesForPost

func NewKubernetesNodePoolPropertiesForPost(name string, datacenterId string, nodeCount int32, cpuFamily string, coresCount int32, ramSize int32, availabilityZone string, storageType string, storageSize int32, ) *KubernetesNodePoolPropertiesForPost

NewKubernetesNodePoolPropertiesForPost instantiates a new KubernetesNodePoolPropertiesForPost 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

NewKubernetesNodePoolPropertiesForPostWithDefaults

func NewKubernetesNodePoolPropertiesForPostWithDefaults() *KubernetesNodePoolPropertiesForPost

NewKubernetesNodePoolPropertiesForPostWithDefaults instantiates a new KubernetesNodePoolPropertiesForPost 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

GetName

func (o *KubernetesNodePoolPropertiesForPost) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *KubernetesNodePoolPropertiesForPost) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *KubernetesNodePoolPropertiesForPost) SetName(v string)

SetName sets Name field to given value.

GetDatacenterId

func (o *KubernetesNodePoolPropertiesForPost) GetDatacenterId() string

GetDatacenterId returns the DatacenterId field if non-nil, zero value otherwise.

GetDatacenterIdOk

func (o *KubernetesNodePoolPropertiesForPost) GetDatacenterIdOk() (*string, bool)

GetDatacenterIdOk returns a tuple with the DatacenterId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDatacenterId

func (o *KubernetesNodePoolPropertiesForPost) SetDatacenterId(v string)

SetDatacenterId sets DatacenterId field to given value.

GetNodeCount

func (o *KubernetesNodePoolPropertiesForPost) GetNodeCount() int32

GetNodeCount returns the NodeCount field if non-nil, zero value otherwise.

GetNodeCountOk

func (o *KubernetesNodePoolPropertiesForPost) GetNodeCountOk() (*int32, bool)

GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNodeCount

func (o *KubernetesNodePoolPropertiesForPost) SetNodeCount(v int32)

SetNodeCount sets NodeCount field to given value.

GetCpuFamily

func (o *KubernetesNodePoolPropertiesForPost) GetCpuFamily() string

GetCpuFamily returns the CpuFamily field if non-nil, zero value otherwise.

GetCpuFamilyOk

func (o *KubernetesNodePoolPropertiesForPost) GetCpuFamilyOk() (*string, bool)

GetCpuFamilyOk returns a tuple with the CpuFamily field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCpuFamily

func (o *KubernetesNodePoolPropertiesForPost) SetCpuFamily(v string)

SetCpuFamily sets CpuFamily field to given value.

GetCoresCount

func (o *KubernetesNodePoolPropertiesForPost) GetCoresCount() int32

GetCoresCount returns the CoresCount field if non-nil, zero value otherwise.

GetCoresCountOk

func (o *KubernetesNodePoolPropertiesForPost) GetCoresCountOk() (*int32, bool)

GetCoresCountOk returns a tuple with the CoresCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCoresCount

func (o *KubernetesNodePoolPropertiesForPost) SetCoresCount(v int32)

SetCoresCount sets CoresCount field to given value.

GetRamSize

func (o *KubernetesNodePoolPropertiesForPost) GetRamSize() int32

GetRamSize returns the RamSize field if non-nil, zero value otherwise.

GetRamSizeOk

func (o *KubernetesNodePoolPropertiesForPost) GetRamSizeOk() (*int32, bool)

GetRamSizeOk returns a tuple with the RamSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRamSize

func (o *KubernetesNodePoolPropertiesForPost) SetRamSize(v int32)

SetRamSize sets RamSize field to given value.

GetAvailabilityZone

func (o *KubernetesNodePoolPropertiesForPost) GetAvailabilityZone() string

GetAvailabilityZone returns the AvailabilityZone field if non-nil, zero value otherwise.

GetAvailabilityZoneOk

func (o *KubernetesNodePoolPropertiesForPost) GetAvailabilityZoneOk() (*string, bool)

GetAvailabilityZoneOk returns a tuple with the AvailabilityZone field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAvailabilityZone

func (o *KubernetesNodePoolPropertiesForPost) SetAvailabilityZone(v string)

SetAvailabilityZone sets AvailabilityZone field to given value.

GetStorageType

func (o *KubernetesNodePoolPropertiesForPost) GetStorageType() string

GetStorageType returns the StorageType field if non-nil, zero value otherwise.

GetStorageTypeOk

func (o *KubernetesNodePoolPropertiesForPost) GetStorageTypeOk() (*string, bool)

GetStorageTypeOk returns a tuple with the StorageType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStorageType

func (o *KubernetesNodePoolPropertiesForPost) SetStorageType(v string)

SetStorageType sets StorageType field to given value.

GetStorageSize

func (o *KubernetesNodePoolPropertiesForPost) GetStorageSize() int32

GetStorageSize returns the StorageSize field if non-nil, zero value otherwise.

GetStorageSizeOk

func (o *KubernetesNodePoolPropertiesForPost) GetStorageSizeOk() (*int32, bool)

GetStorageSizeOk returns a tuple with the StorageSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStorageSize

func (o *KubernetesNodePoolPropertiesForPost) SetStorageSize(v int32)

SetStorageSize sets StorageSize field to given value.

GetK8sVersion

func (o *KubernetesNodePoolPropertiesForPost) GetK8sVersion() string

GetK8sVersion returns the K8sVersion field if non-nil, zero value otherwise.

GetK8sVersionOk

func (o *KubernetesNodePoolPropertiesForPost) GetK8sVersionOk() (*string, bool)

GetK8sVersionOk returns a tuple with the K8sVersion field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sVersion

func (o *KubernetesNodePoolPropertiesForPost) SetK8sVersion(v string)

SetK8sVersion sets K8sVersion field to given value.

HasK8sVersion

func (o *KubernetesNodePoolPropertiesForPost) HasK8sVersion() bool

HasK8sVersion returns a boolean if a field has been set.

GetMaintenanceWindow

func (o *KubernetesNodePoolPropertiesForPost) GetMaintenanceWindow() KubernetesMaintenanceWindow

GetMaintenanceWindow returns the MaintenanceWindow field if non-nil, zero value otherwise.

GetMaintenanceWindowOk

func (o *KubernetesNodePoolPropertiesForPost) GetMaintenanceWindowOk() (*KubernetesMaintenanceWindow, bool)

GetMaintenanceWindowOk returns a tuple with the MaintenanceWindow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMaintenanceWindow

func (o *KubernetesNodePoolPropertiesForPost) SetMaintenanceWindow(v KubernetesMaintenanceWindow)

SetMaintenanceWindow sets MaintenanceWindow field to given value.

HasMaintenanceWindow

func (o *KubernetesNodePoolPropertiesForPost) HasMaintenanceWindow() bool

HasMaintenanceWindow returns a boolean if a field has been set.

GetAutoScaling

func (o *KubernetesNodePoolPropertiesForPost) GetAutoScaling() KubernetesAutoScaling

GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise.

GetAutoScalingOk

func (o *KubernetesNodePoolPropertiesForPost) GetAutoScalingOk() (*KubernetesAutoScaling, bool)

GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAutoScaling

func (o *KubernetesNodePoolPropertiesForPost) SetAutoScaling(v KubernetesAutoScaling)

SetAutoScaling sets AutoScaling field to given value.

HasAutoScaling

func (o *KubernetesNodePoolPropertiesForPost) HasAutoScaling() bool

HasAutoScaling returns a boolean if a field has been set.

GetLans

func (o *KubernetesNodePoolPropertiesForPost) GetLans() []KubernetesNodePoolLan

GetLans returns the Lans field if non-nil, zero value otherwise.

GetLansOk

func (o *KubernetesNodePoolPropertiesForPost) GetLansOk() (*[]KubernetesNodePoolLan, bool)

GetLansOk returns a tuple with the Lans field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLans

func (o *KubernetesNodePoolPropertiesForPost) SetLans(v []KubernetesNodePoolLan)

SetLans sets Lans field to given value.

HasLans

func (o *KubernetesNodePoolPropertiesForPost) HasLans() bool

HasLans returns a boolean if a field has been set.

GetLabels

func (o *KubernetesNodePoolPropertiesForPost) GetLabels() map[string]string

GetLabels returns the Labels field if non-nil, zero value otherwise.

GetLabelsOk

func (o *KubernetesNodePoolPropertiesForPost) GetLabelsOk() (*map[string]string, bool)

GetLabelsOk returns a tuple with the Labels field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLabels

func (o *KubernetesNodePoolPropertiesForPost) SetLabels(v map[string]string)

SetLabels sets Labels field to given value.

HasLabels

func (o *KubernetesNodePoolPropertiesForPost) HasLabels() bool

HasLabels returns a boolean if a field has been set.

GetAnnotations

func (o *KubernetesNodePoolPropertiesForPost) GetAnnotations() map[string]string

GetAnnotations returns the Annotations field if non-nil, zero value otherwise.

GetAnnotationsOk

func (o *KubernetesNodePoolPropertiesForPost) GetAnnotationsOk() (*map[string]string, bool)

GetAnnotationsOk returns a tuple with the Annotations field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAnnotations

func (o *KubernetesNodePoolPropertiesForPost) SetAnnotations(v map[string]string)

SetAnnotations sets Annotations field to given value.

HasAnnotations

func (o *KubernetesNodePoolPropertiesForPost) HasAnnotations() bool

HasAnnotations returns a boolean if a field has been set.

GetPublicIps

func (o *KubernetesNodePoolPropertiesForPost) GetPublicIps() []string

GetPublicIps returns the PublicIps field if non-nil, zero value otherwise.

GetPublicIpsOk

func (o *KubernetesNodePoolPropertiesForPost) GetPublicIpsOk() (*[]string, bool)

GetPublicIpsOk returns a tuple with the PublicIps field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPublicIps

func (o *KubernetesNodePoolPropertiesForPost) SetPublicIps(v []string)

SetPublicIps sets PublicIps field to given value.

HasPublicIps

func (o *KubernetesNodePoolPropertiesForPost) HasPublicIps() bool

HasPublicIps returns a boolean if a field has been set.

KubernetesMaintenanceWindow
KubernetesAutoScaling
[]KubernetesNodePoolLan

KubernetesNodePoolProperties

Properties

Name
Type
Description
Notes

Name

string

A Kubernetes Node Pool Name. Valid Kubernetes Node Pool name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

DatacenterId

string

A valid uuid of the datacenter on which user has access

NodeCount

int32

Number of nodes part of the Node Pool

CpuFamily

string

A valid cpu family name

CoresCount

int32

Number of cores for node

RamSize

int32

RAM size for node, minimum size is 2048MB. Ram size must be set to multiple of 1024MB.

AvailabilityZone

string

The availability zone in which the target VM should exist

StorageType

string

Hardware type of the volume

StorageSize

int32

The size of the volume in GB. The size should be greater than 10GB.

K8sVersion

Pointer to string

The kubernetes version in which a nodepool is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions.

[optional]

MaintenanceWindow

Pointer to

[optional]

AutoScaling

Pointer to

[optional]

Lans

Pointer to

array of additional LANs attached to worker nodes

[optional]

Labels

Pointer to map[string]string

map of labels attached to node pool

[optional]

Annotations

Pointer to map[string]string

map of annotations attached to node pool

[optional]

PublicIps

Pointer to []string

Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes.

[optional]

AvailableUpgradeVersions

Pointer to []string

List of available versions for upgrading the node pool

[optional]

Methods

NewKubernetesNodePoolProperties

func NewKubernetesNodePoolProperties(name string, datacenterId string, nodeCount int32, cpuFamily string, coresCount int32, ramSize int32, availabilityZone string, storageType string, storageSize int32, ) *KubernetesNodePoolProperties

NewKubernetesNodePoolProperties instantiates a new KubernetesNodePoolProperties 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

NewKubernetesNodePoolPropertiesWithDefaults

func NewKubernetesNodePoolPropertiesWithDefaults() *KubernetesNodePoolProperties

NewKubernetesNodePoolPropertiesWithDefaults instantiates a new KubernetesNodePoolProperties 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

GetName

func (o *KubernetesNodePoolProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *KubernetesNodePoolProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *KubernetesNodePoolProperties) SetName(v string)

SetName sets Name field to given value.

GetDatacenterId

func (o *KubernetesNodePoolProperties) GetDatacenterId() string

GetDatacenterId returns the DatacenterId field if non-nil, zero value otherwise.

GetDatacenterIdOk

func (o *KubernetesNodePoolProperties) GetDatacenterIdOk() (*string, bool)

GetDatacenterIdOk returns a tuple with the DatacenterId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDatacenterId

func (o *KubernetesNodePoolProperties) SetDatacenterId(v string)

SetDatacenterId sets DatacenterId field to given value.

GetNodeCount

func (o *KubernetesNodePoolProperties) GetNodeCount() int32

GetNodeCount returns the NodeCount field if non-nil, zero value otherwise.

GetNodeCountOk

func (o *KubernetesNodePoolProperties) GetNodeCountOk() (*int32, bool)

GetNodeCountOk returns a tuple with the NodeCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNodeCount

func (o *KubernetesNodePoolProperties) SetNodeCount(v int32)

SetNodeCount sets NodeCount field to given value.

GetCpuFamily

func (o *KubernetesNodePoolProperties) GetCpuFamily() string

GetCpuFamily returns the CpuFamily field if non-nil, zero value otherwise.

GetCpuFamilyOk

func (o *KubernetesNodePoolProperties) GetCpuFamilyOk() (*string, bool)

GetCpuFamilyOk returns a tuple with the CpuFamily field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCpuFamily

func (o *KubernetesNodePoolProperties) SetCpuFamily(v string)

SetCpuFamily sets CpuFamily field to given value.

GetCoresCount

func (o *KubernetesNodePoolProperties) GetCoresCount() int32

GetCoresCount returns the CoresCount field if non-nil, zero value otherwise.

GetCoresCountOk

func (o *KubernetesNodePoolProperties) GetCoresCountOk() (*int32, bool)

GetCoresCountOk returns a tuple with the CoresCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCoresCount

func (o *KubernetesNodePoolProperties) SetCoresCount(v int32)

SetCoresCount sets CoresCount field to given value.

GetRamSize

func (o *KubernetesNodePoolProperties) GetRamSize() int32

GetRamSize returns the RamSize field if non-nil, zero value otherwise.

GetRamSizeOk

func (o *KubernetesNodePoolProperties) GetRamSizeOk() (*int32, bool)

GetRamSizeOk returns a tuple with the RamSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRamSize

func (o *KubernetesNodePoolProperties) SetRamSize(v int32)

SetRamSize sets RamSize field to given value.

GetAvailabilityZone

func (o *KubernetesNodePoolProperties) GetAvailabilityZone() string

GetAvailabilityZone returns the AvailabilityZone field if non-nil, zero value otherwise.

GetAvailabilityZoneOk

func (o *KubernetesNodePoolProperties) GetAvailabilityZoneOk() (*string, bool)

GetAvailabilityZoneOk returns a tuple with the AvailabilityZone field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAvailabilityZone

func (o *KubernetesNodePoolProperties) SetAvailabilityZone(v string)

SetAvailabilityZone sets AvailabilityZone field to given value.

GetStorageType

func (o *KubernetesNodePoolProperties) GetStorageType() string

GetStorageType returns the StorageType field if non-nil, zero value otherwise.

GetStorageTypeOk

func (o *KubernetesNodePoolProperties) GetStorageTypeOk() (*string, bool)

GetStorageTypeOk returns a tuple with the StorageType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStorageType

func (o *KubernetesNodePoolProperties) SetStorageType(v string)

SetStorageType sets StorageType field to given value.

GetStorageSize

func (o *KubernetesNodePoolProperties) GetStorageSize() int32

GetStorageSize returns the StorageSize field if non-nil, zero value otherwise.

GetStorageSizeOk

func (o *KubernetesNodePoolProperties) GetStorageSizeOk() (*int32, bool)

GetStorageSizeOk returns a tuple with the StorageSize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStorageSize

func (o *KubernetesNodePoolProperties) SetStorageSize(v int32)

SetStorageSize sets StorageSize field to given value.

GetK8sVersion

func (o *KubernetesNodePoolProperties) GetK8sVersion() string

GetK8sVersion returns the K8sVersion field if non-nil, zero value otherwise.

GetK8sVersionOk

func (o *KubernetesNodePoolProperties) GetK8sVersionOk() (*string, bool)

GetK8sVersionOk returns a tuple with the K8sVersion field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetK8sVersion

func (o *KubernetesNodePoolProperties) SetK8sVersion(v string)

SetK8sVersion sets K8sVersion field to given value.

HasK8sVersion

func (o *KubernetesNodePoolProperties) HasK8sVersion() bool

HasK8sVersion returns a boolean if a field has been set.

GetMaintenanceWindow

func (o *KubernetesNodePoolProperties) GetMaintenanceWindow() KubernetesMaintenanceWindow

GetMaintenanceWindow returns the MaintenanceWindow field if non-nil, zero value otherwise.

GetMaintenanceWindowOk

func (o *KubernetesNodePoolProperties) GetMaintenanceWindowOk() (*KubernetesMaintenanceWindow, bool)

GetMaintenanceWindowOk returns a tuple with the MaintenanceWindow field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMaintenanceWindow

func (o *KubernetesNodePoolProperties) SetMaintenanceWindow(v KubernetesMaintenanceWindow)

SetMaintenanceWindow sets MaintenanceWindow field to given value.

HasMaintenanceWindow

func (o *KubernetesNodePoolProperties) HasMaintenanceWindow() bool

HasMaintenanceWindow returns a boolean if a field has been set.

GetAutoScaling

func (o *KubernetesNodePoolProperties) GetAutoScaling() KubernetesAutoScaling

GetAutoScaling returns the AutoScaling field if non-nil, zero value otherwise.

GetAutoScalingOk

func (o *KubernetesNodePoolProperties) GetAutoScalingOk() (*KubernetesAutoScaling, bool)

GetAutoScalingOk returns a tuple with the AutoScaling field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAutoScaling

func (o *KubernetesNodePoolProperties) SetAutoScaling(v KubernetesAutoScaling)

SetAutoScaling sets AutoScaling field to given value.

HasAutoScaling

func (o *KubernetesNodePoolProperties) HasAutoScaling() bool

HasAutoScaling returns a boolean if a field has been set.

GetLans

func (o *KubernetesNodePoolProperties) GetLans() []KubernetesNodePoolLan

GetLans returns the Lans field if non-nil, zero value otherwise.

GetLansOk

func (o *KubernetesNodePoolProperties) GetLansOk() (*[]KubernetesNodePoolLan, bool)

GetLansOk returns a tuple with the Lans field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLans

func (o *KubernetesNodePoolProperties) SetLans(v []KubernetesNodePoolLan)

SetLans sets Lans field to given value.

HasLans

func (o *KubernetesNodePoolProperties) HasLans() bool

HasLans returns a boolean if a field has been set.

GetLabels

func (o *KubernetesNodePoolProperties) GetLabels() map[string]string

GetLabels returns the Labels field if non-nil, zero value otherwise.

GetLabelsOk

func (o *KubernetesNodePoolProperties) GetLabelsOk() (*map[string]string, bool)

GetLabelsOk returns a tuple with the Labels field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLabels

func (o *KubernetesNodePoolProperties) SetLabels(v map[string]string)

SetLabels sets Labels field to given value.

HasLabels

func (o *KubernetesNodePoolProperties) HasLabels() bool

HasLabels returns a boolean if a field has been set.

GetAnnotations

func (o *KubernetesNodePoolProperties) GetAnnotations() map[string]string

GetAnnotations returns the Annotations field if non-nil, zero value otherwise.

GetAnnotationsOk

func (o *KubernetesNodePoolProperties) GetAnnotationsOk() (*map[string]string, bool)

GetAnnotationsOk returns a tuple with the Annotations field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAnnotations

func (o *KubernetesNodePoolProperties) SetAnnotations(v map[string]string)

SetAnnotations sets Annotations field to given value.

HasAnnotations

func (o *KubernetesNodePoolProperties) HasAnnotations() bool

HasAnnotations returns a boolean if a field has been set.

GetPublicIps

func (o *KubernetesNodePoolProperties) GetPublicIps() []string

GetPublicIps returns the PublicIps field if non-nil, zero value otherwise.

GetPublicIpsOk

func (o *KubernetesNodePoolProperties) GetPublicIpsOk() (*[]string, bool)

GetPublicIpsOk returns a tuple with the PublicIps field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPublicIps

func (o *KubernetesNodePoolProperties) SetPublicIps(v []string)

SetPublicIps sets PublicIps field to given value.

HasPublicIps

func (o *KubernetesNodePoolProperties) HasPublicIps() bool

HasPublicIps returns a boolean if a field has been set.

GetAvailableUpgradeVersions

func (o *KubernetesNodePoolProperties) GetAvailableUpgradeVersions() []string

GetAvailableUpgradeVersions returns the AvailableUpgradeVersions field if non-nil, zero value otherwise.

GetAvailableUpgradeVersionsOk

func (o *KubernetesNodePoolProperties) GetAvailableUpgradeVersionsOk() (*[]string, bool)

GetAvailableUpgradeVersionsOk returns a tuple with the AvailableUpgradeVersions field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAvailableUpgradeVersions

func (o *KubernetesNodePoolProperties) SetAvailableUpgradeVersions(v []string)

SetAvailableUpgradeVersions sets AvailableUpgradeVersions field to given value.

HasAvailableUpgradeVersions

func (o *KubernetesNodePoolProperties) HasAvailableUpgradeVersions() bool

HasAvailableUpgradeVersions returns a boolean if a field has been set.

RequestApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

RequestsFindById

Retrieve a Request

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiRequestsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

RequestsGet

List Requests

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiRequestsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

RequestsStatusGet

Retrieve Request Status

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiRequestsStatusGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

KubernetesMaintenanceWindow
KubernetesAutoScaling
[]KubernetesNodePoolLan

RequestsFindById

Get /requests/{requestId}

Retrieve a Request

RequestsGet

Get /requests

List Requests

RequestsStatusGet

Get /requests/{requestId}/status

Retrieve Request Status

var result Request = RequestsFindById(ctx, requestId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    requestId := "requestId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.RequestApi.RequestsFindById(context.Background(), requestId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RequestApi.RequestsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RequestsFindById`: Request
    fmt.Fprintf(os.Stdout, "Response from `RequestApi.RequestsFindById`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

requestId

string

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result Requests = RequestsGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .FilterStatus(filterStatus)
                      .FilterCreatedAfter(filterCreatedAfter)
                      .FilterCreatedBefore(filterCreatedBefore)
                      .FilterCreatedDate(filterCreatedDate)
                      .FilterCreatedBy(filterCreatedBy)
                      .FilterEtag(filterEtag)
                      .FilterRequestStatus(filterRequestStatus)
                      .FilterMethod(filterMethod)
                      .FilterHeaders(filterHeaders)
                      .FilterBody(filterBody)
                      .FilterUrl(filterUrl)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    filterStatus := "filterStatus_example" // string | Request filter to fetch all requests based on a particular status [QUEUED, RUNNING, DONE, FAILED]. It doesn't depend on depth query parameter (optional)
    filterCreatedAfter := "filterCreatedAfter_example" // string | Request filter to fetch all requests created after the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00 (optional)
    filterCreatedBefore := "filterCreatedBefore_example" // string | Request filter to fetch all requests created before the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00 (optional)
    filterCreatedDate := "filterCreatedDate_example" // string | Response filter to select and display only the requests that contains the specified createdDate. The value is case insensitive and it  depends on depth query parameter that should have a value greater than 0. Date format e.g. 2020-11-16T17:42:59Z (optional)
    filterCreatedBy := "filterCreatedBy_example" // string | Response filter to select and display only the requests that contains the specified createdBy. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.  (optional)
    filterEtag := "filterEtag_example" // string | Response filter to select and display only the requests that contains the specified etag. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.  (optional)
    filterRequestStatus := "filterRequestStatus_example" // string | Response filter to select and display only the requests that contains the specified requestStatus. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.  (optional)
    filterMethod := "filterMethod_example" // string | Response filter to select and display only the requests that contains the specified method. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.  (optional)
    filterHeaders := "filterHeaders_example" // string | Response filter to select and display only the requests that contains the specified headers. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.  (optional)
    filterBody := "filterBody_example" // string | Response filter to select and display only the requests that contains the specified body. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.  (optional)
    filterUrl := "filterUrl_example" // string | Response filter to select and display only the requests that contains the specified url. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.  (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.RequestApi.RequestsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).FilterStatus(filterStatus).FilterCreatedAfter(filterCreatedAfter).FilterCreatedBefore(filterCreatedBefore).FilterCreatedDate(filterCreatedDate).FilterCreatedBy(filterCreatedBy).FilterEtag(filterEtag).FilterRequestStatus(filterRequestStatus).FilterMethod(filterMethod).FilterHeaders(filterHeaders).FilterBody(filterBody).FilterUrl(filterUrl).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RequestApi.RequestsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RequestsGet`: Requests
    fmt.Fprintf(os.Stdout, "Response from `RequestApi.RequestsGet`: %v\n", resp)
}

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

filterStatus

string

Request filter to fetch all requests based on a particular status [QUEUED, RUNNING, DONE, FAILED]. It doesn't depend on depth query parameter

filterCreatedAfter

string

Request filter to fetch all requests created after the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00

filterCreatedBefore

string

Request filter to fetch all requests created before the specified date. It doesn't depend on depth query parameter. Date format e.g. 2021-01-01+00:00:00

filterCreatedDate

string

Response filter to select and display only the requests that contains the specified createdDate. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0. Date format e.g. 2020-11-16T17:42:59Z

filterCreatedBy

string

Response filter to select and display only the requests that contains the specified createdBy. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.

filterEtag

string

Response filter to select and display only the requests that contains the specified etag. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.

filterRequestStatus

string

Response filter to select and display only the requests that contains the specified requestStatus. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.

filterMethod

string

Response filter to select and display only the requests that contains the specified method. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.

filterHeaders

string

Response filter to select and display only the requests that contains the specified headers. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.

filterBody

string

Response filter to select and display only the requests that contains the specified body. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.

filterUrl

string

Response filter to select and display only the requests that contains the specified url. The value is case insensitive and it depends on depth query parameter that should have a value greater than 0.

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

var result RequestStatus = RequestsStatusGet(ctx, requestId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    requestId := "requestId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.RequestApi.RequestsStatusGet(context.Background(), requestId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RequestApi.RequestsStatusGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RequestsStatusGet`: RequestStatus
    fmt.Fprintf(os.Stdout, "Response from `RequestApi.RequestsStatusGet`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

requestId

string

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Request
Requests
RequestStatus

ImageProperties

Properties

Name
Type
Description
Notes

Name

Pointer to string

A name of that resource

[optional]

Description

Pointer to string

Human readable description

[optional]

Location

Pointer to string

Location of that image/snapshot.

[optional] [readonly]

Size

Pointer to float32

The size of the image in GB

[optional] [readonly]

CpuHotPlug

Pointer to bool

Is capable of CPU hot plug (no reboot required)

[optional]

CpuHotUnplug

Pointer to bool

Is capable of CPU hot unplug (no reboot required)

[optional]

RamHotPlug

Pointer to bool

Is capable of memory hot plug (no reboot required)

[optional]

RamHotUnplug

Pointer to bool

Is capable of memory hot unplug (no reboot required)

[optional]

NicHotPlug

Pointer to bool

Is capable of nic hot plug (no reboot required)

[optional]

NicHotUnplug

Pointer to bool

Is capable of nic hot unplug (no reboot required)

[optional]

DiscVirtioHotPlug

Pointer to bool

Is capable of Virt-IO drive hot plug (no reboot required)

[optional]

DiscVirtioHotUnplug

Pointer to bool

Is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.

[optional]

DiscScsiHotPlug

Pointer to bool

Is capable of SCSI drive hot plug (no reboot required)

[optional]

DiscScsiHotUnplug

Pointer to bool

Is capable of SCSI drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.

[optional]

LicenceType

string

OS type of this Image

ImageType

Pointer to string

This indicates the type of image

[optional] [readonly]

Public

Pointer to bool

Indicates if the image is part of the public repository or not

[optional] [readonly]

ImageAliases

Pointer to []string

List of image aliases mapped for this Image

[optional] [readonly]

CloudInit

Pointer to string

Cloud init compatibility

[optional]

Methods

NewImageProperties

func NewImageProperties(licenceType string, ) *ImageProperties

NewImageProperties instantiates a new ImageProperties 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

NewImagePropertiesWithDefaults

func NewImagePropertiesWithDefaults() *ImageProperties

NewImagePropertiesWithDefaults instantiates a new ImageProperties 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

GetName

func (o *ImageProperties) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *ImageProperties) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *ImageProperties) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *ImageProperties) HasName() bool

HasName returns a boolean if a field has been set.

GetDescription

func (o *ImageProperties) GetDescription() string

GetDescription returns the Description field if non-nil, zero value otherwise.

GetDescriptionOk

func (o *ImageProperties) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDescription

func (o *ImageProperties) SetDescription(v string)

SetDescription sets Description field to given value.

HasDescription

func (o *ImageProperties) HasDescription() bool

HasDescription returns a boolean if a field has been set.

GetLocation

func (o *ImageProperties) GetLocation() string

GetLocation returns the Location field if non-nil, zero value otherwise.

GetLocationOk

func (o *ImageProperties) GetLocationOk() (*string, bool)

GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLocation

func (o *ImageProperties) SetLocation(v string)

SetLocation sets Location field to given value.

HasLocation

func (o *ImageProperties) HasLocation() bool

HasLocation returns a boolean if a field has been set.

GetSize

func (o *ImageProperties) GetSize() float32

GetSize returns the Size field if non-nil, zero value otherwise.

GetSizeOk

func (o *ImageProperties) GetSizeOk() (*float32, bool)

GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSize

func (o *ImageProperties) SetSize(v float32)

SetSize sets Size field to given value.

HasSize

func (o *ImageProperties) HasSize() bool

HasSize returns a boolean if a field has been set.

GetCpuHotPlug

func (o *ImageProperties) GetCpuHotPlug() bool

GetCpuHotPlug returns the CpuHotPlug field if non-nil, zero value otherwise.

GetCpuHotPlugOk

func (o *ImageProperties) GetCpuHotPlugOk() (*bool, bool)

GetCpuHotPlugOk returns a tuple with the CpuHotPlug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCpuHotPlug

func (o *ImageProperties) SetCpuHotPlug(v bool)

SetCpuHotPlug sets CpuHotPlug field to given value.

HasCpuHotPlug

func (o *ImageProperties) HasCpuHotPlug() bool

HasCpuHotPlug returns a boolean if a field has been set.

GetCpuHotUnplug

func (o *ImageProperties) GetCpuHotUnplug() bool

GetCpuHotUnplug returns the CpuHotUnplug field if non-nil, zero value otherwise.

GetCpuHotUnplugOk

func (o *ImageProperties) GetCpuHotUnplugOk() (*bool, bool)

GetCpuHotUnplugOk returns a tuple with the CpuHotUnplug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCpuHotUnplug

func (o *ImageProperties) SetCpuHotUnplug(v bool)

SetCpuHotUnplug sets CpuHotUnplug field to given value.

HasCpuHotUnplug

func (o *ImageProperties) HasCpuHotUnplug() bool

HasCpuHotUnplug returns a boolean if a field has been set.

GetRamHotPlug

func (o *ImageProperties) GetRamHotPlug() bool

GetRamHotPlug returns the RamHotPlug field if non-nil, zero value otherwise.

GetRamHotPlugOk

func (o *ImageProperties) GetRamHotPlugOk() (*bool, bool)

GetRamHotPlugOk returns a tuple with the RamHotPlug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRamHotPlug

func (o *ImageProperties) SetRamHotPlug(v bool)

SetRamHotPlug sets RamHotPlug field to given value.

HasRamHotPlug

func (o *ImageProperties) HasRamHotPlug() bool

HasRamHotPlug returns a boolean if a field has been set.

GetRamHotUnplug

func (o *ImageProperties) GetRamHotUnplug() bool

GetRamHotUnplug returns the RamHotUnplug field if non-nil, zero value otherwise.

GetRamHotUnplugOk

func (o *ImageProperties) GetRamHotUnplugOk() (*bool, bool)

GetRamHotUnplugOk returns a tuple with the RamHotUnplug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRamHotUnplug

func (o *ImageProperties) SetRamHotUnplug(v bool)

SetRamHotUnplug sets RamHotUnplug field to given value.

HasRamHotUnplug

func (o *ImageProperties) HasRamHotUnplug() bool

HasRamHotUnplug returns a boolean if a field has been set.

GetNicHotPlug

func (o *ImageProperties) GetNicHotPlug() bool

GetNicHotPlug returns the NicHotPlug field if non-nil, zero value otherwise.

GetNicHotPlugOk

func (o *ImageProperties) GetNicHotPlugOk() (*bool, bool)

GetNicHotPlugOk returns a tuple with the NicHotPlug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNicHotPlug

func (o *ImageProperties) SetNicHotPlug(v bool)

SetNicHotPlug sets NicHotPlug field to given value.

HasNicHotPlug

func (o *ImageProperties) HasNicHotPlug() bool

HasNicHotPlug returns a boolean if a field has been set.

GetNicHotUnplug

func (o *ImageProperties) GetNicHotUnplug() bool

GetNicHotUnplug returns the NicHotUnplug field if non-nil, zero value otherwise.

GetNicHotUnplugOk

func (o *ImageProperties) GetNicHotUnplugOk() (*bool, bool)

GetNicHotUnplugOk returns a tuple with the NicHotUnplug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNicHotUnplug

func (o *ImageProperties) SetNicHotUnplug(v bool)

SetNicHotUnplug sets NicHotUnplug field to given value.

HasNicHotUnplug

func (o *ImageProperties) HasNicHotUnplug() bool

HasNicHotUnplug returns a boolean if a field has been set.

GetDiscVirtioHotPlug

func (o *ImageProperties) GetDiscVirtioHotPlug() bool

GetDiscVirtioHotPlug returns the DiscVirtioHotPlug field if non-nil, zero value otherwise.

GetDiscVirtioHotPlugOk

func (o *ImageProperties) GetDiscVirtioHotPlugOk() (*bool, bool)

GetDiscVirtioHotPlugOk returns a tuple with the DiscVirtioHotPlug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDiscVirtioHotPlug

func (o *ImageProperties) SetDiscVirtioHotPlug(v bool)

SetDiscVirtioHotPlug sets DiscVirtioHotPlug field to given value.

HasDiscVirtioHotPlug

func (o *ImageProperties) HasDiscVirtioHotPlug() bool

HasDiscVirtioHotPlug returns a boolean if a field has been set.

GetDiscVirtioHotUnplug

func (o *ImageProperties) GetDiscVirtioHotUnplug() bool

GetDiscVirtioHotUnplug returns the DiscVirtioHotUnplug field if non-nil, zero value otherwise.

GetDiscVirtioHotUnplugOk

func (o *ImageProperties) GetDiscVirtioHotUnplugOk() (*bool, bool)

GetDiscVirtioHotUnplugOk returns a tuple with the DiscVirtioHotUnplug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDiscVirtioHotUnplug

func (o *ImageProperties) SetDiscVirtioHotUnplug(v bool)

SetDiscVirtioHotUnplug sets DiscVirtioHotUnplug field to given value.

HasDiscVirtioHotUnplug

func (o *ImageProperties) HasDiscVirtioHotUnplug() bool

HasDiscVirtioHotUnplug returns a boolean if a field has been set.

GetDiscScsiHotPlug

func (o *ImageProperties) GetDiscScsiHotPlug() bool

GetDiscScsiHotPlug returns the DiscScsiHotPlug field if non-nil, zero value otherwise.

GetDiscScsiHotPlugOk

func (o *ImageProperties) GetDiscScsiHotPlugOk() (*bool, bool)

GetDiscScsiHotPlugOk returns a tuple with the DiscScsiHotPlug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDiscScsiHotPlug

func (o *ImageProperties) SetDiscScsiHotPlug(v bool)

SetDiscScsiHotPlug sets DiscScsiHotPlug field to given value.

HasDiscScsiHotPlug

func (o *ImageProperties) HasDiscScsiHotPlug() bool

HasDiscScsiHotPlug returns a boolean if a field has been set.

GetDiscScsiHotUnplug

func (o *ImageProperties) GetDiscScsiHotUnplug() bool

GetDiscScsiHotUnplug returns the DiscScsiHotUnplug field if non-nil, zero value otherwise.

GetDiscScsiHotUnplugOk

func (o *ImageProperties) GetDiscScsiHotUnplugOk() (*bool, bool)

GetDiscScsiHotUnplugOk returns a tuple with the DiscScsiHotUnplug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDiscScsiHotUnplug

func (o *ImageProperties) SetDiscScsiHotUnplug(v bool)

SetDiscScsiHotUnplug sets DiscScsiHotUnplug field to given value.

HasDiscScsiHotUnplug

func (o *ImageProperties) HasDiscScsiHotUnplug() bool

HasDiscScsiHotUnplug returns a boolean if a field has been set.

GetLicenceType

func (o *ImageProperties) GetLicenceType() string

GetLicenceType returns the LicenceType field if non-nil, zero value otherwise.

GetLicenceTypeOk

func (o *ImageProperties) GetLicenceTypeOk() (*string, bool)

GetLicenceTypeOk returns a tuple with the LicenceType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLicenceType

func (o *ImageProperties) SetLicenceType(v string)

SetLicenceType sets LicenceType field to given value.

GetImageType

func (o *ImageProperties) GetImageType() string

GetImageType returns the ImageType field if non-nil, zero value otherwise.

GetImageTypeOk

func (o *ImageProperties) GetImageTypeOk() (*string, bool)

GetImageTypeOk returns a tuple with the ImageType field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetImageType

func (o *ImageProperties) SetImageType(v string)

SetImageType sets ImageType field to given value.

HasImageType

func (o *ImageProperties) HasImageType() bool

HasImageType returns a boolean if a field has been set.

GetPublic

func (o *ImageProperties) GetPublic() bool

GetPublic returns the Public field if non-nil, zero value otherwise.

GetPublicOk

func (o *ImageProperties) GetPublicOk() (*bool, bool)

GetPublicOk returns a tuple with the Public field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPublic

func (o *ImageProperties) SetPublic(v bool)

SetPublic sets Public field to given value.

HasPublic

func (o *ImageProperties) HasPublic() bool

HasPublic returns a boolean if a field has been set.

GetImageAliases

func (o *ImageProperties) GetImageAliases() []string

GetImageAliases returns the ImageAliases field if non-nil, zero value otherwise.

GetImageAliasesOk

func (o *ImageProperties) GetImageAliasesOk() (*[]string, bool)

GetImageAliasesOk returns a tuple with the ImageAliases field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetImageAliases

func (o *ImageProperties) SetImageAliases(v []string)

SetImageAliases sets ImageAliases field to given value.

HasImageAliases

func (o *ImageProperties) HasImageAliases() bool

HasImageAliases returns a boolean if a field has been set.

GetCloudInit

func (o *ImageProperties) GetCloudInit() string

GetCloudInit returns the CloudInit field if non-nil, zero value otherwise.

GetCloudInitOk

func (o *ImageProperties) GetCloudInitOk() (*string, bool)

GetCloudInitOk returns a tuple with the CloudInit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCloudInit

func (o *ImageProperties) SetCloudInit(v string)

SetCloudInit sets CloudInit field to given value.

HasCloudInit

func (o *ImageProperties) HasCloudInit() bool

HasCloudInit returns a boolean if a field has been set.

PrivateCrossConnectApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /pccs/{pccId}

Delete a Private Cross-Connect

Get /pccs/{pccId}

Retrieve a Private Cross-Connect

Get /pccs

List Private Cross-Connects

Patch /pccs/{pccId}

Partially modify a private cross-connect

Post /pccs

Create a Private Cross-Connect

PccsDelete

var result map[string]interface{} = PccsDelete(ctx, pccId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Private Cross-Connect

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pccId := "pccId_example" // string | The unique ID of the private cross-connect
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PrivateCrossConnectApi.PccsDelete(context.Background(), pccId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PrivateCrossConnectApi.PccsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PccsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `PrivateCrossConnectApi.PccsDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

pccId

string

The unique ID of the private cross-connect

Other Parameters

Other parameters are passed through a pointer to a apiPccsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

PccsFindById

var result PrivateCrossConnect = PccsFindById(ctx, pccId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Private Cross-Connect

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pccId := "pccId_example" // string | The unique ID of the private cross-connect
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PrivateCrossConnectApi.PccsFindById(context.Background(), pccId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PrivateCrossConnectApi.PccsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PccsFindById`: PrivateCrossConnect
    fmt.Fprintf(os.Stdout, "Response from `PrivateCrossConnectApi.PccsFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

pccId

string

The unique ID of the private cross-connect

Other Parameters

Other parameters are passed through a pointer to a apiPccsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

PrivateCrossConnect

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

PccsGet

var result PrivateCrossConnects = PccsGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List Private Cross-Connects

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PrivateCrossConnectApi.PccsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PrivateCrossConnectApi.PccsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PccsGet`: PrivateCrossConnects
    fmt.Fprintf(os.Stdout, "Response from `PrivateCrossConnectApi.PccsGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPccsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

PrivateCrossConnects

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

PccsPatch

var result PrivateCrossConnect = PccsPatch(ctx, pccId)
                      .Pcc(pcc)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a private cross-connect

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pccId := "pccId_example" // string | The unique ID of the private cross-connect
    pcc := *openapiclient.NewPrivateCrossConnectProperties() // PrivateCrossConnectProperties | Modified properties of private cross-connect
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PrivateCrossConnectApi.PccsPatch(context.Background(), pccId).Pcc(pcc).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PrivateCrossConnectApi.PccsPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PccsPatch`: PrivateCrossConnect
    fmt.Fprintf(os.Stdout, "Response from `PrivateCrossConnectApi.PccsPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

pccId

string

The unique ID of the private cross-connect

Other Parameters

Other parameters are passed through a pointer to a apiPccsPatchRequest struct via the builder pattern

Name
Type
Description
Notes

pcc

Modified properties of private cross-connect

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

PrivateCrossConnect

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

PccsPost

var result PrivateCrossConnect = PccsPost(ctx)
                      .Pcc(pcc)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Private Cross-Connect

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pcc := *openapiclient.NewPrivateCrossConnect(*openapiclient.NewPrivateCrossConnectProperties()) // PrivateCrossConnect | Private Cross-Connect to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PrivateCrossConnectApi.PccsPost(context.Background()).Pcc(pcc).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PrivateCrossConnectApi.PccsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PccsPost`: PrivateCrossConnect
    fmt.Fprintf(os.Stdout, "Response from `PrivateCrossConnectApi.PccsPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPccsPostRequest struct via the builder pattern

Name
Type
Description
Notes

pcc

Private Cross-Connect to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

PrivateCrossConnect

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

SnapshotApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /snapshots/{snapshotId}

Delete a Snapshot

Get /snapshots/{snapshotId}

Retrieve a Snapshot by its uuid.

Get /snapshots

List Snapshots

Patch /snapshots/{snapshotId}

Partially modify a Snapshot

Put /snapshots/{snapshotId}

Modify a Snapshot

SnapshotsDelete

var result map[string]interface{} = SnapshotsDelete(ctx, snapshotId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SnapshotApi.SnapshotsDelete(context.Background(), snapshotId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

SnapshotsFindById

var result Snapshot = SnapshotsFindById(ctx, snapshotId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Snapshot by its uuid.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SnapshotApi.SnapshotsFindById(context.Background(), snapshotId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsFindById`: Snapshot
    fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Snapshot

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

SnapshotsGet

var result Snapshots = SnapshotsGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List Snapshots

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SnapshotApi.SnapshotsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsGet`: Snapshots
    fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Snapshots

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

SnapshotsPatch

var result Snapshot = SnapshotsPatch(ctx, snapshotId)
                      .Snapshot(snapshot)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    snapshot := *openapiclient.NewSnapshotProperties() // SnapshotProperties | Modified Snapshot
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SnapshotApi.SnapshotsPatch(context.Background(), snapshotId).Snapshot(snapshot).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsPatch`: Snapshot
    fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsPatchRequest struct via the builder pattern

Name
Type
Description
Notes

snapshot

Modified Snapshot

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Snapshot

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

SnapshotsPut

var result Snapshot = SnapshotsPut(ctx, snapshotId)
                      .Snapshot(snapshot)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    snapshot := *openapiclient.NewSnapshot(*openapiclient.NewSnapshotProperties()) // Snapshot | Modified Snapshot
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SnapshotApi.SnapshotsPut(context.Background(), snapshotId).Snapshot(snapshot).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SnapshotApi.SnapshotsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsPut`: Snapshot
    fmt.Fprintf(os.Stdout, "Response from `SnapshotApi.SnapshotsPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsPutRequest struct via the builder pattern

Name
Type
Description
Notes

snapshot

Modified Snapshot

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Snapshot

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

PccsDelete
PccsFindById
PccsGet
PccsPatch
PccsPost
PrivateCrossConnectProperties
PrivateCrossConnect
SnapshotsDelete
SnapshotsFindById
SnapshotsGet
SnapshotsPatch
SnapshotsPut
SnapshotProperties
Snapshot

DataCenterApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /datacenters/{datacenterId}

Delete a Data Center

Get /datacenters/{datacenterId}

Retrieve a Data Center

Get /datacenters

List Data Centers under your account

Patch /datacenters/{datacenterId}

Partially modify a Data Center

Post /datacenters

Create a Data Center

Put /datacenters/{datacenterId}

Modify a Data Center

DatacentersDelete

var result map[string]interface{} = DatacentersDelete(ctx, datacenterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Data Center

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataCenterApi.DatacentersDelete(context.Background(), datacenterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataCenterApi.DatacentersDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `DataCenterApi.DatacentersDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersFindById

var result Datacenter = DatacentersFindById(ctx, datacenterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Data Center

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataCenterApi.DatacentersFindById(context.Background(), datacenterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataCenterApi.DatacentersFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersFindById`: Datacenter
    fmt.Fprintf(os.Stdout, "Response from `DataCenterApi.DatacentersFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Datacenter

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersGet

var result Datacenters = DatacentersGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Data Centers under your account

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataCenterApi.DatacentersGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataCenterApi.DatacentersGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersGet`: Datacenters
    fmt.Fprintf(os.Stdout, "Response from `DataCenterApi.DatacentersGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

Datacenters

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersPatch

var result Datacenter = DatacentersPatch(ctx, datacenterId)
                      .Datacenter(datacenter)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a Data Center

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    datacenter := *openapiclient.NewDatacenterProperties("us/las") // DatacenterProperties | Modified properties of Data Center
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataCenterApi.DatacentersPatch(context.Background(), datacenterId).Datacenter(datacenter).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataCenterApi.DatacentersPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersPatch`: Datacenter
    fmt.Fprintf(os.Stdout, "Response from `DataCenterApi.DatacentersPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersPatchRequest struct via the builder pattern

Name
Type
Description
Notes

datacenter

Modified properties of Data Center

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Datacenter

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersPost

var result Datacenter = DatacentersPost(ctx)
                      .Datacenter(datacenter)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Data Center

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenter := *openapiclient.NewDatacenter(*openapiclient.NewDatacenterProperties("us/las")) // Datacenter | Datacenter to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataCenterApi.DatacentersPost(context.Background()).Datacenter(datacenter).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataCenterApi.DatacentersPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersPost`: Datacenter
    fmt.Fprintf(os.Stdout, "Response from `DataCenterApi.DatacentersPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersPostRequest struct via the builder pattern

Name
Type
Description
Notes

datacenter

Datacenter to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Datacenter

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersPut

var result Datacenter = DatacentersPut(ctx, datacenterId)
                      .Datacenter(datacenter)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a Data Center

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    datacenter := *openapiclient.NewDatacenter(*openapiclient.NewDatacenterProperties("us/las")) // Datacenter | Modified Data Center
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DataCenterApi.DatacentersPut(context.Background(), datacenterId).Datacenter(datacenter).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataCenterApi.DatacentersPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersPut`: Datacenter
    fmt.Fprintf(os.Stdout, "Response from `DataCenterApi.DatacentersPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersPutRequest struct via the builder pattern

Name
Type
Description
Notes

datacenter

Modified Data Center

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Datacenter

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

ImageApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /images/{imageId}

Delete an Image

Get /images/{imageId}

Retrieve an Image

Get /images

List Images

Patch /images/{imageId}

Partially modify an Image

Put /images/{imageId}

Modify an Image

ImagesDelete

var result map[string]interface{} = ImagesDelete(ctx, imageId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete an Image

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    imageId := "imageId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ImageApi.ImagesDelete(context.Background(), imageId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ImageApi.ImagesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ImagesDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `ImageApi.ImagesDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

imageId

string

Other Parameters

Other parameters are passed through a pointer to a apiImagesDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

ImagesFindById

var result Image = ImagesFindById(ctx, imageId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve an Image

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    imageId := "imageId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ImageApi.ImagesFindById(context.Background(), imageId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ImageApi.ImagesFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ImagesFindById`: Image
    fmt.Fprintf(os.Stdout, "Response from `ImageApi.ImagesFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

imageId

string

Other Parameters

Other parameters are passed through a pointer to a apiImagesFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Image

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

ImagesGet

var result Images = ImagesGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List Images

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ImageApi.ImagesGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ImageApi.ImagesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ImagesGet`: Images
    fmt.Fprintf(os.Stdout, "Response from `ImageApi.ImagesGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiImagesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Images

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

ImagesPatch

var result Image = ImagesPatch(ctx, imageId)
                      .Image(image)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify an Image

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    imageId := "imageId_example" // string | 
    image := *openapiclient.NewImageProperties("LINUX") // ImageProperties | Modified Image
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ImageApi.ImagesPatch(context.Background(), imageId).Image(image).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ImageApi.ImagesPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ImagesPatch`: Image
    fmt.Fprintf(os.Stdout, "Response from `ImageApi.ImagesPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

imageId

string

Other Parameters

Other parameters are passed through a pointer to a apiImagesPatchRequest struct via the builder pattern

Name
Type
Description
Notes

image

Modified Image

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Image

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

ImagesPut

var result Image = ImagesPut(ctx, imageId)
                      .Image(image)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify an Image

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    imageId := "imageId_example" // string | 
    image := *openapiclient.NewImage(*openapiclient.NewImageProperties("LINUX")) // Image | Modified Image
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ImageApi.ImagesPut(context.Background(), imageId).Image(image).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ImageApi.ImagesPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ImagesPut`: Image
    fmt.Fprintf(os.Stdout, "Response from `ImageApi.ImagesPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

imageId

string

Other Parameters

Other parameters are passed through a pointer to a apiImagesPutRequest struct via the builder pattern

Name
Type
Description
Notes

image

Modified Image

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Image

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersDelete
DatacentersFindById
DatacentersGet
DatacentersPatch
DatacentersPost
DatacentersPut
DatacenterProperties
Datacenter
Datacenter
ImagesDelete
ImagesFindById
ImagesGet
ImagesPatch
ImagesPut
ImageProperties
Image

IPBlocksApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /ipblocks/{ipblockId}

Delete IP Block

Get /ipblocks/{ipblockId}

Retrieve an IP Block

Get /ipblocks

List IP Blocks

Patch /ipblocks/{ipblockId}

Partially modify IP Block

Post /ipblocks

Reserve IP Block

Put /ipblocks/{ipblockId}

Modify IP Block

IpblocksDelete

var result map[string]interface{} = IpblocksDelete(ctx, ipblockId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete IP Block

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IPBlocksApi.IpblocksDelete(context.Background(), ipblockId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPBlocksApi.IpblocksDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `IPBlocksApi.IpblocksDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

IpblocksFindById

var result IpBlock = IpblocksFindById(ctx, ipblockId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve an IP Block

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IPBlocksApi.IpblocksFindById(context.Background(), ipblockId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPBlocksApi.IpblocksFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksFindById`: IpBlock
    fmt.Fprintf(os.Stdout, "Response from `IPBlocksApi.IpblocksFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

IpBlock

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

IpblocksGet

var result IpBlocks = IpblocksGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List IP Blocks

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> 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 := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IPBlocksApi.IpblocksGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPBlocksApi.IpblocksGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksGet`: IpBlocks
    fmt.Fprintf(os.Stdout, "Response from `IPBlocksApi.IpblocksGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with offset for pagination)

[default to 100]

Return type

IpBlocks

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

IpblocksPatch

var result IpBlock = IpblocksPatch(ctx, ipblockId)
                      .Ipblock(ipblock)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify IP Block

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | 
    ipblock := *openapiclient.NewIpBlockProperties("us/las", int32(5)) // IpBlockProperties | IP Block to be modified
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IPBlocksApi.IpblocksPatch(context.Background(), ipblockId).Ipblock(ipblock).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPBlocksApi.IpblocksPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksPatch`: IpBlock
    fmt.Fprintf(os.Stdout, "Response from `IPBlocksApi.IpblocksPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksPatchRequest struct via the builder pattern

Name
Type
Description
Notes

ipblock

IP Block to be modified

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

IpBlock

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

IpblocksPost

var result IpBlock = IpblocksPost(ctx)
                      .Ipblock(ipblock)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Reserve IP Block

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblock := *openapiclient.NewIpBlock(*openapiclient.NewIpBlockProperties("us/las", int32(5))) // IpBlock | IP Block to be reserved
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IPBlocksApi.IpblocksPost(context.Background()).Ipblock(ipblock).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPBlocksApi.IpblocksPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksPost`: IpBlock
    fmt.Fprintf(os.Stdout, "Response from `IPBlocksApi.IpblocksPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksPostRequest struct via the builder pattern

Name
Type
Description
Notes

ipblock

IP Block to be reserved

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

IpBlock

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

IpblocksPut

var result IpBlock = IpblocksPut(ctx, ipblockId)
                      .Ipblock(ipblock)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify IP Block

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | 
    ipblock := *openapiclient.NewIpBlock(*openapiclient.NewIpBlockProperties("us/las", int32(5))) // IpBlock | IP Block to be modified
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IPBlocksApi.IpblocksPut(context.Background(), ipblockId).Ipblock(ipblock).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPBlocksApi.IpblocksPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksPut`: IpBlock
    fmt.Fprintf(os.Stdout, "Response from `IPBlocksApi.IpblocksPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksPutRequest struct via the builder pattern

Name
Type
Description
Notes

ipblock

IP Block to be modified

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

IpBlock

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

BackupUnitApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

BackupunitsDelete

Delete a Backup Unit

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiBackupunitsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

BackupunitsFindById

Returns the specified backup Unit

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiBackupunitsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

BackupunitsGet

List Backup Units

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiBackupunitsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

BackupunitsPatch

Partially modify a Backup Unit

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiBackupunitsPatchRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

BackupunitsPost

Create a Backup Unit

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiBackupunitsPostRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

BackupunitsPut

Modify a Backup Unit

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiBackupunitsPutRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

BackupunitsSsourlGet

Returns a single signon URL for the specified backup Unit.

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiBackupunitsSsourlGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

IpblocksDelete
IpblocksFindById
IpblocksGet
IpblocksPatch
IpblocksPost
IpblocksPut
IpBlockProperties
IpBlock
IpBlock

BackupunitsDelete

Delete /backupunits/{backupunitId}

Delete a Backup Unit

BackupunitsFindById

Get /backupunits/{backupunitId}

Returns the specified backup Unit

BackupunitsGet

Get /backupunits

List Backup Units

BackupunitsPatch

Patch /backupunits/{backupunitId}

Partially modify a Backup Unit

BackupunitsPost

Post /backupunits

Create a Backup Unit

BackupunitsPut

Put /backupunits/{backupunitId}

Modify a Backup Unit

BackupunitsSsourlGet

Get /backupunits/{backupunitId}/ssourl

Returns a single signon URL for the specified backup Unit.

var result map[string]interface{} = BackupunitsDelete(ctx, backupunitId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    backupunitId := "backupunitId_example" // string | The unique ID of the backup Unit
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.BackupUnitApi.BackupunitsDelete(context.Background(), backupunitId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `BackupUnitApi.BackupunitsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BackupunitsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `BackupUnitApi.BackupunitsDelete`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

backupunitId

string

The unique ID of the backup Unit

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result BackupUnit = BackupunitsFindById(ctx, backupunitId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    backupunitId := "backupunitId_example" // string | The unique ID of the backup unit
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.BackupUnitApi.BackupunitsFindById(context.Background(), backupunitId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `BackupUnitApi.BackupunitsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BackupunitsFindById`: BackupUnit
    fmt.Fprintf(os.Stdout, "Response from `BackupUnitApi.BackupunitsFindById`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

backupunitId

string

The unique ID of the backup unit

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result BackupUnits = BackupunitsGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.BackupUnitApi.BackupunitsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `BackupUnitApi.BackupunitsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BackupunitsGet`: BackupUnits
    fmt.Fprintf(os.Stdout, "Response from `BackupUnitApi.BackupunitsGet`: %v\n", resp)
}

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result BackupUnit = BackupunitsPatch(ctx, backupunitId)
                      .BackupUnitProperties(backupUnitProperties)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    backupunitId := "backupunitId_example" // string | The unique ID of the backup unit
    backupUnitProperties := *openapiclient.NewBackupUnitProperties("BackupUnitName") // BackupUnitProperties | Modified backup Unit properties
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.BackupUnitApi.BackupunitsPatch(context.Background(), backupunitId).BackupUnitProperties(backupUnitProperties).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `BackupUnitApi.BackupunitsPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BackupunitsPatch`: BackupUnit
    fmt.Fprintf(os.Stdout, "Response from `BackupUnitApi.BackupunitsPatch`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

backupunitId

string

The unique ID of the backup unit

backupUnitProperties

BackupUnitProperties

Modified backup Unit properties

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result BackupUnit = BackupunitsPost(ctx)
                      .BackupUnit(backupUnit)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    backupUnit := *openapiclient.NewBackupUnit(*openapiclient.NewBackupUnitProperties("BackupUnitName")) // BackupUnit | Payload containing data to create a new Backup Unit
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.BackupUnitApi.BackupunitsPost(context.Background()).BackupUnit(backupUnit).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `BackupUnitApi.BackupunitsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BackupunitsPost`: BackupUnit
    fmt.Fprintf(os.Stdout, "Response from `BackupUnitApi.BackupunitsPost`: %v\n", resp)
}

backupUnit

BackupUnit

Payload containing data to create a new Backup Unit

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result BackupUnit = BackupunitsPut(ctx, backupunitId)
                      .BackupUnit(backupUnit)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    backupunitId := "backupunitId_example" // string | The unique ID of the backup unit
    backupUnit := *openapiclient.NewBackupUnit(*openapiclient.NewBackupUnitProperties("BackupUnitName")) // BackupUnit | Modified backup Unit
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.BackupUnitApi.BackupunitsPut(context.Background(), backupunitId).BackupUnit(backupUnit).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `BackupUnitApi.BackupunitsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BackupunitsPut`: BackupUnit
    fmt.Fprintf(os.Stdout, "Response from `BackupUnitApi.BackupunitsPut`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

backupunitId

string

The unique ID of the backup unit

backupUnit

BackupUnit

Modified backup Unit

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result BackupUnitSSO = BackupunitsSsourlGet(ctx, backupunitId)
                      .Pretty(pretty)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    backupunitId := "backupunitId_example" // string | The unique UUID of the backup unit
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.BackupUnitApi.BackupunitsSsourlGet(context.Background(), backupunitId).Pretty(pretty).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `BackupUnitApi.BackupunitsSsourlGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `BackupunitsSsourlGet`: BackupUnitSSO
    fmt.Fprintf(os.Stdout, "Response from `BackupUnitApi.BackupunitsSsourlGet`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

backupunitId

string

The unique UUID of the backup unit

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

BackupUnit
BackupUnits
BackupUnit
BackupUnit
BackupUnit
BackupUnitSSO

VolumeApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Post /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot

Create Volume Snapshot

Delete /datacenters/{datacenterId}/volumes/{volumeId}

Delete a Volume

Get /datacenters/{datacenterId}/volumes/{volumeId}

Retrieve a Volume

Get /datacenters/{datacenterId}/volumes

List Volumes

Patch /datacenters/{datacenterId}/volumes/{volumeId}

Partially modify a Volume

Post /datacenters/{datacenterId}/volumes

Create a Volume

Put /datacenters/{datacenterId}/volumes/{volumeId}

Modify a Volume

Post /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot

Restore Volume Snapshot

DatacentersVolumesCreateSnapshotPost

var result Snapshot = DatacentersVolumesCreateSnapshotPost(ctx, datacenterId, volumeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Name(name)
                      .Description(description)
                      .SecAuthProtection(secAuthProtection)
                      .LicenceType(licenceType)
                      .Execute()

Create Volume Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    name := "name_example" // string | The name of the snapshot (optional)
    description := "description_example" // string | The description of the snapshot (optional)
    secAuthProtection := true // bool | Flag representing if extra protection is enabled on snapshot e.g. Two Factor protection etc. (optional)
    licenceType := "licenceType_example" // string | The OS type of this Snapshot (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VolumeApi.DatacentersVolumesCreateSnapshotPost(context.Background(), datacenterId, volumeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Name(name).Description(description).SecAuthProtection(secAuthProtection).LicenceType(licenceType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VolumeApi.DatacentersVolumesCreateSnapshotPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesCreateSnapshotPost`: Snapshot
    fmt.Fprintf(os.Stdout, "Response from `VolumeApi.DatacentersVolumesCreateSnapshotPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

volumeId

string

The unique ID of the Volume

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesCreateSnapshotPostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

name

string

The name of the snapshot

description

string

The description of the snapshot

secAuthProtection

bool

Flag representing if extra protection is enabled on snapshot e.g. Two Factor protection etc.

licenceType

string

The OS type of this Snapshot

Return type

Snapshot

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded

  • Accept: application/json

DatacentersVolumesDelete

var result map[string]interface{} = DatacentersVolumesDelete(ctx, datacenterId, volumeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Volume

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VolumeApi.DatacentersVolumesDelete(context.Background(), datacenterId, volumeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VolumeApi.DatacentersVolumesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `VolumeApi.DatacentersVolumesDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

volumeId

string

The unique ID of the Volume

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersVolumesFindById

var result Volume = DatacentersVolumesFindById(ctx, datacenterId, volumeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Volume

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VolumeApi.DatacentersVolumesFindById(context.Background(), datacenterId, volumeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VolumeApi.DatacentersVolumesFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesFindById`: Volume
    fmt.Fprintf(os.Stdout, "Response from `VolumeApi.DatacentersVolumesFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

volumeId

string

The unique ID of the Volume

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Volume

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersVolumesGet

var result Volumes = DatacentersVolumesGet(ctx, datacenterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Volumes

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VolumeApi.DatacentersVolumesGet(context.Background(), datacenterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VolumeApi.DatacentersVolumesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesGet`: Volumes
    fmt.Fprintf(os.Stdout, "Response from `VolumeApi.DatacentersVolumesGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

Volumes

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersVolumesPatch

var result Volume = DatacentersVolumesPatch(ctx, datacenterId, volumeId)
                      .Volume(volume)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a Volume

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    volume := *openapiclient.NewVolumeProperties(float32(100.0)) // VolumeProperties | Modified properties of Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VolumeApi.DatacentersVolumesPatch(context.Background(), datacenterId, volumeId).Volume(volume).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VolumeApi.DatacentersVolumesPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesPatch`: Volume
    fmt.Fprintf(os.Stdout, "Response from `VolumeApi.DatacentersVolumesPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

volumeId

string

The unique ID of the Volume

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesPatchRequest struct via the builder pattern

Name
Type
Description
Notes

volume

Modified properties of Volume

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Volume

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersVolumesPost

var result Volume = DatacentersVolumesPost(ctx, datacenterId)
                      .Volume(volume)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Volume

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    volume := *openapiclient.NewVolume(*openapiclient.NewVolumeProperties(float32(100.0))) // Volume | Volume to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VolumeApi.DatacentersVolumesPost(context.Background(), datacenterId).Volume(volume).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VolumeApi.DatacentersVolumesPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesPost`: Volume
    fmt.Fprintf(os.Stdout, "Response from `VolumeApi.DatacentersVolumesPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesPostRequest struct via the builder pattern

Name
Type
Description
Notes

volume

Volume to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Volume

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersVolumesPut

var result Volume = DatacentersVolumesPut(ctx, datacenterId, volumeId)
                      .Volume(volume)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a Volume

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    volume := *openapiclient.NewVolume(*openapiclient.NewVolumeProperties(float32(100.0))) // Volume | Modified Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VolumeApi.DatacentersVolumesPut(context.Background(), datacenterId, volumeId).Volume(volume).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VolumeApi.DatacentersVolumesPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesPut`: Volume
    fmt.Fprintf(os.Stdout, "Response from `VolumeApi.DatacentersVolumesPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

volumeId

string

The unique ID of the Volume

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesPutRequest struct via the builder pattern

Name
Type
Description
Notes

volume

Modified Volume

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Volume

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersVolumesRestoreSnapshotPost

var result map[string]interface{} = DatacentersVolumesRestoreSnapshotPost(ctx, datacenterId, volumeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .SnapshotId(snapshotId)
                      .Execute()

Restore Volume Snapshot

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    snapshotId := "snapshotId_example" // string | This is the ID of the snapshot (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.VolumeApi.DatacentersVolumesRestoreSnapshotPost(context.Background(), datacenterId, volumeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).SnapshotId(snapshotId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `VolumeApi.DatacentersVolumesRestoreSnapshotPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesRestoreSnapshotPost`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `VolumeApi.DatacentersVolumesRestoreSnapshotPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

volumeId

string

The unique ID of the Volume

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesRestoreSnapshotPostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

snapshotId

string

This is the ID of the snapshot

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded

  • Accept: application/json

DatacentersVolumesCreateSnapshotPost
DatacentersVolumesDelete
DatacentersVolumesFindById
DatacentersVolumesGet
DatacentersVolumesPatch
DatacentersVolumesPost
DatacentersVolumesPut
DatacentersVolumesRestoreSnapshotPost
VolumeProperties
Volume
Volume

LanApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /datacenters/{datacenterId}/lans/{lanId}

Delete a Lan.

Get /datacenters/{datacenterId}/lans/{lanId}

Retrieve a Lan

Get /datacenters/{datacenterId}/lans

List Lans

Get /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}

Retrieve a nic attached to lan

Get /datacenters/{datacenterId}/lans/{lanId}/nics

List Lan Members

Post /datacenters/{datacenterId}/lans/{lanId}/nics

Attach a nic

Patch /datacenters/{datacenterId}/lans/{lanId}

Partially modify a Lan

Post /datacenters/{datacenterId}/lans

Create a Lan

Put /datacenters/{datacenterId}/lans/{lanId}

Modify a Lan

DatacentersLansDelete

var result map[string]interface{} = DatacentersLansDelete(ctx, datacenterId, lanId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Lan.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    lanId := "lanId_example" // string | The unique ID of the LAN
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansDelete(context.Background(), datacenterId, lanId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

lanId

string

The unique ID of the LAN

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansFindById

var result Lan = DatacentersLansFindById(ctx, datacenterId, lanId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Lan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    lanId := "lanId_example" // string | The unique ID of the LAN
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansFindById(context.Background(), datacenterId, lanId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansFindById`: Lan
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

lanId

string

The unique ID of the LAN

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Lan

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansGet

var result Lans = DatacentersLansGet(ctx, datacenterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Lans

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansGet(context.Background(), datacenterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansGet`: Lans
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

Lans

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansNicsFindById

var result Nic = DatacentersLansNicsFindById(ctx, datacenterId, lanId, nicId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a nic attached to lan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    lanId := "lanId_example" // string | The unique ID of the LAN
    nicId := "nicId_example" // string | The unique ID of the NIC
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansNicsFindById(context.Background(), datacenterId, lanId, nicId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansNicsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansNicsFindById`: Nic
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansNicsFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

lanId

string

The unique ID of the LAN

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansNicsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Nic

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansNicsGet

var result LanNics = DatacentersLansNicsGet(ctx, datacenterId, lanId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Lan Members

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    lanId := "lanId_example" // string | The unique ID of the LAN
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansNicsGet(context.Background(), datacenterId, lanId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansNicsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansNicsGet`: LanNics
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansNicsGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

lanId

string

The unique ID of the LAN

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansNicsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

LanNics

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLansNicsPost

var result Nic = DatacentersLansNicsPost(ctx, datacenterId, lanId)
                      .Nic(nic)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Attach a nic

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    lanId := "lanId_example" // string | The unique ID of the LAN
    nic := *openapiclient.NewNic(*openapiclient.NewNicProperties(int32(2))) // Nic | Nic to be attached
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansNicsPost(context.Background(), datacenterId, lanId).Nic(nic).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansNicsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansNicsPost`: Nic
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansNicsPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

lanId

string

The unique ID of the LAN

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansNicsPostRequest struct via the builder pattern

Name
Type
Description
Notes

nic

Nic to be attached

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Nic

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLansPatch

var result Lan = DatacentersLansPatch(ctx, datacenterId, lanId)
                      .Lan(lan)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a Lan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    lanId := "lanId_example" // string | The unique ID of the LAN
    lan := *openapiclient.NewLanProperties() // LanProperties | Modified Lan
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansPatch(context.Background(), datacenterId, lanId).Lan(lan).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansPatch`: Lan
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

lanId

string

The unique ID of the LAN

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansPatchRequest struct via the builder pattern

Name
Type
Description
Notes

lan

Modified Lan

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Lan

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLansPost

var result LanPost = DatacentersLansPost(ctx, datacenterId)
                      .Lan(lan)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Lan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    lan := *openapiclient.NewLanPost(*openapiclient.NewLanPropertiesPost()) // LanPost | Lan to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansPost(context.Background(), datacenterId).Lan(lan).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansPost`: LanPost
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansPostRequest struct via the builder pattern

Name
Type
Description
Notes

lan

Lan to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

LanPost

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLansPut

var result Lan = DatacentersLansPut(ctx, datacenterId, lanId)
                      .Lan(lan)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a Lan

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    lanId := "lanId_example" // string | The unique ID of the LAN
    lan := *openapiclient.NewLan(*openapiclient.NewLanProperties()) // Lan | Modified Lan
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LanApi.DatacentersLansPut(context.Background(), datacenterId, lanId).Lan(lan).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LanApi.DatacentersLansPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLansPut`: Lan
    fmt.Fprintf(os.Stdout, "Response from `LanApi.DatacentersLansPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

lanId

string

The unique ID of the LAN

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLansPutRequest struct via the builder pattern

Name
Type
Description
Notes

lan

Modified Lan

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Lan

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLansDelete
DatacentersLansFindById
DatacentersLansGet
DatacentersLansNicsFindById
DatacentersLansNicsGet
DatacentersLansNicsPost
DatacentersLansPatch
DatacentersLansPost
DatacentersLansPut
Nic
LanProperties
LanPost
Lan

LoadBalancerApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}

Detach a nic from loadbalancer

Get /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}

Retrieve a nic attached to Load Balancer

Get /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics

List Load Balancer Members

Post /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics

Attach a nic to Load Balancer

Delete /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}

Delete a Loadbalancer.

Get /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}

Retrieve a loadbalancer

Get /datacenters/{datacenterId}/loadbalancers

List Load Balancers

Patch /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}

Partially modify a Loadbalancer

Post /datacenters/{datacenterId}/loadbalancers

Create a Load Balancer

Put /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}

Modify a Load Balancer

DatacentersLoadbalancersBalancednicsDelete

var result map[string]interface{} = DatacentersLoadbalancersBalancednicsDelete(ctx, datacenterId, loadbalancerId, nicId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Detach a nic from loadbalancer

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancerId := "loadbalancerId_example" // string | The unique ID of the Load Balancer
    nicId := "nicId_example" // string | The unique ID of the NIC
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersBalancednicsDelete(context.Background(), datacenterId, loadbalancerId, nicId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersBalancednicsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersBalancednicsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersBalancednicsDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

loadbalancerId

string

The unique ID of the Load Balancer

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersBalancednicsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLoadbalancersBalancednicsFindByNicId

var result Nic = DatacentersLoadbalancersBalancednicsFindByNicId(ctx, datacenterId, loadbalancerId, nicId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a nic attached to Load Balancer

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancerId := "loadbalancerId_example" // string | The unique ID of the Load Balancer
    nicId := "nicId_example" // string | The unique ID of the NIC
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersBalancednicsFindByNicId(context.Background(), datacenterId, loadbalancerId, nicId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersBalancednicsFindByNicId``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersBalancednicsFindByNicId`: Nic
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersBalancednicsFindByNicId`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

loadbalancerId

string

The unique ID of the Load Balancer

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersBalancednicsFindByNicIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Nic

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLoadbalancersBalancednicsGet

var result BalancedNics = DatacentersLoadbalancersBalancednicsGet(ctx, datacenterId, loadbalancerId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Load Balancer Members

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancerId := "loadbalancerId_example" // string | The unique ID of the Load Balancer
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersBalancednicsGet(context.Background(), datacenterId, loadbalancerId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersBalancednicsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersBalancednicsGet`: BalancedNics
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersBalancednicsGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

loadbalancerId

string

The unique ID of the Load Balancer

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersBalancednicsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

BalancedNics

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLoadbalancersBalancednicsPost

var result Nic = DatacentersLoadbalancersBalancednicsPost(ctx, datacenterId, loadbalancerId)
                      .Nic(nic)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Attach a nic to Load Balancer

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancerId := "loadbalancerId_example" // string | The unique ID of the Load Balancer
    nic := *openapiclient.NewNic(*openapiclient.NewNicProperties(int32(2))) // Nic | Nic id to be attached
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersBalancednicsPost(context.Background(), datacenterId, loadbalancerId).Nic(nic).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersBalancednicsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersBalancednicsPost`: Nic
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersBalancednicsPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

loadbalancerId

string

The unique ID of the Load Balancer

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersBalancednicsPostRequest struct via the builder pattern

Name
Type
Description
Notes

nic

Nic id to be attached

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Nic

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLoadbalancersDelete

var result map[string]interface{} = DatacentersLoadbalancersDelete(ctx, datacenterId, loadbalancerId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Loadbalancer.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancerId := "loadbalancerId_example" // string | The unique ID of the Load Balancer
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersDelete(context.Background(), datacenterId, loadbalancerId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

loadbalancerId

string

The unique ID of the Load Balancer

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLoadbalancersFindById

var result Loadbalancer = DatacentersLoadbalancersFindById(ctx, datacenterId, loadbalancerId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a loadbalancer

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancerId := "loadbalancerId_example" // string | The unique ID of the Load Balancer
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersFindById(context.Background(), datacenterId, loadbalancerId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersFindById`: Loadbalancer
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

loadbalancerId

string

The unique ID of the Load Balancer

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Loadbalancer

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLoadbalancersGet

var result Loadbalancers = DatacentersLoadbalancersGet(ctx, datacenterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Load Balancers

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersGet(context.Background(), datacenterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersGet`: Loadbalancers
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

Loadbalancers

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLoadbalancersPatch

var result Loadbalancer = DatacentersLoadbalancersPatch(ctx, datacenterId, loadbalancerId)
                      .Loadbalancer(loadbalancer)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a Loadbalancer

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancerId := "loadbalancerId_example" // string | The unique ID of the Load Balancer
    loadbalancer := *openapiclient.NewLoadbalancerProperties() // LoadbalancerProperties | Modified Loadbalancer
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersPatch(context.Background(), datacenterId, loadbalancerId).Loadbalancer(loadbalancer).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersPatch`: Loadbalancer
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

loadbalancerId

string

The unique ID of the Load Balancer

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersPatchRequest struct via the builder pattern

Name
Type
Description
Notes

loadbalancer

Modified Loadbalancer

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Loadbalancer

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLoadbalancersPost

var result Loadbalancer = DatacentersLoadbalancersPost(ctx, datacenterId)
                      .Loadbalancer(loadbalancer)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Load Balancer

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancer := *openapiclient.NewLoadbalancer(*openapiclient.NewLoadbalancerProperties()) // Loadbalancer | Loadbalancer to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersPost(context.Background(), datacenterId).Loadbalancer(loadbalancer).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersPost`: Loadbalancer
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersPostRequest struct via the builder pattern

Name
Type
Description
Notes

loadbalancer

Loadbalancer to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Loadbalancer

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLoadbalancersPut

var result Loadbalancer = DatacentersLoadbalancersPut(ctx, datacenterId, loadbalancerId)
                      .Loadbalancer(loadbalancer)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a Load Balancer

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    loadbalancerId := "loadbalancerId_example" // string | The unique ID of the Load Balancer
    loadbalancer := *openapiclient.NewLoadbalancer(*openapiclient.NewLoadbalancerProperties()) // Loadbalancer | Modified Loadbalancer
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LoadBalancerApi.DatacentersLoadbalancersPut(context.Background(), datacenterId, loadbalancerId).Loadbalancer(loadbalancer).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LoadBalancerApi.DatacentersLoadbalancersPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLoadbalancersPut`: Loadbalancer
    fmt.Fprintf(os.Stdout, "Response from `LoadBalancerApi.DatacentersLoadbalancersPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

loadbalancerId

string

The unique ID of the Load Balancer

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLoadbalancersPutRequest struct via the builder pattern

Name
Type
Description
Notes

loadbalancer

Modified Loadbalancer

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Loadbalancer

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLoadbalancersBalancednicsDelete
DatacentersLoadbalancersBalancednicsFindByNicId
DatacentersLoadbalancersBalancednicsGet
DatacentersLoadbalancersBalancednicsPost
DatacentersLoadbalancersDelete
DatacentersLoadbalancersFindById
DatacentersLoadbalancersGet
DatacentersLoadbalancersPatch
DatacentersLoadbalancersPost
DatacentersLoadbalancersPut
Nic
LoadbalancerProperties
Loadbalancer
Loadbalancer

NicApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}

Delete a Nic

Get /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}

Retrieve a Nic

Delete /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}

Delete a Firewall Rule

Get /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}

Retrieve a Firewall Rule

Get /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules

List Firewall Rules

Patch /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}

Partially modify a Firewall Rule

Post /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules

Create a Firewall Rule

Put /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}

Modify a Firewall Rule

Get /datacenters/{datacenterId}/servers/{serverId}/nics

List Nics

Patch /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}

Partially modify a Nic

Post /datacenters/{datacenterId}/servers/{serverId}/nics

Create a Nic

Put /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}

Modify a Nic

DatacentersServersNicsDelete

var result map[string]interface{} = DatacentersServersNicsDelete(ctx, datacenterId, serverId, nicId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Nic

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsDelete(context.Background(), datacenterId, serverId, nicId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersNicsFindById

var result Nic = DatacentersServersNicsFindById(ctx, datacenterId, serverId, nicId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Nic

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsFindById(context.Background(), datacenterId, serverId, nicId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsFindById`: Nic
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Nic

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersNicsFirewallrulesDelete

var result map[string]interface{} = DatacentersServersNicsFirewallrulesDelete(ctx, datacenterId, serverId, nicId, firewallruleId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Firewall Rule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    firewallruleId := "firewallruleId_example" // string | The unique ID of the Firewall Rule
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsFirewallrulesDelete(context.Background(), datacenterId, serverId, nicId, firewallruleId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsFirewallrulesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsFirewallrulesDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsFirewallrulesDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

firewallruleId

string

The unique ID of the Firewall Rule

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsFirewallrulesDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersNicsFirewallrulesFindById

var result FirewallRule = DatacentersServersNicsFirewallrulesFindById(ctx, datacenterId, serverId, nicId, firewallruleId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Firewall Rule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    firewallruleId := "firewallruleId_example" // string | The unique ID of the Firewall Rule
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsFirewallrulesFindById(context.Background(), datacenterId, serverId, nicId, firewallruleId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsFirewallrulesFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsFirewallrulesFindById`: FirewallRule
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsFirewallrulesFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

firewallruleId

string

The unique ID of the Firewall Rule

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsFirewallrulesFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

FirewallRule

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersNicsFirewallrulesGet

var result FirewallRules = DatacentersServersNicsFirewallrulesGet(ctx, datacenterId, serverId, nicId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Firewall Rules

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsFirewallrulesGet(context.Background(), datacenterId, serverId, nicId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsFirewallrulesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsFirewallrulesGet`: FirewallRules
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsFirewallrulesGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsFirewallrulesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

FirewallRules

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersNicsFirewallrulesPatch

var result FirewallRule = DatacentersServersNicsFirewallrulesPatch(ctx, datacenterId, serverId, nicId, firewallruleId)
                      .Firewallrule(firewallrule)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a Firewall Rule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    firewallruleId := "firewallruleId_example" // string | The unique ID of the Firewall Rule
    firewallrule := *openapiclient.NewFirewallruleProperties("TCP") // FirewallruleProperties | Modified Firewall Rule
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsFirewallrulesPatch(context.Background(), datacenterId, serverId, nicId, firewallruleId).Firewallrule(firewallrule).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsFirewallrulesPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsFirewallrulesPatch`: FirewallRule
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsFirewallrulesPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

firewallruleId

string

The unique ID of the Firewall Rule

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsFirewallrulesPatchRequest struct via the builder pattern

Name
Type
Description
Notes

firewallrule

Modified Firewall Rule

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

FirewallRule

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersNicsFirewallrulesPost

var result FirewallRule = DatacentersServersNicsFirewallrulesPost(ctx, datacenterId, serverId, nicId)
                      .Firewallrule(firewallrule)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Firewall Rule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the server
    nicId := "nicId_example" // string | The unique ID of the NIC
    firewallrule := *openapiclient.NewFirewallRule(*openapiclient.NewFirewallruleProperties("TCP")) // FirewallRule | Firewall Rule to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsFirewallrulesPost(context.Background(), datacenterId, serverId, nicId).Firewallrule(firewallrule).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsFirewallrulesPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsFirewallrulesPost`: FirewallRule
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsFirewallrulesPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the server

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsFirewallrulesPostRequest struct via the builder pattern

Name
Type
Description
Notes

firewallrule

Firewall Rule to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

FirewallRule

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersNicsFirewallrulesPut

var result FirewallRule = DatacentersServersNicsFirewallrulesPut(ctx, datacenterId, serverId, nicId, firewallruleId)
                      .Firewallrule(firewallrule)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a Firewall Rule

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    firewallruleId := "firewallruleId_example" // string | The unique ID of the Firewall Rule
    firewallrule := *openapiclient.NewFirewallRule(*openapiclient.NewFirewallruleProperties("TCP")) // FirewallRule | Modified Firewall Rule
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsFirewallrulesPut(context.Background(), datacenterId, serverId, nicId, firewallruleId).Firewallrule(firewallrule).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsFirewallrulesPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsFirewallrulesPut`: FirewallRule
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsFirewallrulesPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

firewallruleId

string

The unique ID of the Firewall Rule

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsFirewallrulesPutRequest struct via the builder pattern

Name
Type
Description
Notes

firewallrule

Modified Firewall Rule

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

FirewallRule

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersNicsGet

var result Nics = DatacentersServersNicsGet(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Nics

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsGet(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsGet`: Nics
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

Nics

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersNicsPatch

var result Nic = DatacentersServersNicsPatch(ctx, datacenterId, serverId, nicId)
                      .Nic(nic)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a Nic

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    nic := *openapiclient.NewNicProperties(int32(2)) // NicProperties | Modified properties of Nic
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsPatch(context.Background(), datacenterId, serverId, nicId).Nic(nic).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsPatch`: Nic
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsPatchRequest struct via the builder pattern

Name
Type
Description
Notes

nic

Modified properties of Nic

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Nic

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersNicsPost

var result Nic = DatacentersServersNicsPost(ctx, datacenterId, serverId)
                      .Nic(nic)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Nic

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nic := *openapiclient.NewNic(*openapiclient.NewNicProperties(int32(2))) // Nic | Nic to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsPost(context.Background(), datacenterId, serverId).Nic(nic).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsPost`: Nic
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsPostRequest struct via the builder pattern

Name
Type
Description
Notes

nic

Nic to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Nic

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersNicsPut

var result Nic = DatacentersServersNicsPut(ctx, datacenterId, serverId, nicId)
                      .Nic(nic)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a Nic

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    nicId := "nicId_example" // string | The unique ID of the NIC
    nic := *openapiclient.NewNic(*openapiclient.NewNicProperties(int32(2))) // Nic | Modified Nic
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.NicApi.DatacentersServersNicsPut(context.Background(), datacenterId, serverId, nicId).Nic(nic).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `NicApi.DatacentersServersNicsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersNicsPut`: Nic
    fmt.Fprintf(os.Stdout, "Response from `NicApi.DatacentersServersNicsPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

nicId

string

The unique ID of the NIC

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersNicsPutRequest struct via the builder pattern

Name
Type
Description
Notes

nic

Modified Nic

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Nic

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersNicsDelete
DatacentersServersNicsFindById
DatacentersServersNicsFirewallrulesDelete
DatacentersServersNicsFirewallrulesFindById
DatacentersServersNicsFirewallrulesGet
DatacentersServersNicsFirewallrulesPatch
DatacentersServersNicsFirewallrulesPost
DatacentersServersNicsFirewallrulesPut
DatacentersServersNicsGet
DatacentersServersNicsPatch
DatacentersServersNicsPost
DatacentersServersNicsPut
FirewallruleProperties
FirewallRule
FirewallRule
NicProperties
Nic
Nic

KubernetesApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /k8s/{k8sClusterId}

Delete Kubernetes Cluster

Get /k8s/{k8sClusterId}

Retrieve Kubernetes Cluster

Get /k8s

List Kubernetes Clusters

Get /k8s/{k8sClusterId}/kubeconfig

Retrieve Kubernetes Configuration File

Delete /k8s/{k8sClusterId}/nodepools/{nodepoolId}

Delete Kubernetes Node Pool

Get /k8s/{k8sClusterId}/nodepools/{nodepoolId}

Retrieve Kubernetes Node Pool

Get /k8s/{k8sClusterId}/nodepools

List Kubernetes Node Pools

Delete /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}

Delete Kubernetes node

Get /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}

Retrieve Kubernetes node

Get /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes

Retrieve Kubernetes nodes.

Post /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace

Recreate the Kubernetes node

Post /k8s/{k8sClusterId}/nodepools

Create a Kubernetes Node Pool

Put /k8s/{k8sClusterId}/nodepools/{nodepoolId}

Modify Kubernetes Node Pool

Post /k8s

Create Kubernetes Cluster

Put /k8s/{k8sClusterId}

Modify Kubernetes Cluster

Get /k8s/versions/{clusterVersion}/compatibilities

Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.

Get /k8s/versions/default

Retrieve the current default kubernetes version for clusters and nodepools.

Get /k8s/versions

Retrieve available Kubernetes versions

K8sDelete

var result map[string]interface{} = K8sDelete(ctx, k8sClusterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete Kubernetes Cluster

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sDelete(context.Background(), k8sClusterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

Other Parameters

Other parameters are passed through a pointer to a apiK8sDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sFindByClusterId

var result KubernetesCluster = K8sFindByClusterId(ctx, k8sClusterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve Kubernetes Cluster

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sFindByClusterId(context.Background(), k8sClusterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sFindByClusterId``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sFindByClusterId`: KubernetesCluster
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sFindByClusterId`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

Other Parameters

Other parameters are passed through a pointer to a apiK8sFindByClusterIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesCluster

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sGet

var result KubernetesClusters = K8sGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List Kubernetes Clusters

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sGet`: KubernetesClusters
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiK8sGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesClusters

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sKubeconfigGet

var result KubernetesConfig = K8sKubeconfigGet(ctx, k8sClusterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve Kubernetes Configuration File

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sKubeconfigGet(context.Background(), k8sClusterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sKubeconfigGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sKubeconfigGet`: KubernetesConfig
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sKubeconfigGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

Other Parameters

Other parameters are passed through a pointer to a apiK8sKubeconfigGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesConfig

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsDelete

var result map[string]interface{} = K8sNodepoolsDelete(ctx, k8sClusterId, nodepoolId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete Kubernetes Node Pool

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    nodepoolId := "nodepoolId_example" // string | The unique ID of the Kubernetes Node Pool
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsDelete(context.Background(), k8sClusterId, nodepoolId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

nodepoolId

string

The unique ID of the Kubernetes Node Pool

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsFindById

var result KubernetesNodePool = K8sNodepoolsFindById(ctx, k8sClusterId, nodepoolId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve Kubernetes Node Pool

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    nodepoolId := "nodepoolId_example" // string | The unique ID of the Kubernetes Node Pool
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsFindById(context.Background(), k8sClusterId, nodepoolId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsFindById`: KubernetesNodePool
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

nodepoolId

string

The unique ID of the Kubernetes Node Pool

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesNodePool

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsGet

var result KubernetesNodePools = K8sNodepoolsGet(ctx, k8sClusterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List Kubernetes Node Pools

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsGet(context.Background(), k8sClusterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsGet`: KubernetesNodePools
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesNodePools

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsNodesDelete

var result map[string]interface{} = K8sNodepoolsNodesDelete(ctx, k8sClusterId, nodepoolId, nodeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete Kubernetes node

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    nodepoolId := "nodepoolId_example" // string | The unique ID of the Kubernetes Node Pool
    nodeId := "nodeId_example" // string | The unique ID of the Kubernetes node
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsNodesDelete(context.Background(), k8sClusterId, nodepoolId, nodeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsNodesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsNodesDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsNodesDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

nodepoolId

string

The unique ID of the Kubernetes Node Pool

nodeId

string

The unique ID of the Kubernetes node

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsNodesDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsNodesFindById

var result KubernetesNode = K8sNodepoolsNodesFindById(ctx, k8sClusterId, nodepoolId, nodeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve Kubernetes node

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    nodepoolId := "nodepoolId_example" // string | The unique ID of the Kubernetes Node Pool
    nodeId := "nodeId_example" // string | The unique ID of the Kubernetes Node.
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsNodesFindById(context.Background(), k8sClusterId, nodepoolId, nodeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsNodesFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsNodesFindById`: KubernetesNode
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsNodesFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

nodepoolId

string

The unique ID of the Kubernetes Node Pool

nodeId

string

The unique ID of the Kubernetes Node.

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsNodesFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesNode

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsNodesGet

var result KubernetesNodes = K8sNodepoolsNodesGet(ctx, k8sClusterId, nodepoolId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve Kubernetes nodes.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    nodepoolId := "nodepoolId_example" // string | The unique ID of the Kubernetes Node Pool
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsNodesGet(context.Background(), k8sClusterId, nodepoolId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsNodesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsNodesGet`: KubernetesNodes
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsNodesGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

nodepoolId

string

The unique ID of the Kubernetes Node Pool

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsNodesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesNodes

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsNodesReplacePost

var result map[string]interface{} = K8sNodepoolsNodesReplacePost(ctx, k8sClusterId, nodepoolId, nodeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Recreate the Kubernetes node

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    nodepoolId := "nodepoolId_example" // string | The unique ID of the Kubernetes Node Pool
    nodeId := "nodeId_example" // string | The unique ID of the Kubernetes Node.
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsNodesReplacePost(context.Background(), k8sClusterId, nodepoolId, nodeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsNodesReplacePost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsNodesReplacePost`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsNodesReplacePost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

nodepoolId

string

The unique ID of the Kubernetes Node Pool

nodeId

string

The unique ID of the Kubernetes Node.

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsNodesReplacePostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsPost

var result KubernetesNodePool = K8sNodepoolsPost(ctx, k8sClusterId)
                      .KubernetesNodePool(kubernetesNodePool)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Kubernetes Node Pool

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    kubernetesNodePool := *openapiclient.NewKubernetesNodePoolForPost(*openapiclient.NewKubernetesNodePoolPropertiesForPost("k8s-node-pool", "1e072e52-2ed3-492f-b6b6-c6b116907521", int32(2), "AMD_OPTERON", int32(4), int32(2048), "AUTO", "HDD", int32(100))) // KubernetesNodePoolForPost | Details of the Kubernetes Node Pool
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsPost(context.Background(), k8sClusterId).KubernetesNodePool(kubernetesNodePool).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsPost`: KubernetesNodePool
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsPostRequest struct via the builder pattern

Name
Type
Description
Notes

kubernetesNodePool

Details of the Kubernetes Node Pool

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesNodePool

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

K8sNodepoolsPut

var result KubernetesNodePool = K8sNodepoolsPut(ctx, k8sClusterId, nodepoolId)
                      .KubernetesNodePool(kubernetesNodePool)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify Kubernetes Node Pool

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    nodepoolId := "nodepoolId_example" // string | The unique ID of the Kubernetes Node Pool
    kubernetesNodePool := *openapiclient.NewKubernetesNodePoolForPut(*openapiclient.NewKubernetesNodePoolPropertiesForPut(int32(2))) // KubernetesNodePoolForPut | Details of the Kubernetes Node Pool
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sNodepoolsPut(context.Background(), k8sClusterId, nodepoolId).KubernetesNodePool(kubernetesNodePool).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sNodepoolsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sNodepoolsPut`: KubernetesNodePool
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sNodepoolsPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

nodepoolId

string

The unique ID of the Kubernetes Node Pool

Other Parameters

Other parameters are passed through a pointer to a apiK8sNodepoolsPutRequest struct via the builder pattern

Name
Type
Description
Notes

kubernetesNodePool

Details of the Kubernetes Node Pool

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesNodePool

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

K8sPost

var result KubernetesCluster = K8sPost(ctx)
                      .KubernetesCluster(kubernetesCluster)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create Kubernetes Cluster

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    kubernetesCluster := *openapiclient.NewKubernetesClusterForPost(*openapiclient.NewKubernetesClusterPropertiesForPost("k8s")) // KubernetesClusterForPost | Details of the Kubernetes Cluster
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sPost(context.Background()).KubernetesCluster(kubernetesCluster).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sPost`: KubernetesCluster
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiK8sPostRequest struct via the builder pattern

Name
Type
Description
Notes

kubernetesCluster

Details of the Kubernetes Cluster

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesCluster

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

K8sPut

var result KubernetesCluster = K8sPut(ctx, k8sClusterId)
                      .KubernetesCluster(kubernetesCluster)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify Kubernetes Cluster

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    k8sClusterId := "k8sClusterId_example" // string | The unique ID of the Kubernetes Cluster
    kubernetesCluster := *openapiclient.NewKubernetesClusterForPut(*openapiclient.NewKubernetesClusterPropertiesForPut("k8s")) // KubernetesClusterForPut | Details of the Kubernetes Cluster
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sPut(context.Background(), k8sClusterId).KubernetesCluster(kubernetesCluster).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sPut`: KubernetesCluster
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes Cluster

Other Parameters

Other parameters are passed through a pointer to a apiK8sPutRequest struct via the builder pattern

Name
Type
Description
Notes

kubernetesCluster

Details of the Kubernetes Cluster

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

KubernetesCluster

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

K8sVersionsCompatibilitiesGet

var result []string = K8sVersionsCompatibilitiesGet(ctx, clusterVersion)
                      .Execute()

Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    clusterVersion := "clusterVersion_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sVersionsCompatibilitiesGet(context.Background(), clusterVersion).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sVersionsCompatibilitiesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sVersionsCompatibilitiesGet`: []string
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sVersionsCompatibilitiesGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

clusterVersion

string

Other Parameters

Other parameters are passed through a pointer to a apiK8sVersionsCompatibilitiesGetRequest struct via the builder pattern

Return type

[]string

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sVersionsDefaultGet

var result string = K8sVersionsDefaultGet(ctx)
                      .Execute()

Retrieve the current default kubernetes version for clusters and nodepools.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sVersionsDefaultGet(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sVersionsDefaultGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sVersionsDefaultGet`: string
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sVersionsDefaultGet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiK8sVersionsDefaultGetRequest struct via the builder pattern

Return type

string

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sVersionsGet

var result []string = K8sVersionsGet(ctx)
                      .Execute()

Retrieve available Kubernetes versions

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.KubernetesApi.K8sVersionsGet(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `KubernetesApi.K8sVersionsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `K8sVersionsGet`: []string
    fmt.Fprintf(os.Stdout, "Response from `KubernetesApi.K8sVersionsGet`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiK8sVersionsGetRequest struct via the builder pattern

Return type

[]string

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sDelete
K8sFindByClusterId
K8sGet
K8sKubeconfigGet
K8sNodepoolsDelete
K8sNodepoolsFindById
K8sNodepoolsGet
K8sNodepoolsNodesDelete
K8sNodepoolsNodesFindById
K8sNodepoolsNodesGet
K8sNodepoolsNodesReplacePost
K8sNodepoolsPost
K8sNodepoolsPut
K8sPost
K8sPut
K8sVersionsCompatibilitiesGet
K8sVersionsDefaultGet
K8sVersionsGet
KubernetesNodePoolForPost
KubernetesNodePoolForPut
KubernetesClusterForPost
KubernetesClusterForPut

ServerApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}

Detach a CD-ROM

Get /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}

Retrieve an attached CD-ROM

Get /datacenters/{datacenterId}/servers/{serverId}/cdroms

List attached CD-ROMs

Post /datacenters/{datacenterId}/servers/{serverId}/cdroms

Attach a CD-ROM

Delete /datacenters/{datacenterId}/servers/{serverId}

Delete a Server

Get /datacenters/{datacenterId}/servers/{serverId}

Retrieve a Server

Get /datacenters/{datacenterId}/servers

List Servers

Patch /datacenters/{datacenterId}/servers/{serverId}

Partially modify a Server

Post /datacenters/{datacenterId}/servers

Create a Server

Put /datacenters/{datacenterId}/servers/{serverId}

Modify a Server

Post /datacenters/{datacenterId}/servers/{serverId}/reboot

Reboot a Server

Post /datacenters/{datacenterId}/servers/{serverId}/start

Start a Server

Post /datacenters/{datacenterId}/servers/{serverId}/stop

Stop a Server

Post /datacenters/{datacenterId}/servers/{serverId}/upgrade

Upgrade a Server

Delete /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}

Detach a volume

Get /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}

Retrieve an attached volume

Get /datacenters/{datacenterId}/servers/{serverId}/volumes

List Attached Volumes

Post /datacenters/{datacenterId}/servers/{serverId}/volumes

Attach a volume

DatacentersServersCdromsDelete

var result map[string]interface{} = DatacentersServersCdromsDelete(ctx, datacenterId, serverId, cdromId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Detach a CD-ROM

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    cdromId := "cdromId_example" // string | The unique ID of the CD-ROM
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersCdromsDelete(context.Background(), datacenterId, serverId, cdromId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersCdromsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersCdromsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersCdromsDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

cdromId

string

The unique ID of the CD-ROM

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersCdromsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersCdromsFindById

var result Image = DatacentersServersCdromsFindById(ctx, datacenterId, serverId, cdromId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve an attached CD-ROM

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    cdromId := "cdromId_example" // string | The unique ID of the CD-ROM
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersCdromsFindById(context.Background(), datacenterId, serverId, cdromId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersCdromsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersCdromsFindById`: Image
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersCdromsFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

cdromId

string

The unique ID of the CD-ROM

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersCdromsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Image

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersCdromsGet

var result Cdroms = DatacentersServersCdromsGet(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List attached CD-ROMs

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersCdromsGet(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersCdromsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersCdromsGet`: Cdroms
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersCdromsGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersCdromsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

Cdroms

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersCdromsPost

var result Image = DatacentersServersCdromsPost(ctx, datacenterId, serverId)
                      .Cdrom(cdrom)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Attach a CD-ROM

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    cdrom := *openapiclient.NewImage(*openapiclient.NewImageProperties("LINUX")) // Image | CD-ROM to be attached
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersCdromsPost(context.Background(), datacenterId, serverId).Cdrom(cdrom).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersCdromsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersCdromsPost`: Image
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersCdromsPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersCdromsPostRequest struct via the builder pattern

Name
Type
Description
Notes

cdrom

CD-ROM to be attached

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Image

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersDelete

var result map[string]interface{} = DatacentersServersDelete(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersDelete(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersFindById

var result Server = DatacentersServersFindById(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersFindById(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersFindById`: Server
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Server

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersGet

var result Servers = DatacentersServersGet(ctx, datacenterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .UpgradeNeeded(upgradeNeeded)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Servers

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    upgradeNeeded := true // bool | It can be used to filter which servers can be upgraded which can not be upgraded. (optional)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersGet(context.Background(), datacenterId).Pretty(pretty).Depth(depth).UpgradeNeeded(upgradeNeeded).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersGet`: Servers
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

upgradeNeeded

bool

It can be used to filter which servers can be upgraded which can not be upgraded.

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

Servers

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersPatch

var result Server = DatacentersServersPatch(ctx, datacenterId, serverId)
                      .Server(server)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Partially modify a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the server
    server := *openapiclient.NewServerProperties(int32(4), int32(4096)) // ServerProperties | Modified properties of Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersPatch(context.Background(), datacenterId, serverId).Server(server).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersPatch`: Server
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersPatch`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersPatchRequest struct via the builder pattern

Name
Type
Description
Notes

server

Modified properties of Server

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Server

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersPost

var result Server = DatacentersServersPost(ctx, datacenterId)
                      .Server(server)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    server := *openapiclient.NewServer(*openapiclient.NewServerProperties(int32(4), int32(4096))) // Server | Server to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersPost(context.Background(), datacenterId).Server(server).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersPost`: Server
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersPostRequest struct via the builder pattern

Name
Type
Description
Notes

server

Server to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Server

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersPut

var result Server = DatacentersServersPut(ctx, datacenterId, serverId)
                      .Server(server)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the server
    server := *openapiclient.NewServer(*openapiclient.NewServerProperties(int32(4), int32(4096))) // Server | Modified Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersPut(context.Background(), datacenterId, serverId).Server(server).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersPut`: Server
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersPutRequest struct via the builder pattern

Name
Type
Description
Notes

server

Modified Server

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Server

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersRebootPost

var result map[string]interface{} = DatacentersServersRebootPost(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Reboot a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersRebootPost(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersRebootPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersRebootPost`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersRebootPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersRebootPostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersStartPost

var result map[string]interface{} = DatacentersServersStartPost(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Start a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersStartPost(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersStartPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersStartPost`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersStartPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersStartPostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersStopPost

var result map[string]interface{} = DatacentersServersStopPost(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Stop a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersStopPost(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersStopPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersStopPost`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersStopPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersStopPostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersUpgradePost

var result map[string]interface{} = DatacentersServersUpgradePost(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Upgrade a Server

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersUpgradePost(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersUpgradePost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersUpgradePost`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersUpgradePost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersUpgradePostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersVolumesDelete

var result map[string]interface{} = DatacentersServersVolumesDelete(ctx, datacenterId, serverId, volumeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Detach a volume

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersVolumesDelete(context.Background(), datacenterId, serverId, volumeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersVolumesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersVolumesDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersVolumesDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

volumeId

string

The unique ID of the Volume

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersVolumesDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersVolumesFindById

var result Volume = DatacentersServersVolumesFindById(ctx, datacenterId, serverId, volumeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve an attached volume

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersVolumesFindById(context.Background(), datacenterId, serverId, volumeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersVolumesFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersVolumesFindById`: Volume
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersVolumesFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

volumeId

string

The unique ID of the Volume

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersVolumesFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Volume

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersVolumesGet

var result AttachedVolumes = DatacentersServersVolumesGet(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List Attached Volumes

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersVolumesGet(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersVolumesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersVolumesGet`: AttachedVolumes
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersVolumesGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersVolumesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

Return type

AttachedVolumes

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersVolumesPost

var result Volume = DatacentersServersVolumesPost(ctx, datacenterId, serverId)
                      .Volume(volume)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Attach a volume

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    volume := *openapiclient.NewVolume(*openapiclient.NewVolumeProperties(float32(100.0))) // Volume | Volume to be attached (created and attached)
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ServerApi.DatacentersServersVolumesPost(context.Background(), datacenterId, serverId).Volume(volume).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServerApi.DatacentersServersVolumesPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersVolumesPost`: Volume
    fmt.Fprintf(os.Stdout, "Response from `ServerApi.DatacentersServersVolumesPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersVolumesPostRequest struct via the builder pattern

Name
Type
Description
Notes

volume

Volume to be attached (created and attached)

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Volume

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersCdromsDelete
DatacentersServersCdromsFindById
DatacentersServersCdromsGet
DatacentersServersCdromsPost
DatacentersServersDelete
DatacentersServersFindById
DatacentersServersGet
DatacentersServersPatch
DatacentersServersPost
DatacentersServersPut
DatacentersServersRebootPost
DatacentersServersStartPost
DatacentersServersStopPost
DatacentersServersUpgradePost
DatacentersServersVolumesDelete
DatacentersServersVolumesFindById
DatacentersServersVolumesGet
DatacentersServersVolumesPost
Image
ServerProperties
Server
Server
Volume

UserManagementApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

Delete /um/groups/{groupId}

Delete a Group

Get /um/groups/{groupId}

Retrieve a Group

Get /um/groups

List All Groups.

Post /um/groups

Create a Group

Put /um/groups/{groupId}

Modify a group

Get /um/groups/{groupId}/resources

Retrieve resources assigned to a group

Delete /um/groups/{groupId}/shares/{resourceId}

Remove a resource from a group

Get /um/groups/{groupId}/shares/{resourceId}

Retrieve a group share

Get /um/groups/{groupId}/shares

List Group Shares

Post /um/groups/{groupId}/shares/{resourceId}

Add a resource to a group

Put /um/groups/{groupId}/shares/{resourceId}

Modify resource permissions of a group

Delete /um/groups/{groupId}/users/{userId}

Remove a user from a group

Get /um/groups/{groupId}/users

List Group Members

Post /um/groups/{groupId}/users

Add a user to a group

Get /um/resources/{resourceType}

Retrieve a list of Resources by type.

Get /um/resources/{resourceType}/{resourceId}

Retrieve a Resource by type.

Get /um/resources

List All Resources.

Delete /um/users/{userId}

Delete a User

Get /um/users/{userId}

Retrieve a User

Get /um/users

List all Users

Get /um/users/{userId}/groups

Retrieve a User's group resources

Get /um/users/{userId}/owns

Retrieve a User's own resources

Post /um/users

Create a user

Put /um/users/{userId}

Modify a user

Delete /um/users/{userId}/s3keys/{keyId}

Delete a S3 key

Get /um/users/{userId}/s3keys/{keyId}

Retrieve given S3 key belonging to the given User

Get /um/users/{userId}/s3keys

Retrieve a User's S3 keys

Post /um/users/{userId}/s3keys

Create a S3 key for the given user

Put /um/users/{userId}/s3keys/{keyId}

Modify a S3 key having the given key id

Get /um/users/{userId}/s3ssourl

Retrieve S3 object storage single signon URL for the given user

UmGroupsDelete

var result map[string]interface{} = UmGroupsDelete(ctx, groupId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a Group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | The unique ID of the group
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsDelete(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

The unique ID of the group

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsFindById

var result Group = UmGroupsFindById(ctx, groupId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | The unique ID of the group
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsFindById(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsFindById`: Group
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

The unique ID of the group

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Group

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsGet

var result Groups = UmGroupsGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List All Groups.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsGet`: Groups
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Groups

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsPost

var result Group = UmGroupsPost(ctx)
                      .Group(group)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a Group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    group := *openapiclient.NewGroup(*openapiclient.NewGroupProperties()) // Group | Group to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsPost(context.Background()).Group(group).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsPost`: Group
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsPostRequest struct via the builder pattern

Name
Type
Description
Notes

group

Group to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Group

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

UmGroupsPut

var result Group = UmGroupsPut(ctx, groupId)
                      .Group(group)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | The unique ID of the group
    group := *openapiclient.NewGroup(*openapiclient.NewGroupProperties()) // Group | Modified properties of the Group
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsPut(context.Background(), groupId).Group(group).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsPut`: Group
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

The unique ID of the group

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsPutRequest struct via the builder pattern

Name
Type
Description
Notes

group

Modified properties of the Group

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Group

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

UmGroupsResourcesGet

var result ResourceGroups = UmGroupsResourcesGet(ctx, groupId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve resources assigned to a group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | The unique ID of the group
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsResourcesGet(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsResourcesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsResourcesGet`: ResourceGroups
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsResourcesGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

The unique ID of the group

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsResourcesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

ResourceGroups

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsSharesDelete

var result map[string]interface{} = UmGroupsSharesDelete(ctx, groupId, resourceId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Remove a resource from a group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | 
    resourceId := "resourceId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsSharesDelete(context.Background(), groupId, resourceId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsSharesDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

resourceId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsSharesDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsSharesFindByResourceId

var result GroupShare = UmGroupsSharesFindByResourceId(ctx, groupId, resourceId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a group share

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | 
    resourceId := "resourceId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsSharesFindByResourceId(context.Background(), groupId, resourceId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesFindByResourceId``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsSharesFindByResourceId`: GroupShare
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesFindByResourceId`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

resourceId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsSharesFindByResourceIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

GroupShare

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsSharesGet

var result GroupShares = UmGroupsSharesGet(ctx, groupId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List Group Shares

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsSharesGet(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsSharesGet`: GroupShares
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsSharesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

GroupShares

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsSharesPost

var result GroupShare = UmGroupsSharesPost(ctx, groupId, resourceId)
                      .Resource(resource)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Add a resource to a group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | 
    resourceId := "resourceId_example" // string | 
    resource := *openapiclient.NewGroupShare(*openapiclient.NewGroupShareProperties()) // GroupShare | Resource to be added
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsSharesPost(context.Background(), groupId, resourceId).Resource(resource).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsSharesPost`: GroupShare
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

resourceId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsSharesPostRequest struct via the builder pattern

Name
Type
Description
Notes

resource

Resource to be added

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

GroupShare

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsSharesPut

var result GroupShare = UmGroupsSharesPut(ctx, groupId, resourceId)
                      .Resource(resource)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify resource permissions of a group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | 
    resourceId := "resourceId_example" // string | 
    resource := *openapiclient.NewGroupShare(*openapiclient.NewGroupShareProperties()) // GroupShare | Modified Resource
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsSharesPut(context.Background(), groupId, resourceId).Resource(resource).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsSharesPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsSharesPut`: GroupShare
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsSharesPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

resourceId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsSharesPutRequest struct via the builder pattern

Name
Type
Description
Notes

resource

Modified Resource

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

GroupShare

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

UmGroupsUsersDelete

var result map[string]interface{} = UmGroupsUsersDelete(ctx, groupId, userId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Remove a user from a group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | 
    userId := "userId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsUsersDelete(context.Background(), groupId, userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsUsersDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsUsersDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsUsersDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

userId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsUsersDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsUsersGet

var result GroupMembers = UmGroupsUsersGet(ctx, groupId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List Group Members

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | 
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsUsersGet(context.Background(), groupId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsUsersGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsUsersGet`: GroupMembers
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsUsersGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsUsersGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

GroupMembers

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmGroupsUsersPost

var result User = UmGroupsUsersPost(ctx, groupId)
                      .User(user)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Add a user to a group

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupId := "groupId_example" // string | 
    user := *openapiclient.NewUser(*openapiclient.NewUserProperties()) // User | User to be added
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmGroupsUsersPost(context.Background(), groupId).User(user).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmGroupsUsersPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmGroupsUsersPost`: User
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmGroupsUsersPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmGroupsUsersPostRequest struct via the builder pattern

Name
Type
Description
Notes

user

User to be added

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

User

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

UmResourcesFindByType

var result Resources = UmResourcesFindByType(ctx, resourceType)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a list of Resources by type.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    resourceType := "resourceType_example" // string | The resource Type
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmResourcesFindByType(context.Background(), resourceType).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmResourcesFindByType``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmResourcesFindByType`: Resources
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmResourcesFindByType`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

resourceType

string

The resource Type

Other Parameters

Other parameters are passed through a pointer to a apiUmResourcesFindByTypeRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Resources

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmResourcesFindByTypeAndId

var result Resource = UmResourcesFindByTypeAndId(ctx, resourceType, resourceId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a Resource by type.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    resourceType := "resourceType_example" // string | The resource Type
    resourceId := "resourceId_example" // string | The resource Uuid
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmResourcesFindByTypeAndId(context.Background(), resourceType, resourceId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmResourcesFindByTypeAndId``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmResourcesFindByTypeAndId`: Resource
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmResourcesFindByTypeAndId`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

resourceType

string

The resource Type

resourceId

string

The resource Uuid

Other Parameters

Other parameters are passed through a pointer to a apiUmResourcesFindByTypeAndIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Resource

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmResourcesGet

var result Resources = UmResourcesGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

List All Resources.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmResourcesGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmResourcesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmResourcesGet`: Resources
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmResourcesGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUmResourcesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

Resources

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersDelete

var result map[string]interface{} = UmUsersDelete(ctx, userId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a User

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersDelete(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersFindById

var result User = UmUsersFindById(ctx, userId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a User

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersFindById(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersFindById`: User
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersFindById`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

User

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersGet

var result Users = UmUsersGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()

List all Users

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 100)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersGet`: Users
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 100]

Return type

Users

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersGroupsGet

var result ResourceGroups = UmUsersGroupsGet(ctx, userId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a User's group resources

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersGroupsGet(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersGroupsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersGroupsGet`: ResourceGroups
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersGroupsGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersGroupsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

ResourceGroups

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersOwnsGet

var result ResourcesUsers = UmUsersOwnsGet(ctx, userId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a User's own resources

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersOwnsGet(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersOwnsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersOwnsGet`: ResourcesUsers
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersOwnsGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersOwnsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

ResourcesUsers

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersPost

var result User = UmUsersPost(ctx)
                      .User(user)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a user

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    user := *openapiclient.NewUserPost(*openapiclient.NewUserPropertiesPost()) // UserPost | User to be created
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersPost(context.Background()).User(user).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersPost`: User
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersPost`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersPostRequest struct via the builder pattern

Name
Type
Description
Notes

user

User to be created

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

User

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

UmUsersPut

var result User = UmUsersPut(ctx, userId)
                      .User(user)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a user

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | 
    user := *openapiclient.NewUserPut(*openapiclient.NewUserPropertiesPut()) // UserPut | Modified user
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersPut(context.Background(), userId).User(user).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersPut`: User
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersPutRequest struct via the builder pattern

Name
Type
Description
Notes

user

Modified user

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

User

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

UmUsersS3keysDelete

var result map[string]interface{} = UmUsersS3keysDelete(ctx, userId, keyId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Delete a S3 key

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    keyId := "keyId_example" // string | The unique access key ID of the S3 key
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersS3keysDelete(context.Background(), userId, keyId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersS3keysDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersS3keysDelete`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

keyId

string

The unique access key ID of the S3 key

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersS3keysDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersS3keysFindByKeyId

var result S3Key = UmUsersS3keysFindByKeyId(ctx, userId, keyId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve given S3 key belonging to the given User

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    keyId := "keyId_example" // string | The unique access key ID of the S3 key
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersS3keysFindByKeyId(context.Background(), userId, keyId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysFindByKeyId``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersS3keysFindByKeyId`: S3Key
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersS3keysFindByKeyId`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

keyId

string

The unique access key ID of the S3 key

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersS3keysFindByKeyIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

S3Key

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersS3keysGet

var result S3Keys = UmUsersS3keysGet(ctx, userId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve a User's S3 keys

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersS3keysGet(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersS3keysGet`: S3Keys
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersS3keysGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersS3keysGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

S3Keys

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersS3keysPost

var result S3Key = UmUsersS3keysPost(ctx, userId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Create a S3 key for the given user

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersS3keysPost(context.Background(), userId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersS3keysPost`: S3Key
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersS3keysPost`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersS3keysPostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

S3Key

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

UmUsersS3keysPut

var result S3Key = UmUsersS3keysPut(ctx, userId, keyId)
                      .S3Key(s3Key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()

Modify a S3 key having the given key id

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | 
    keyId := "keyId_example" // string | The unique access key ID of the S3 key
    s3Key := *openapiclient.NewS3Key(*openapiclient.NewS3KeyProperties()) // S3Key | Modified S3 key
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersS3keysPut(context.Background(), userId, keyId).S3Key(s3Key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3keysPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersS3keysPut`: S3Key
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersS3keysPut`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

keyId

string

The unique access key ID of the S3 key

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersS3keysPutRequest struct via the builder pattern

Name
Type
Description
Notes

s3Key

Modified S3 key

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

S3Key

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

UmUsersS3ssourlGet

var result S3ObjectStorageSSO = UmUsersS3ssourlGet(ctx, userId)
                      .Pretty(pretty)
                      .XContractNumber(xContractNumber)
                      .Execute()

Retrieve S3 object storage single signon URL for the given user

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "userId_example" // string | The unique ID of the user
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.UserManagementApi.UmUsersS3ssourlGet(context.Background(), userId).Pretty(pretty).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `UserManagementApi.UmUsersS3ssourlGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UmUsersS3ssourlGet`: S3ObjectStorageSSO
    fmt.Fprintf(os.Stdout, "Response from `UserManagementApi.UmUsersS3ssourlGet`: %v\n", resp)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

userId

string

The unique ID of the user

Other Parameters

Other parameters are passed through a pointer to a apiUmUsersS3ssourlGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

Return type

S3ObjectStorageSSO

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

LabelApi

All URIs are relative to https://api.ionos.com/cloudapi/v5

Method
HTTP request
Description

DatacentersLabelsDelete

Delete a Label from Data Center

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLabelsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLabelsFindByKey

Retrieve a Label of Data Center

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLabelsFindByKeyRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLabelsGet

List all Data Center Labels

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLabelsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersLabelsPost

Add a Label to Data Center

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLabelsPostRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersLabelsPut

Modify a Label of Data Center

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersLabelsPutRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersLabelsDelete

Delete a Label from Server

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersLabelsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersLabelsFindByKey

Retrieve a Label of Server

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersLabelsFindByKeyRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersLabelsGet

List all Server Labels

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersLabelsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersServersLabelsPost

Add a Label to Server

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersLabelsPostRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersServersLabelsPut

Modify a Label of Server

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersServersLabelsPutRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersVolumesLabelsDelete

Delete a Label from Volume

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesLabelsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersVolumesLabelsFindByKey

Retrieve a Label of Volume

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesLabelsFindByKeyRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersVolumesLabelsGet

List all Volume Labels

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesLabelsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

DatacentersVolumesLabelsPost

Add a Label to Volume

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesLabelsPostRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

DatacentersVolumesLabelsPut

Modify a Label of Volume

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiDatacentersVolumesLabelsPutRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

IpblocksLabelsDelete

Delete a Label from IP Block

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksLabelsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

IpblocksLabelsFindByKey

Retrieve a Label of IP Block

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksLabelsFindByKeyRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

IpblocksLabelsGet

List all Ip Block Labels

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksLabelsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

IpblocksLabelsPost

Add a Label to IP Block

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksLabelsPostRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

IpblocksLabelsPut

Modify a Label of IP Block

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiIpblocksLabelsPutRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

LabelsFindByUrn

Returns the label by its URN.

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiLabelsFindByUrnRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

LabelsGet

List Labels

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiLabelsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

SnapshotsLabelsDelete

Delete a Label from Snapshot

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsLabelsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

map[string]interface{}

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

SnapshotsLabelsFindByKey

Retrieve a Label of Snapshot

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsLabelsFindByKeyRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

SnapshotsLabelsGet

List all Snapshot Labels

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsLabelsGetRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

SnapshotsLabelsPost

Add a Label to Snapshot

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsLabelsPostRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

SnapshotsLabelsPut

Modify a Label of Snapshot

Example

Path Parameters

Name
Type
Description
Notes

Other Parameters

Other parameters are passed through a pointer to a apiSnapshotsLabelsPutRequest struct via the builder pattern

Name
Type
Description
Notes

Return type

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

UmGroupsDelete
UmGroupsFindById
UmGroupsGet
UmGroupsPost
UmGroupsPut
UmGroupsResourcesGet
UmGroupsSharesDelete
UmGroupsSharesFindByResourceId
UmGroupsSharesGet
UmGroupsSharesPost
UmGroupsSharesPut
UmGroupsUsersDelete
UmGroupsUsersGet
UmGroupsUsersPost
UmResourcesFindByType
UmResourcesFindByTypeAndId
UmResourcesGet
UmUsersDelete
UmUsersFindById
UmUsersGet
UmUsersGroupsGet
UmUsersOwnsGet
UmUsersPost
UmUsersPut
UmUsersS3keysDelete
UmUsersS3keysFindByKeyId
UmUsersS3keysGet
UmUsersS3keysPost
UmUsersS3keysPut
UmUsersS3ssourlGet
Group
Group
GroupShare
GroupShare
User
UserPost
UserPut
S3Key

DatacentersLabelsDelete

Delete /datacenters/{datacenterId}/labels/{key}

Delete a Label from Data Center

DatacentersLabelsFindByKey

Get /datacenters/{datacenterId}/labels/{key}

Retrieve a Label of Data Center

DatacentersLabelsGet

Get /datacenters/{datacenterId}/labels

List all Data Center Labels

DatacentersLabelsPost

Post /datacenters/{datacenterId}/labels

Add a Label to Data Center

DatacentersLabelsPut

Put /datacenters/{datacenterId}/labels/{key}

Modify a Label of Data Center

DatacentersServersLabelsDelete

Delete /datacenters/{datacenterId}/servers/{serverId}/labels/{key}

Delete a Label from Server

DatacentersServersLabelsFindByKey

Get /datacenters/{datacenterId}/servers/{serverId}/labels/{key}

Retrieve a Label of Server

DatacentersServersLabelsGet

Get /datacenters/{datacenterId}/servers/{serverId}/labels

List all Server Labels

DatacentersServersLabelsPost

Post /datacenters/{datacenterId}/servers/{serverId}/labels

Add a Label to Server

DatacentersServersLabelsPut

Put /datacenters/{datacenterId}/servers/{serverId}/labels/{key}

Modify a Label of Server

DatacentersVolumesLabelsDelete

Delete /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}

Delete a Label from Volume

DatacentersVolumesLabelsFindByKey

Get /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}

Retrieve a Label of Volume

DatacentersVolumesLabelsGet

Get /datacenters/{datacenterId}/volumes/{volumeId}/labels

List all Volume Labels

DatacentersVolumesLabelsPost

Post /datacenters/{datacenterId}/volumes/{volumeId}/labels

Add a Label to Volume

DatacentersVolumesLabelsPut

Put /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}

Modify a Label of Volume

IpblocksLabelsDelete

Delete /ipblocks/{ipblockId}/labels/{key}

Delete a Label from IP Block

IpblocksLabelsFindByKey

Get /ipblocks/{ipblockId}/labels/{key}

Retrieve a Label of IP Block

IpblocksLabelsGet

Get /ipblocks/{ipblockId}/labels

List all Ip Block Labels

IpblocksLabelsPost

Post /ipblocks/{ipblockId}/labels

Add a Label to IP Block

IpblocksLabelsPut

Put /ipblocks/{ipblockId}/labels/{key}

Modify a Label of IP Block

LabelsFindByUrn

Get /labels/{labelurn}

Returns the label by its URN.

LabelsGet

Get /labels

List Labels

SnapshotsLabelsDelete

Delete /snapshots/{snapshotId}/labels/{key}

Delete a Label from Snapshot

SnapshotsLabelsFindByKey

Get /snapshots/{snapshotId}/labels/{key}

Retrieve a Label of Snapshot

SnapshotsLabelsGet

Get /snapshots/{snapshotId}/labels

List all Snapshot Labels

SnapshotsLabelsPost

Post /snapshots/{snapshotId}/labels

Add a Label to Snapshot

SnapshotsLabelsPut

Put /snapshots/{snapshotId}/labels/{key}

Modify a Label of Snapshot

var result map[string]interface{} = DatacentersLabelsDelete(ctx, datacenterId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Data Center
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersLabelsDelete(context.Background(), datacenterId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersLabelsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLabelsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersLabelsDelete`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Data Center

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = DatacentersLabelsFindByKey(ctx, datacenterId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Data Center
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersLabelsFindByKey(context.Background(), datacenterId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersLabelsFindByKey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLabelsFindByKey`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersLabelsFindByKey`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Data Center

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResources = DatacentersLabelsGet(ctx, datacenterId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Data Center
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersLabelsGet(context.Background(), datacenterId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersLabelsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLabelsGet`: LabelResources
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersLabelsGet`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Data Center

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

var result LabelResource = DatacentersLabelsPost(ctx, datacenterId)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Data Center
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Label to be added
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersLabelsPost(context.Background(), datacenterId).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersLabelsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLabelsPost`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersLabelsPost`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Data Center

label

LabelResource

Label to be added

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = DatacentersLabelsPut(ctx, datacenterId, key)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Data Center
    key := "key_example" // string | The key of the Label
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Modified Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersLabelsPut(context.Background(), datacenterId, key).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersLabelsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersLabelsPut`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersLabelsPut`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Data Center

key

string

The key of the Label

label

LabelResource

Modified Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result map[string]interface{} = DatacentersServersLabelsDelete(ctx, datacenterId, serverId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersServersLabelsDelete(context.Background(), datacenterId, serverId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersServersLabelsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersLabelsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersServersLabelsDelete`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = DatacentersServersLabelsFindByKey(ctx, datacenterId, serverId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersServersLabelsFindByKey(context.Background(), datacenterId, serverId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersServersLabelsFindByKey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersLabelsFindByKey`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersServersLabelsFindByKey`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResources = DatacentersServersLabelsGet(ctx, datacenterId, serverId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersServersLabelsGet(context.Background(), datacenterId, serverId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersServersLabelsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersLabelsGet`: LabelResources
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersServersLabelsGet`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

var result LabelResource = DatacentersServersLabelsPost(ctx, datacenterId, serverId)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Label to be added
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersServersLabelsPost(context.Background(), datacenterId, serverId).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersServersLabelsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersLabelsPost`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersServersLabelsPost`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

label

LabelResource

Label to be added

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = DatacentersServersLabelsPut(ctx, datacenterId, serverId, key)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    serverId := "serverId_example" // string | The unique ID of the Server
    key := "key_example" // string | The key of the Label
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Modified Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersServersLabelsPut(context.Background(), datacenterId, serverId, key).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersServersLabelsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersServersLabelsPut`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersServersLabelsPut`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

serverId

string

The unique ID of the Server

key

string

The key of the Label

label

LabelResource

Modified Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result map[string]interface{} = DatacentersVolumesLabelsDelete(ctx, datacenterId, volumeId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersVolumesLabelsDelete(context.Background(), datacenterId, volumeId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersVolumesLabelsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesLabelsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersVolumesLabelsDelete`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

volumeId

string

The unique ID of the Volume

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = DatacentersVolumesLabelsFindByKey(ctx, datacenterId, volumeId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersVolumesLabelsFindByKey(context.Background(), datacenterId, volumeId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersVolumesLabelsFindByKey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesLabelsFindByKey`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersVolumesLabelsFindByKey`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

volumeId

string

The unique ID of the Volume

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResources = DatacentersVolumesLabelsGet(ctx, datacenterId, volumeId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Offset(offset)
                      .Limit(limit)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
    offset := int32(56) // int32 | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) (optional) (default to 0)
    limit := int32(56) // int32 | the maximum number of elements to return (use together with <code>offset</code> for pagination) (optional) (default to 1000)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersVolumesLabelsGet(context.Background(), datacenterId, volumeId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Offset(offset).Limit(limit).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersVolumesLabelsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesLabelsGet`: LabelResources
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersVolumesLabelsGet`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

volumeId

string

The unique ID of the Volume

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

offset

int32

the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)

[default to 0]

limit

int32

the maximum number of elements to return (use together with <code>offset</code> for pagination)

[default to 1000]

var result LabelResource = DatacentersVolumesLabelsPost(ctx, datacenterId, volumeId)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Label to be added
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersVolumesLabelsPost(context.Background(), datacenterId, volumeId).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersVolumesLabelsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesLabelsPost`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersVolumesLabelsPost`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

volumeId

string

The unique ID of the Volume

label

LabelResource

Label to be added

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = DatacentersVolumesLabelsPut(ctx, datacenterId, volumeId, key)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    datacenterId := "datacenterId_example" // string | The unique ID of the Datacenter
    volumeId := "volumeId_example" // string | The unique ID of the Volume
    key := "key_example" // string | The key of the Label
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Modified Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.DatacentersVolumesLabelsPut(context.Background(), datacenterId, volumeId, key).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.DatacentersVolumesLabelsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DatacentersVolumesLabelsPut`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.DatacentersVolumesLabelsPut`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

datacenterId

string

The unique ID of the Datacenter

volumeId

string

The unique ID of the Volume

key

string

The key of the Label

label

LabelResource

Modified Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result map[string]interface{} = IpblocksLabelsDelete(ctx, ipblockId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | The unique ID of the Ip Block
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.IpblocksLabelsDelete(context.Background(), ipblockId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.IpblocksLabelsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksLabelsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.IpblocksLabelsDelete`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

The unique ID of the Ip Block

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = IpblocksLabelsFindByKey(ctx, ipblockId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | The unique ID of the Ip Block
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.IpblocksLabelsFindByKey(context.Background(), ipblockId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.IpblocksLabelsFindByKey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksLabelsFindByKey`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.IpblocksLabelsFindByKey`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

The unique ID of the Ip Block

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResources = IpblocksLabelsGet(ctx, ipblockId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | The unique ID of the Ip Block
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.IpblocksLabelsGet(context.Background(), ipblockId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.IpblocksLabelsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksLabelsGet`: LabelResources
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.IpblocksLabelsGet`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

The unique ID of the Ip Block

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = IpblocksLabelsPost(ctx, ipblockId)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | The unique ID of the Ip Block
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Label to be added
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.IpblocksLabelsPost(context.Background(), ipblockId).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.IpblocksLabelsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksLabelsPost`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.IpblocksLabelsPost`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

The unique ID of the Ip Block

label

LabelResource

Label to be added

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = IpblocksLabelsPut(ctx, ipblockId, key)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ipblockId := "ipblockId_example" // string | The unique ID of the Ip Block
    key := "key_example" // string | The key of the Label
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Modified Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.IpblocksLabelsPut(context.Background(), ipblockId, key).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.IpblocksLabelsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IpblocksLabelsPut`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.IpblocksLabelsPut`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

ipblockId

string

The unique ID of the Ip Block

key

string

The key of the Label

label

LabelResource

Modified Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result Label = LabelsFindByUrn(ctx, labelurn)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    labelurn := "labelurn_example" // string | The URN representing the unique ID of the label. A URN is for uniqueness of a Label and composed using urn:label:<resource_type>:<resource_uuid>:<key>
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.LabelsFindByUrn(context.Background(), labelurn).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.LabelsFindByUrn``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LabelsFindByUrn`: Label
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.LabelsFindByUrn`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

labelurn

string

The URN representing the unique ID of the label. A URN is for uniqueness of a Label and composed using urn🏷️<resource_type>:<resource_uuid>:<key>

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result Labels = LabelsGet(ctx)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.LabelsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.LabelsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `LabelsGet`: Labels
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.LabelsGet`: %v\n", resp)
}

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result map[string]interface{} = SnapshotsLabelsDelete(ctx, snapshotId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.SnapshotsLabelsDelete(context.Background(), snapshotId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.SnapshotsLabelsDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsLabelsDelete`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.SnapshotsLabelsDelete`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = SnapshotsLabelsFindByKey(ctx, snapshotId, key)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    key := "key_example" // string | The key of the Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.SnapshotsLabelsFindByKey(context.Background(), snapshotId, key).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.SnapshotsLabelsFindByKey``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsLabelsFindByKey`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.SnapshotsLabelsFindByKey`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

key

string

The key of the Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResources = SnapshotsLabelsGet(ctx, snapshotId)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.SnapshotsLabelsGet(context.Background(), snapshotId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.SnapshotsLabelsGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsLabelsGet`: LabelResources
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.SnapshotsLabelsGet`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = SnapshotsLabelsPost(ctx, snapshotId)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Label to be added
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.SnapshotsLabelsPost(context.Background(), snapshotId).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.SnapshotsLabelsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsLabelsPost`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.SnapshotsLabelsPost`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

label

LabelResource

Label to be added

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

var result LabelResource = SnapshotsLabelsPut(ctx, snapshotId, key)
                      .Label(label)
                      .Pretty(pretty)
                      .Depth(depth)
                      .XContractNumber(xContractNumber)
                      .Execute()
package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    snapshotId := "snapshotId_example" // string | The unique ID of the Snapshot
    key := "key_example" // string | The key of the Label
    label := *openapiclient.NewLabelResource(*openapiclient.NewLabelResourceProperties()) // LabelResource | Modified Label
    pretty := true // bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to true)
    depth := int32(56) // int32 | Controls the details depth of response objects.  Eg. GET /datacenters/[ID]  - depth=0: only direct properties are included. Children (servers etc.) are not included  - depth=1: direct properties and children references are included  - depth=2: direct properties and children properties are included  - depth=3: direct properties and children properties and children's children are included  - depth=... and so on (optional) (default to 0)
    xContractNumber := int32(56) // int32 | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LabelApi.SnapshotsLabelsPut(context.Background(), snapshotId, key).Label(label).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LabelApi.SnapshotsLabelsPut``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SnapshotsLabelsPut`: LabelResource
    fmt.Fprintf(os.Stdout, "Response from `LabelApi.SnapshotsLabelsPut`: %v\n", resp)
}

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

snapshotId

string

The unique ID of the Snapshot

key

string

The key of the Label

label

LabelResource

Modified Label

pretty

bool

Controls whether response is pretty-printed (with indentation and new lines)

[default to true]

depth

int32

Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on

[default to 0]

xContractNumber

int32

Users having more than 1 contract need to provide contract number, against which all API requests should be executed

LabelResource
LabelResources
LabelResource
LabelResource
LabelResource
LabelResources
LabelResource
LabelResource
LabelResource
LabelResources
LabelResource
LabelResource
LabelResource
LabelResources
LabelResource
LabelResource
Label
Labels
LabelResource
LabelResources
LabelResource
LabelResource