ionoscloud 5.0.0 → 5.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (174) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AttachedVolumes.md +30 -0
  3. data/docs/BackupUnit.md +26 -0
  4. data/docs/BackupUnitApi.md +595 -0
  5. data/docs/BackupUnitProperties.md +22 -0
  6. data/docs/BackupUnitSSO.md +18 -0
  7. data/docs/BackupUnits.md +24 -0
  8. data/docs/BalancedNics.md +30 -0
  9. data/docs/CHANGELOG.md +1 -0
  10. data/docs/Cdroms.md +30 -0
  11. data/docs/ConnectableDatacenter.md +22 -0
  12. data/docs/Contract.md +20 -0
  13. data/docs/ContractApi.md +89 -0
  14. data/docs/ContractProperties.md +26 -0
  15. data/docs/DataCenterApi.md +517 -0
  16. data/docs/DataCenterEntities.md +24 -0
  17. data/docs/Datacenter.md +28 -0
  18. data/docs/DatacenterElementMetadata.md +32 -0
  19. data/docs/DatacenterProperties.md +28 -0
  20. data/docs/Datacenters.md +30 -0
  21. data/docs/DefaultApi.md +84 -0
  22. data/docs/Error.md +20 -0
  23. data/docs/ErrorMessage.md +20 -0
  24. data/docs/FirewallRule.md +26 -0
  25. data/docs/FirewallRules.md +30 -0
  26. data/docs/FirewallruleProperties.md +34 -0
  27. data/docs/Group.md +26 -0
  28. data/docs/GroupEntities.md +20 -0
  29. data/docs/GroupMembers.md +24 -0
  30. data/docs/GroupProperties.md +36 -0
  31. data/docs/GroupShare.md +24 -0
  32. data/docs/GroupShareProperties.md +20 -0
  33. data/docs/GroupShares.md +24 -0
  34. data/docs/GroupUsers.md +24 -0
  35. data/docs/Groups.md +24 -0
  36. data/docs/IPBlocksApi.md +513 -0
  37. data/docs/IPFailover.md +20 -0
  38. data/docs/Image.md +26 -0
  39. data/docs/ImageApi.md +429 -0
  40. data/docs/ImageProperties.md +50 -0
  41. data/docs/Images.md +24 -0
  42. data/docs/Info.md +22 -0
  43. data/docs/IpBlock.md +26 -0
  44. data/docs/IpBlockProperties.md +26 -0
  45. data/docs/IpBlocks.md +24 -0
  46. data/docs/IpConsumer.md +30 -0
  47. data/docs/KubernetesApi.md +1513 -0
  48. data/docs/KubernetesAutoScaling.md +20 -0
  49. data/docs/KubernetesCluster.md +28 -0
  50. data/docs/KubernetesClusterEntities.md +18 -0
  51. data/docs/KubernetesClusterProperties.md +26 -0
  52. data/docs/KubernetesClusterPropertiesForPostAndPut.md +22 -0
  53. data/docs/KubernetesClusters.md +24 -0
  54. data/docs/KubernetesConfig.md +24 -0
  55. data/docs/KubernetesConfigProperties.md +18 -0
  56. data/docs/KubernetesMaintenanceWindow.md +20 -0
  57. data/docs/KubernetesNode.md +26 -0
  58. data/docs/KubernetesNodeMetadata.md +26 -0
  59. data/docs/KubernetesNodePool.md +26 -0
  60. data/docs/KubernetesNodePoolForPut.md +26 -0
  61. data/docs/KubernetesNodePoolLan.md +18 -0
  62. data/docs/KubernetesNodePoolProperties.md +50 -0
  63. data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
  64. data/docs/KubernetesNodePoolPropertiesForPut.md +48 -0
  65. data/docs/KubernetesNodePools.md +24 -0
  66. data/docs/KubernetesNodeProperties.md +22 -0
  67. data/docs/KubernetesNodes.md +24 -0
  68. data/docs/Label.md +26 -0
  69. data/docs/LabelApi.md +2355 -0
  70. data/docs/LabelProperties.md +26 -0
  71. data/docs/LabelResource.md +26 -0
  72. data/docs/LabelResourceProperties.md +20 -0
  73. data/docs/LabelResources.md +30 -0
  74. data/docs/Labels.md +24 -0
  75. data/docs/Lan.md +28 -0
  76. data/docs/LanApi.md +795 -0
  77. data/docs/LanEntities.md +18 -0
  78. data/docs/LanNics.md +30 -0
  79. data/docs/LanPost.md +28 -0
  80. data/docs/LanProperties.md +24 -0
  81. data/docs/LanPropertiesPost.md +24 -0
  82. data/docs/Lans.md +30 -0
  83. data/docs/LoadBalancerApi.md +883 -0
  84. data/docs/Loadbalancer.md +28 -0
  85. data/docs/LoadbalancerEntities.md +18 -0
  86. data/docs/LoadbalancerProperties.md +22 -0
  87. data/docs/Loadbalancers.md +30 -0
  88. data/docs/Location.md +26 -0
  89. data/docs/LocationApi.md +259 -0
  90. data/docs/LocationProperties.md +22 -0
  91. data/docs/Locations.md +24 -0
  92. data/docs/Nic.md +28 -0
  93. data/docs/NicApi.md +1087 -0
  94. data/docs/NicEntities.md +18 -0
  95. data/docs/NicProperties.md +30 -0
  96. data/docs/Nics.md +30 -0
  97. data/docs/NoStateMetaData.md +30 -0
  98. data/docs/PaginationLinks.md +22 -0
  99. data/docs/Peer.md +26 -0
  100. data/docs/PrivateCrossConnect.md +26 -0
  101. data/docs/PrivateCrossConnectApi.md +427 -0
  102. data/docs/PrivateCrossConnectProperties.md +24 -0
  103. data/docs/PrivateCrossConnects.md +24 -0
  104. data/docs/README.md +111 -0
  105. data/docs/Request.md +26 -0
  106. data/docs/RequestApi.md +267 -0
  107. data/docs/RequestMetadata.md +24 -0
  108. data/docs/RequestProperties.md +24 -0
  109. data/docs/RequestStatus.md +24 -0
  110. data/docs/RequestStatusMetadata.md +24 -0
  111. data/docs/RequestTarget.md +20 -0
  112. data/docs/Requests.md +30 -0
  113. data/docs/Resource.md +28 -0
  114. data/docs/ResourceEntities.md +18 -0
  115. data/docs/ResourceGroups.md +24 -0
  116. data/docs/ResourceLimits.md +50 -0
  117. data/docs/ResourceProperties.md +20 -0
  118. data/docs/ResourceReference.md +22 -0
  119. data/docs/Resources.md +24 -0
  120. data/docs/ResourcesUsers.md +24 -0
  121. data/docs/S3Key.md +26 -0
  122. data/docs/S3KeyMetadata.md +20 -0
  123. data/docs/S3KeyProperties.md +20 -0
  124. data/docs/S3Keys.md +24 -0
  125. data/docs/S3ObjectStorageSSO.md +18 -0
  126. data/docs/Server.md +28 -0
  127. data/docs/ServerApi.md +1573 -0
  128. data/docs/ServerEntities.md +22 -0
  129. data/docs/ServerProperties.md +32 -0
  130. data/docs/Servers.md +30 -0
  131. data/docs/Snapshot.md +26 -0
  132. data/docs/SnapshotApi.md +429 -0
  133. data/docs/SnapshotProperties.md +48 -0
  134. data/docs/Snapshots.md +24 -0
  135. data/docs/Type.md +15 -0
  136. data/docs/User.md +28 -0
  137. data/docs/UserManagementApi.md +2547 -0
  138. data/docs/UserMetadata.md +22 -0
  139. data/docs/UserProperties.md +34 -0
  140. data/docs/Users.md +24 -0
  141. data/docs/UsersEntities.md +20 -0
  142. data/docs/Volume.md +26 -0
  143. data/docs/VolumeApi.md +711 -0
  144. data/docs/VolumeProperties.md +54 -0
  145. data/docs/Volumes.md +30 -0
  146. data/docs/summary.md +295 -0
  147. data/gitbook.yaml +4 -0
  148. data/lib/ionoscloud/api/_api.rb +1 -1
  149. data/lib/ionoscloud/api_client.rb +1 -4
  150. data/lib/ionoscloud/models/backup_units.rb +2 -2
  151. data/lib/ionoscloud/models/datacenter_element_metadata.rb +2 -2
  152. data/lib/ionoscloud/models/firewallrule_properties.rb +36 -21
  153. data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
  154. data/lib/ionoscloud/models/kubernetes_node_metadata.rb +2 -2
  155. data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
  156. data/lib/ionoscloud/models/label_resources.rb +2 -2
  157. data/lib/ionoscloud/models/labels.rb +2 -2
  158. data/lib/ionoscloud/models/loadbalancer_properties.rb +12 -29
  159. data/lib/ionoscloud/models/type.rb +1 -0
  160. data/lib/ionoscloud/models/volume_properties.rb +14 -4
  161. data/lib/ionoscloud/version.rb +1 -1
  162. data/spec/models/backup_units_spec.rb +1 -1
  163. data/spec/models/datacenter_element_metadata_spec.rb +1 -1
  164. data/spec/models/firewallrule_properties_spec.rb +0 -12
  165. data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
  166. data/spec/models/kubernetes_node_spec.rb +1 -1
  167. data/spec/models/kubernetes_nodes_spec.rb +1 -1
  168. data/spec/models/label_resources_spec.rb +1 -1
  169. data/spec/models/labels_spec.rb +1 -1
  170. data/spec/models/loadbalancer_properties_spec.rb +0 -4
  171. data/spec/models/volume_properties_spec.rb +6 -0
  172. metadata +264 -120
  173. data/DOCS.md +0 -14618
  174. data/README.md +0 -55
@@ -0,0 +1,48 @@
1
+ # KubernetesNodePoolPropertiesForPut
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **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. | |
8
+ | **datacenter_id** | **String** | A valid uuid of the datacenter on which user has access | |
9
+ | **node_count** | **Integer** | Number of nodes part of the Node Pool | |
10
+ | **cpu_family** | **String** | A valid cpu family name | |
11
+ | **cores_count** | **Integer** | Number of cores for node | |
12
+ | **ram_size** | **Integer** | RAM size for node, minimum size 2048MB is recommended. Ram size must be set to multiple of 1024MB. | |
13
+ | **availability_zone** | **String** | The availability zone in which the target VM should exist | |
14
+ | **storage_type** | **String** | Hardware type of the volume | |
15
+ | **storage_size** | **Integer** | The size of the volume in GB. The size should be greater than 10GB. | |
16
+ | **k8s_version** | **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] |
17
+ | **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) | | [optional] |
18
+ | **auto_scaling** | [**KubernetesAutoScaling**](KubernetesAutoScaling.md) | | [optional] |
19
+ | **lans** | [**Array<KubernetesNodePoolLan>**](KubernetesNodePoolLan.md) | array of additional LANs attached to worker nodes | [optional] |
20
+ | **labels** | **Hash<String, String>** | map of labels attached to node pool | [optional] |
21
+ | **annotations** | **Hash<String, String>** | map of annotations attached to node pool | [optional] |
22
+ | **public_ips** | **Array<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] |
23
+
24
+ ## Example
25
+
26
+ ```ruby
27
+ require 'ionoscloud'
28
+
29
+ instance = Ionoscloud::KubernetesNodePoolPropertiesForPut.new(
30
+ name: k8s-node-pool,
31
+ datacenter_id: 1e072e52-2ed3-492f-b6b6-c6b116907521,
32
+ node_count: 2,
33
+ cpu_family: AMD_OPTERON,
34
+ cores_count: 4,
35
+ ram_size: 2048,
36
+ availability_zone: AUTO,
37
+ storage_type: HDD,
38
+ storage_size: 100,
39
+ k8s_version: 1.15.4,
40
+ maintenance_window: null,
41
+ auto_scaling: null,
42
+ lans: null,
43
+ labels: null,
44
+ annotations: null,
45
+ public_ips: [81.173.1.2, 82.231.2.5, 92.221.2.4]
46
+ )
47
+ ```
48
+
@@ -0,0 +1,24 @@
1
+ # KubernetesNodePools
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique representation for Kubernetes Node Pool as a collection on a resource. | [optional][readonly] |
8
+ | **type** | **String** | The type of object that has been created | [optional][readonly] |
9
+ | **href** | **String** | URL to the collection representation (absolute path) | [optional][readonly] |
10
+ | **items** | [**Array<KubernetesNodePool>**](KubernetesNodePool.md) | Array of items in that collection | [optional][readonly] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ionoscloud'
16
+
17
+ instance = Ionoscloud::KubernetesNodePools.new(
18
+ id: 1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools,
19
+ type: collection,
20
+ href: <RESOURCE-URI>,
21
+ items: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,22 @@
1
+ # KubernetesNodeProperties
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | A Kubernetes Node Name. | |
8
+ | **public_ip** | **String** | A valid public IP. | |
9
+ | **k8s_version** | **String** | The kubernetes version in which a nodepool is running. This imposes restrictions on what kubernetes versions can be run in a cluster&#39;s nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ionoscloud'
15
+
16
+ instance = Ionoscloud::KubernetesNodeProperties.new(
17
+ name: k8s-node,
18
+ public_ip: 192.168.23.2,
19
+ k8s_version: 1.15.4
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # KubernetesNodes
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique representation for Kubernetes Node Pool as a collection on a resource. | [optional][readonly] |
8
+ | **type** | **String** | The type of resource within a collection | [optional][readonly] |
9
+ | **href** | **String** | URL to the collection representation (absolute path) | [optional][readonly] |
10
+ | **items** | [**Array&lt;KubernetesNode&gt;**](KubernetesNode.md) | Array of items in that collection | [optional][readonly] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ionoscloud'
16
+
17
+ instance = Ionoscloud::KubernetesNodes.new(
18
+ id: 1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools,
19
+ type: collection,
20
+ href: <RESOURCE-URI>,
21
+ items: null
22
+ )
23
+ ```
24
+
data/docs/Label.md ADDED
@@ -0,0 +1,26 @@
1
+ # Label
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Label is identified using standard URN. | [optional][readonly] |
8
+ | **type** | **String** | The type of object that has been created | [optional][readonly] |
9
+ | **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
10
+ | **metadata** | [**NoStateMetaData**](NoStateMetaData.md) | | [optional] |
11
+ | **properties** | [**LabelProperties**](LabelProperties.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ionoscloud'
17
+
18
+ instance = Ionoscloud::Label.new(
19
+ id: urn:label:datacenter:700e1cab-99b2-4c30-ba8c-1d273ddba022:environment,
20
+ type: null,
21
+ href: <RESOURCE-URI>,
22
+ metadata: null,
23
+ properties: null
24
+ )
25
+ ```
26
+
data/docs/LabelApi.md ADDED
@@ -0,0 +1,2355 @@
1
+ # LabelApi
2
+
3
+ All URIs are relative to *https://api.ionos.com/cloudapi/v5*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**datacenters_labels_delete**](LabelApi.md#datacenters_labels_delete) | **DELETE** /datacenters/{datacenterId}/labels/{key} | Delete a Label from Data Center |
8
+ | [**datacenters_labels_find_by_key**](LabelApi.md#datacenters_labels_find_by_key) | **GET** /datacenters/{datacenterId}/labels/{key} | Retrieve a Label of Data Center |
9
+ | [**datacenters_labels_get**](LabelApi.md#datacenters_labels_get) | **GET** /datacenters/{datacenterId}/labels | List all Data Center Labels |
10
+ | [**datacenters_labels_post**](LabelApi.md#datacenters_labels_post) | **POST** /datacenters/{datacenterId}/labels | Add a Label to Data Center |
11
+ | [**datacenters_labels_put**](LabelApi.md#datacenters_labels_put) | **PUT** /datacenters/{datacenterId}/labels/{key} | Modify a Label of Data Center |
12
+ | [**datacenters_servers_labels_delete**](LabelApi.md#datacenters_servers_labels_delete) | **DELETE** /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Delete a Label from Server |
13
+ | [**datacenters_servers_labels_find_by_key**](LabelApi.md#datacenters_servers_labels_find_by_key) | **GET** /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Retrieve a Label of Server |
14
+ | [**datacenters_servers_labels_get**](LabelApi.md#datacenters_servers_labels_get) | **GET** /datacenters/{datacenterId}/servers/{serverId}/labels | List all Server Labels |
15
+ | [**datacenters_servers_labels_post**](LabelApi.md#datacenters_servers_labels_post) | **POST** /datacenters/{datacenterId}/servers/{serverId}/labels | Add a Label to Server |
16
+ | [**datacenters_servers_labels_put**](LabelApi.md#datacenters_servers_labels_put) | **PUT** /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Modify a Label of Server |
17
+ | [**datacenters_volumes_labels_delete**](LabelApi.md#datacenters_volumes_labels_delete) | **DELETE** /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Delete a Label from Volume |
18
+ | [**datacenters_volumes_labels_find_by_key**](LabelApi.md#datacenters_volumes_labels_find_by_key) | **GET** /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Retrieve a Label of Volume |
19
+ | [**datacenters_volumes_labels_get**](LabelApi.md#datacenters_volumes_labels_get) | **GET** /datacenters/{datacenterId}/volumes/{volumeId}/labels | List all Volume Labels |
20
+ | [**datacenters_volumes_labels_post**](LabelApi.md#datacenters_volumes_labels_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/labels | Add a Label to Volume |
21
+ | [**datacenters_volumes_labels_put**](LabelApi.md#datacenters_volumes_labels_put) | **PUT** /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Modify a Label of Volume |
22
+ | [**ipblocks_labels_delete**](LabelApi.md#ipblocks_labels_delete) | **DELETE** /ipblocks/{ipblockId}/labels/{key} | Delete a Label from IP Block |
23
+ | [**ipblocks_labels_find_by_key**](LabelApi.md#ipblocks_labels_find_by_key) | **GET** /ipblocks/{ipblockId}/labels/{key} | Retrieve a Label of IP Block |
24
+ | [**ipblocks_labels_get**](LabelApi.md#ipblocks_labels_get) | **GET** /ipblocks/{ipblockId}/labels | List all Ip Block Labels |
25
+ | [**ipblocks_labels_post**](LabelApi.md#ipblocks_labels_post) | **POST** /ipblocks/{ipblockId}/labels | Add a Label to IP Block |
26
+ | [**ipblocks_labels_put**](LabelApi.md#ipblocks_labels_put) | **PUT** /ipblocks/{ipblockId}/labels/{key} | Modify a Label of IP Block |
27
+ | [**labels_find_by_urn**](LabelApi.md#labels_find_by_urn) | **GET** /labels/{labelurn} | Returns the label by its URN. |
28
+ | [**labels_get**](LabelApi.md#labels_get) | **GET** /labels | List Labels |
29
+ | [**snapshots_labels_delete**](LabelApi.md#snapshots_labels_delete) | **DELETE** /snapshots/{snapshotId}/labels/{key} | Delete a Label from Snapshot |
30
+ | [**snapshots_labels_find_by_key**](LabelApi.md#snapshots_labels_find_by_key) | **GET** /snapshots/{snapshotId}/labels/{key} | Retrieve a Label of Snapshot |
31
+ | [**snapshots_labels_get**](LabelApi.md#snapshots_labels_get) | **GET** /snapshots/{snapshotId}/labels | List all Snapshot Labels |
32
+ | [**snapshots_labels_post**](LabelApi.md#snapshots_labels_post) | **POST** /snapshots/{snapshotId}/labels | Add a Label to Snapshot |
33
+ | [**snapshots_labels_put**](LabelApi.md#snapshots_labels_put) | **PUT** /snapshots/{snapshotId}/labels/{key} | Modify a Label of Snapshot |
34
+
35
+
36
+ ## datacenters_labels_delete
37
+
38
+ > Object datacenters_labels_delete(datacenter_id, key, opts)
39
+
40
+ Delete a Label from Data Center
41
+
42
+ This will remove a label from the data center.
43
+
44
+ ### Examples
45
+
46
+ ```ruby
47
+ require 'time'
48
+ require 'ionoscloud'
49
+ # setup authorization
50
+ Ionoscloud.configure do |config|
51
+ # Configure HTTP basic authorization: Basic Authentication
52
+ config.username = 'YOUR USERNAME'
53
+ config.password = 'YOUR PASSWORD'
54
+
55
+ # Configure API key authorization: Token Authentication
56
+ config.api_key['Authorization'] = 'YOUR API KEY'
57
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
58
+ # config.api_key_prefix['Authorization'] = 'Bearer'
59
+ end
60
+
61
+ api_instance = Ionoscloud::LabelApi.new
62
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
63
+ key = 'key_example' # String | The key of the Label
64
+ opts = {
65
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
66
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
67
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
68
+ }
69
+
70
+ begin
71
+ # Delete a Label from Data Center
72
+ result = api_instance.datacenters_labels_delete(datacenter_id, key, opts)
73
+ p result
74
+ rescue Ionoscloud::ApiError => e
75
+ puts "Error when calling LabelApi->datacenters_labels_delete: #{e}"
76
+ end
77
+ ```
78
+
79
+ #### Using the datacenters_labels_delete_with_http_info variant
80
+
81
+ This returns an Array which contains the response data, status code and headers.
82
+
83
+ > <Array(Object, Integer, Hash)> datacenters_labels_delete_with_http_info(datacenter_id, key, opts)
84
+
85
+ ```ruby
86
+ begin
87
+ # Delete a Label from Data Center
88
+ data, status_code, headers = api_instance.datacenters_labels_delete_with_http_info(datacenter_id, key, opts)
89
+ p status_code # => 2xx
90
+ p headers # => { ... }
91
+ p data # => Object
92
+ rescue Ionoscloud::ApiError => e
93
+ puts "Error when calling LabelApi->datacenters_labels_delete_with_http_info: #{e}"
94
+ end
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+ | Name | Type | Description | Notes |
100
+ | ---- | ---- | ----------- | ----- |
101
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
102
+ | **key** | **String** | The key of the Label | |
103
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
104
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
105
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
106
+
107
+ ### Return type
108
+
109
+ **Object**
110
+
111
+ ### Authorization
112
+
113
+ Basic Authentication, Token Authentication
114
+
115
+ ### HTTP request headers
116
+
117
+ - **Content-Type**: Not defined
118
+ - **Accept**: application/json
119
+
120
+
121
+ ## datacenters_labels_find_by_key
122
+
123
+ > <LabelResource> datacenters_labels_find_by_key(datacenter_id, key, opts)
124
+
125
+ Retrieve a Label of Data Center
126
+
127
+ This will retrieve the properties of a associated label to a data center.
128
+
129
+ ### Examples
130
+
131
+ ```ruby
132
+ require 'time'
133
+ require 'ionoscloud'
134
+ # setup authorization
135
+ Ionoscloud.configure do |config|
136
+ # Configure HTTP basic authorization: Basic Authentication
137
+ config.username = 'YOUR USERNAME'
138
+ config.password = 'YOUR PASSWORD'
139
+
140
+ # Configure API key authorization: Token Authentication
141
+ config.api_key['Authorization'] = 'YOUR API KEY'
142
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
143
+ # config.api_key_prefix['Authorization'] = 'Bearer'
144
+ end
145
+
146
+ api_instance = Ionoscloud::LabelApi.new
147
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
148
+ key = 'key_example' # String | The key of the Label
149
+ opts = {
150
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
151
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
152
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
153
+ }
154
+
155
+ begin
156
+ # Retrieve a Label of Data Center
157
+ result = api_instance.datacenters_labels_find_by_key(datacenter_id, key, opts)
158
+ p result
159
+ rescue Ionoscloud::ApiError => e
160
+ puts "Error when calling LabelApi->datacenters_labels_find_by_key: #{e}"
161
+ end
162
+ ```
163
+
164
+ #### Using the datacenters_labels_find_by_key_with_http_info variant
165
+
166
+ This returns an Array which contains the response data, status code and headers.
167
+
168
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_labels_find_by_key_with_http_info(datacenter_id, key, opts)
169
+
170
+ ```ruby
171
+ begin
172
+ # Retrieve a Label of Data Center
173
+ data, status_code, headers = api_instance.datacenters_labels_find_by_key_with_http_info(datacenter_id, key, opts)
174
+ p status_code # => 2xx
175
+ p headers # => { ... }
176
+ p data # => <LabelResource>
177
+ rescue Ionoscloud::ApiError => e
178
+ puts "Error when calling LabelApi->datacenters_labels_find_by_key_with_http_info: #{e}"
179
+ end
180
+ ```
181
+
182
+ ### Parameters
183
+
184
+ | Name | Type | Description | Notes |
185
+ | ---- | ---- | ----------- | ----- |
186
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
187
+ | **key** | **String** | The key of the Label | |
188
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
189
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
190
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
191
+
192
+ ### Return type
193
+
194
+ [**LabelResource**](LabelResource.md)
195
+
196
+ ### Authorization
197
+
198
+ Basic Authentication, Token Authentication
199
+
200
+ ### HTTP request headers
201
+
202
+ - **Content-Type**: Not defined
203
+ - **Accept**: application/json
204
+
205
+
206
+ ## datacenters_labels_get
207
+
208
+ > <LabelResources> datacenters_labels_get(datacenter_id, opts)
209
+
210
+ List all Data Center Labels
211
+
212
+ You can retrieve a list of all labels associated with a data center
213
+
214
+ ### Examples
215
+
216
+ ```ruby
217
+ require 'time'
218
+ require 'ionoscloud'
219
+ # setup authorization
220
+ Ionoscloud.configure do |config|
221
+ # Configure HTTP basic authorization: Basic Authentication
222
+ config.username = 'YOUR USERNAME'
223
+ config.password = 'YOUR PASSWORD'
224
+
225
+ # Configure API key authorization: Token Authentication
226
+ config.api_key['Authorization'] = 'YOUR API KEY'
227
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
228
+ # config.api_key_prefix['Authorization'] = 'Bearer'
229
+ end
230
+
231
+ api_instance = Ionoscloud::LabelApi.new
232
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
233
+ opts = {
234
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
235
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
236
+ x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
237
+ offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
238
+ limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
239
+ }
240
+
241
+ begin
242
+ # List all Data Center Labels
243
+ result = api_instance.datacenters_labels_get(datacenter_id, opts)
244
+ p result
245
+ rescue Ionoscloud::ApiError => e
246
+ puts "Error when calling LabelApi->datacenters_labels_get: #{e}"
247
+ end
248
+ ```
249
+
250
+ #### Using the datacenters_labels_get_with_http_info variant
251
+
252
+ This returns an Array which contains the response data, status code and headers.
253
+
254
+ > <Array(<LabelResources>, Integer, Hash)> datacenters_labels_get_with_http_info(datacenter_id, opts)
255
+
256
+ ```ruby
257
+ begin
258
+ # List all Data Center Labels
259
+ data, status_code, headers = api_instance.datacenters_labels_get_with_http_info(datacenter_id, opts)
260
+ p status_code # => 2xx
261
+ p headers # => { ... }
262
+ p data # => <LabelResources>
263
+ rescue Ionoscloud::ApiError => e
264
+ puts "Error when calling LabelApi->datacenters_labels_get_with_http_info: #{e}"
265
+ end
266
+ ```
267
+
268
+ ### Parameters
269
+
270
+ | Name | Type | Description | Notes |
271
+ | ---- | ---- | ----------- | ----- |
272
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
273
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
274
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
275
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
276
+ | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
277
+ | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 1000] |
278
+
279
+ ### Return type
280
+
281
+ [**LabelResources**](LabelResources.md)
282
+
283
+ ### Authorization
284
+
285
+ Basic Authentication, Token Authentication
286
+
287
+ ### HTTP request headers
288
+
289
+ - **Content-Type**: Not defined
290
+ - **Accept**: application/json
291
+
292
+
293
+ ## datacenters_labels_post
294
+
295
+ > <LabelResource> datacenters_labels_post(datacenter_id, label, opts)
296
+
297
+ Add a Label to Data Center
298
+
299
+ This will add a label to the data center.
300
+
301
+ ### Examples
302
+
303
+ ```ruby
304
+ require 'time'
305
+ require 'ionoscloud'
306
+ # setup authorization
307
+ Ionoscloud.configure do |config|
308
+ # Configure HTTP basic authorization: Basic Authentication
309
+ config.username = 'YOUR USERNAME'
310
+ config.password = 'YOUR PASSWORD'
311
+
312
+ # Configure API key authorization: Token Authentication
313
+ config.api_key['Authorization'] = 'YOUR API KEY'
314
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
315
+ # config.api_key_prefix['Authorization'] = 'Bearer'
316
+ end
317
+
318
+ api_instance = Ionoscloud::LabelApi.new
319
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
320
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
321
+ opts = {
322
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
323
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
324
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
325
+ }
326
+
327
+ begin
328
+ # Add a Label to Data Center
329
+ result = api_instance.datacenters_labels_post(datacenter_id, label, opts)
330
+ p result
331
+ rescue Ionoscloud::ApiError => e
332
+ puts "Error when calling LabelApi->datacenters_labels_post: #{e}"
333
+ end
334
+ ```
335
+
336
+ #### Using the datacenters_labels_post_with_http_info variant
337
+
338
+ This returns an Array which contains the response data, status code and headers.
339
+
340
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_labels_post_with_http_info(datacenter_id, label, opts)
341
+
342
+ ```ruby
343
+ begin
344
+ # Add a Label to Data Center
345
+ data, status_code, headers = api_instance.datacenters_labels_post_with_http_info(datacenter_id, label, opts)
346
+ p status_code # => 2xx
347
+ p headers # => { ... }
348
+ p data # => <LabelResource>
349
+ rescue Ionoscloud::ApiError => e
350
+ puts "Error when calling LabelApi->datacenters_labels_post_with_http_info: #{e}"
351
+ end
352
+ ```
353
+
354
+ ### Parameters
355
+
356
+ | Name | Type | Description | Notes |
357
+ | ---- | ---- | ----------- | ----- |
358
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
359
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
360
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
361
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
362
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
363
+
364
+ ### Return type
365
+
366
+ [**LabelResource**](LabelResource.md)
367
+
368
+ ### Authorization
369
+
370
+ Basic Authentication, Token Authentication
371
+
372
+ ### HTTP request headers
373
+
374
+ - **Content-Type**: application/json
375
+ - **Accept**: application/json
376
+
377
+
378
+ ## datacenters_labels_put
379
+
380
+ > <LabelResource> datacenters_labels_put(datacenter_id, key, label, opts)
381
+
382
+ Modify a Label of Data Center
383
+
384
+ This will modify the value of the label on a data center.
385
+
386
+ ### Examples
387
+
388
+ ```ruby
389
+ require 'time'
390
+ require 'ionoscloud'
391
+ # setup authorization
392
+ Ionoscloud.configure do |config|
393
+ # Configure HTTP basic authorization: Basic Authentication
394
+ config.username = 'YOUR USERNAME'
395
+ config.password = 'YOUR PASSWORD'
396
+
397
+ # Configure API key authorization: Token Authentication
398
+ config.api_key['Authorization'] = 'YOUR API KEY'
399
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
400
+ # config.api_key_prefix['Authorization'] = 'Bearer'
401
+ end
402
+
403
+ api_instance = Ionoscloud::LabelApi.new
404
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Data Center
405
+ key = 'key_example' # String | The key of the Label
406
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
407
+ opts = {
408
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
409
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
410
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
411
+ }
412
+
413
+ begin
414
+ # Modify a Label of Data Center
415
+ result = api_instance.datacenters_labels_put(datacenter_id, key, label, opts)
416
+ p result
417
+ rescue Ionoscloud::ApiError => e
418
+ puts "Error when calling LabelApi->datacenters_labels_put: #{e}"
419
+ end
420
+ ```
421
+
422
+ #### Using the datacenters_labels_put_with_http_info variant
423
+
424
+ This returns an Array which contains the response data, status code and headers.
425
+
426
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_labels_put_with_http_info(datacenter_id, key, label, opts)
427
+
428
+ ```ruby
429
+ begin
430
+ # Modify a Label of Data Center
431
+ data, status_code, headers = api_instance.datacenters_labels_put_with_http_info(datacenter_id, key, label, opts)
432
+ p status_code # => 2xx
433
+ p headers # => { ... }
434
+ p data # => <LabelResource>
435
+ rescue Ionoscloud::ApiError => e
436
+ puts "Error when calling LabelApi->datacenters_labels_put_with_http_info: #{e}"
437
+ end
438
+ ```
439
+
440
+ ### Parameters
441
+
442
+ | Name | Type | Description | Notes |
443
+ | ---- | ---- | ----------- | ----- |
444
+ | **datacenter_id** | **String** | The unique ID of the Data Center | |
445
+ | **key** | **String** | The key of the Label | |
446
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
447
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
448
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
449
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
450
+
451
+ ### Return type
452
+
453
+ [**LabelResource**](LabelResource.md)
454
+
455
+ ### Authorization
456
+
457
+ Basic Authentication, Token Authentication
458
+
459
+ ### HTTP request headers
460
+
461
+ - **Content-Type**: application/json
462
+ - **Accept**: application/json
463
+
464
+
465
+ ## datacenters_servers_labels_delete
466
+
467
+ > Object datacenters_servers_labels_delete(datacenter_id, server_id, key, opts)
468
+
469
+ Delete a Label from Server
470
+
471
+ This will remove a label from the server.
472
+
473
+ ### Examples
474
+
475
+ ```ruby
476
+ require 'time'
477
+ require 'ionoscloud'
478
+ # setup authorization
479
+ Ionoscloud.configure do |config|
480
+ # Configure HTTP basic authorization: Basic Authentication
481
+ config.username = 'YOUR USERNAME'
482
+ config.password = 'YOUR PASSWORD'
483
+
484
+ # Configure API key authorization: Token Authentication
485
+ config.api_key['Authorization'] = 'YOUR API KEY'
486
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
487
+ # config.api_key_prefix['Authorization'] = 'Bearer'
488
+ end
489
+
490
+ api_instance = Ionoscloud::LabelApi.new
491
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
492
+ server_id = 'server_id_example' # String | The unique ID of the Server
493
+ key = 'key_example' # String | The key of the Label
494
+ opts = {
495
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
496
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
497
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
498
+ }
499
+
500
+ begin
501
+ # Delete a Label from Server
502
+ result = api_instance.datacenters_servers_labels_delete(datacenter_id, server_id, key, opts)
503
+ p result
504
+ rescue Ionoscloud::ApiError => e
505
+ puts "Error when calling LabelApi->datacenters_servers_labels_delete: #{e}"
506
+ end
507
+ ```
508
+
509
+ #### Using the datacenters_servers_labels_delete_with_http_info variant
510
+
511
+ This returns an Array which contains the response data, status code and headers.
512
+
513
+ > <Array(Object, Integer, Hash)> datacenters_servers_labels_delete_with_http_info(datacenter_id, server_id, key, opts)
514
+
515
+ ```ruby
516
+ begin
517
+ # Delete a Label from Server
518
+ data, status_code, headers = api_instance.datacenters_servers_labels_delete_with_http_info(datacenter_id, server_id, key, opts)
519
+ p status_code # => 2xx
520
+ p headers # => { ... }
521
+ p data # => Object
522
+ rescue Ionoscloud::ApiError => e
523
+ puts "Error when calling LabelApi->datacenters_servers_labels_delete_with_http_info: #{e}"
524
+ end
525
+ ```
526
+
527
+ ### Parameters
528
+
529
+ | Name | Type | Description | Notes |
530
+ | ---- | ---- | ----------- | ----- |
531
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
532
+ | **server_id** | **String** | The unique ID of the Server | |
533
+ | **key** | **String** | The key of the Label | |
534
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
535
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
536
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
537
+
538
+ ### Return type
539
+
540
+ **Object**
541
+
542
+ ### Authorization
543
+
544
+ Basic Authentication, Token Authentication
545
+
546
+ ### HTTP request headers
547
+
548
+ - **Content-Type**: Not defined
549
+ - **Accept**: application/json
550
+
551
+
552
+ ## datacenters_servers_labels_find_by_key
553
+
554
+ > <LabelResource> datacenters_servers_labels_find_by_key(datacenter_id, server_id, key, opts)
555
+
556
+ Retrieve a Label of Server
557
+
558
+ This will retrieve the properties of a associated label to a server.
559
+
560
+ ### Examples
561
+
562
+ ```ruby
563
+ require 'time'
564
+ require 'ionoscloud'
565
+ # setup authorization
566
+ Ionoscloud.configure do |config|
567
+ # Configure HTTP basic authorization: Basic Authentication
568
+ config.username = 'YOUR USERNAME'
569
+ config.password = 'YOUR PASSWORD'
570
+
571
+ # Configure API key authorization: Token Authentication
572
+ config.api_key['Authorization'] = 'YOUR API KEY'
573
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
574
+ # config.api_key_prefix['Authorization'] = 'Bearer'
575
+ end
576
+
577
+ api_instance = Ionoscloud::LabelApi.new
578
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
579
+ server_id = 'server_id_example' # String | The unique ID of the Server
580
+ key = 'key_example' # String | The key of the Label
581
+ opts = {
582
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
583
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
584
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
585
+ }
586
+
587
+ begin
588
+ # Retrieve a Label of Server
589
+ result = api_instance.datacenters_servers_labels_find_by_key(datacenter_id, server_id, key, opts)
590
+ p result
591
+ rescue Ionoscloud::ApiError => e
592
+ puts "Error when calling LabelApi->datacenters_servers_labels_find_by_key: #{e}"
593
+ end
594
+ ```
595
+
596
+ #### Using the datacenters_servers_labels_find_by_key_with_http_info variant
597
+
598
+ This returns an Array which contains the response data, status code and headers.
599
+
600
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_servers_labels_find_by_key_with_http_info(datacenter_id, server_id, key, opts)
601
+
602
+ ```ruby
603
+ begin
604
+ # Retrieve a Label of Server
605
+ data, status_code, headers = api_instance.datacenters_servers_labels_find_by_key_with_http_info(datacenter_id, server_id, key, opts)
606
+ p status_code # => 2xx
607
+ p headers # => { ... }
608
+ p data # => <LabelResource>
609
+ rescue Ionoscloud::ApiError => e
610
+ puts "Error when calling LabelApi->datacenters_servers_labels_find_by_key_with_http_info: #{e}"
611
+ end
612
+ ```
613
+
614
+ ### Parameters
615
+
616
+ | Name | Type | Description | Notes |
617
+ | ---- | ---- | ----------- | ----- |
618
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
619
+ | **server_id** | **String** | The unique ID of the Server | |
620
+ | **key** | **String** | The key of the Label | |
621
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
622
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
623
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
624
+
625
+ ### Return type
626
+
627
+ [**LabelResource**](LabelResource.md)
628
+
629
+ ### Authorization
630
+
631
+ Basic Authentication, Token Authentication
632
+
633
+ ### HTTP request headers
634
+
635
+ - **Content-Type**: Not defined
636
+ - **Accept**: application/json
637
+
638
+
639
+ ## datacenters_servers_labels_get
640
+
641
+ > <LabelResources> datacenters_servers_labels_get(datacenter_id, server_id, opts)
642
+
643
+ List all Server Labels
644
+
645
+ You can retrieve a list of all labels associated with a server
646
+
647
+ ### Examples
648
+
649
+ ```ruby
650
+ require 'time'
651
+ require 'ionoscloud'
652
+ # setup authorization
653
+ Ionoscloud.configure do |config|
654
+ # Configure HTTP basic authorization: Basic Authentication
655
+ config.username = 'YOUR USERNAME'
656
+ config.password = 'YOUR PASSWORD'
657
+
658
+ # Configure API key authorization: Token Authentication
659
+ config.api_key['Authorization'] = 'YOUR API KEY'
660
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
661
+ # config.api_key_prefix['Authorization'] = 'Bearer'
662
+ end
663
+
664
+ api_instance = Ionoscloud::LabelApi.new
665
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
666
+ server_id = 'server_id_example' # String | The unique ID of the Server
667
+ opts = {
668
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
669
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
670
+ x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
671
+ offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
672
+ limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
673
+ }
674
+
675
+ begin
676
+ # List all Server Labels
677
+ result = api_instance.datacenters_servers_labels_get(datacenter_id, server_id, opts)
678
+ p result
679
+ rescue Ionoscloud::ApiError => e
680
+ puts "Error when calling LabelApi->datacenters_servers_labels_get: #{e}"
681
+ end
682
+ ```
683
+
684
+ #### Using the datacenters_servers_labels_get_with_http_info variant
685
+
686
+ This returns an Array which contains the response data, status code and headers.
687
+
688
+ > <Array(<LabelResources>, Integer, Hash)> datacenters_servers_labels_get_with_http_info(datacenter_id, server_id, opts)
689
+
690
+ ```ruby
691
+ begin
692
+ # List all Server Labels
693
+ data, status_code, headers = api_instance.datacenters_servers_labels_get_with_http_info(datacenter_id, server_id, opts)
694
+ p status_code # => 2xx
695
+ p headers # => { ... }
696
+ p data # => <LabelResources>
697
+ rescue Ionoscloud::ApiError => e
698
+ puts "Error when calling LabelApi->datacenters_servers_labels_get_with_http_info: #{e}"
699
+ end
700
+ ```
701
+
702
+ ### Parameters
703
+
704
+ | Name | Type | Description | Notes |
705
+ | ---- | ---- | ----------- | ----- |
706
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
707
+ | **server_id** | **String** | The unique ID of the Server | |
708
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
709
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
710
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
711
+ | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
712
+ | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 1000] |
713
+
714
+ ### Return type
715
+
716
+ [**LabelResources**](LabelResources.md)
717
+
718
+ ### Authorization
719
+
720
+ Basic Authentication, Token Authentication
721
+
722
+ ### HTTP request headers
723
+
724
+ - **Content-Type**: Not defined
725
+ - **Accept**: application/json
726
+
727
+
728
+ ## datacenters_servers_labels_post
729
+
730
+ > <LabelResource> datacenters_servers_labels_post(datacenter_id, server_id, label, opts)
731
+
732
+ Add a Label to Server
733
+
734
+ This will add a label to the server.
735
+
736
+ ### Examples
737
+
738
+ ```ruby
739
+ require 'time'
740
+ require 'ionoscloud'
741
+ # setup authorization
742
+ Ionoscloud.configure do |config|
743
+ # Configure HTTP basic authorization: Basic Authentication
744
+ config.username = 'YOUR USERNAME'
745
+ config.password = 'YOUR PASSWORD'
746
+
747
+ # Configure API key authorization: Token Authentication
748
+ config.api_key['Authorization'] = 'YOUR API KEY'
749
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
750
+ # config.api_key_prefix['Authorization'] = 'Bearer'
751
+ end
752
+
753
+ api_instance = Ionoscloud::LabelApi.new
754
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
755
+ server_id = 'server_id_example' # String | The unique ID of the Server
756
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
757
+ opts = {
758
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
759
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
760
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
761
+ }
762
+
763
+ begin
764
+ # Add a Label to Server
765
+ result = api_instance.datacenters_servers_labels_post(datacenter_id, server_id, label, opts)
766
+ p result
767
+ rescue Ionoscloud::ApiError => e
768
+ puts "Error when calling LabelApi->datacenters_servers_labels_post: #{e}"
769
+ end
770
+ ```
771
+
772
+ #### Using the datacenters_servers_labels_post_with_http_info variant
773
+
774
+ This returns an Array which contains the response data, status code and headers.
775
+
776
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_servers_labels_post_with_http_info(datacenter_id, server_id, label, opts)
777
+
778
+ ```ruby
779
+ begin
780
+ # Add a Label to Server
781
+ data, status_code, headers = api_instance.datacenters_servers_labels_post_with_http_info(datacenter_id, server_id, label, opts)
782
+ p status_code # => 2xx
783
+ p headers # => { ... }
784
+ p data # => <LabelResource>
785
+ rescue Ionoscloud::ApiError => e
786
+ puts "Error when calling LabelApi->datacenters_servers_labels_post_with_http_info: #{e}"
787
+ end
788
+ ```
789
+
790
+ ### Parameters
791
+
792
+ | Name | Type | Description | Notes |
793
+ | ---- | ---- | ----------- | ----- |
794
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
795
+ | **server_id** | **String** | The unique ID of the Server | |
796
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
797
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
798
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
799
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
800
+
801
+ ### Return type
802
+
803
+ [**LabelResource**](LabelResource.md)
804
+
805
+ ### Authorization
806
+
807
+ Basic Authentication, Token Authentication
808
+
809
+ ### HTTP request headers
810
+
811
+ - **Content-Type**: application/json
812
+ - **Accept**: application/json
813
+
814
+
815
+ ## datacenters_servers_labels_put
816
+
817
+ > <LabelResource> datacenters_servers_labels_put(datacenter_id, server_id, key, label, opts)
818
+
819
+ Modify a Label of Server
820
+
821
+ This will modify the value of the label on a server.
822
+
823
+ ### Examples
824
+
825
+ ```ruby
826
+ require 'time'
827
+ require 'ionoscloud'
828
+ # setup authorization
829
+ Ionoscloud.configure do |config|
830
+ # Configure HTTP basic authorization: Basic Authentication
831
+ config.username = 'YOUR USERNAME'
832
+ config.password = 'YOUR PASSWORD'
833
+
834
+ # Configure API key authorization: Token Authentication
835
+ config.api_key['Authorization'] = 'YOUR API KEY'
836
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
837
+ # config.api_key_prefix['Authorization'] = 'Bearer'
838
+ end
839
+
840
+ api_instance = Ionoscloud::LabelApi.new
841
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
842
+ server_id = 'server_id_example' # String | The unique ID of the Server
843
+ key = 'key_example' # String | The key of the Label
844
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
845
+ opts = {
846
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
847
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
848
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
849
+ }
850
+
851
+ begin
852
+ # Modify a Label of Server
853
+ result = api_instance.datacenters_servers_labels_put(datacenter_id, server_id, key, label, opts)
854
+ p result
855
+ rescue Ionoscloud::ApiError => e
856
+ puts "Error when calling LabelApi->datacenters_servers_labels_put: #{e}"
857
+ end
858
+ ```
859
+
860
+ #### Using the datacenters_servers_labels_put_with_http_info variant
861
+
862
+ This returns an Array which contains the response data, status code and headers.
863
+
864
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_servers_labels_put_with_http_info(datacenter_id, server_id, key, label, opts)
865
+
866
+ ```ruby
867
+ begin
868
+ # Modify a Label of Server
869
+ data, status_code, headers = api_instance.datacenters_servers_labels_put_with_http_info(datacenter_id, server_id, key, label, opts)
870
+ p status_code # => 2xx
871
+ p headers # => { ... }
872
+ p data # => <LabelResource>
873
+ rescue Ionoscloud::ApiError => e
874
+ puts "Error when calling LabelApi->datacenters_servers_labels_put_with_http_info: #{e}"
875
+ end
876
+ ```
877
+
878
+ ### Parameters
879
+
880
+ | Name | Type | Description | Notes |
881
+ | ---- | ---- | ----------- | ----- |
882
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
883
+ | **server_id** | **String** | The unique ID of the Server | |
884
+ | **key** | **String** | The key of the Label | |
885
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
886
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
887
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
888
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
889
+
890
+ ### Return type
891
+
892
+ [**LabelResource**](LabelResource.md)
893
+
894
+ ### Authorization
895
+
896
+ Basic Authentication, Token Authentication
897
+
898
+ ### HTTP request headers
899
+
900
+ - **Content-Type**: application/json
901
+ - **Accept**: application/json
902
+
903
+
904
+ ## datacenters_volumes_labels_delete
905
+
906
+ > Object datacenters_volumes_labels_delete(datacenter_id, volume_id, key, opts)
907
+
908
+ Delete a Label from Volume
909
+
910
+ This will remove a label from the volume.
911
+
912
+ ### Examples
913
+
914
+ ```ruby
915
+ require 'time'
916
+ require 'ionoscloud'
917
+ # setup authorization
918
+ Ionoscloud.configure do |config|
919
+ # Configure HTTP basic authorization: Basic Authentication
920
+ config.username = 'YOUR USERNAME'
921
+ config.password = 'YOUR PASSWORD'
922
+
923
+ # Configure API key authorization: Token Authentication
924
+ config.api_key['Authorization'] = 'YOUR API KEY'
925
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
926
+ # config.api_key_prefix['Authorization'] = 'Bearer'
927
+ end
928
+
929
+ api_instance = Ionoscloud::LabelApi.new
930
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
931
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
932
+ key = 'key_example' # String | The key of the Label
933
+ opts = {
934
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
935
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
936
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
937
+ }
938
+
939
+ begin
940
+ # Delete a Label from Volume
941
+ result = api_instance.datacenters_volumes_labels_delete(datacenter_id, volume_id, key, opts)
942
+ p result
943
+ rescue Ionoscloud::ApiError => e
944
+ puts "Error when calling LabelApi->datacenters_volumes_labels_delete: #{e}"
945
+ end
946
+ ```
947
+
948
+ #### Using the datacenters_volumes_labels_delete_with_http_info variant
949
+
950
+ This returns an Array which contains the response data, status code and headers.
951
+
952
+ > <Array(Object, Integer, Hash)> datacenters_volumes_labels_delete_with_http_info(datacenter_id, volume_id, key, opts)
953
+
954
+ ```ruby
955
+ begin
956
+ # Delete a Label from Volume
957
+ data, status_code, headers = api_instance.datacenters_volumes_labels_delete_with_http_info(datacenter_id, volume_id, key, opts)
958
+ p status_code # => 2xx
959
+ p headers # => { ... }
960
+ p data # => Object
961
+ rescue Ionoscloud::ApiError => e
962
+ puts "Error when calling LabelApi->datacenters_volumes_labels_delete_with_http_info: #{e}"
963
+ end
964
+ ```
965
+
966
+ ### Parameters
967
+
968
+ | Name | Type | Description | Notes |
969
+ | ---- | ---- | ----------- | ----- |
970
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
971
+ | **volume_id** | **String** | The unique ID of the Volume | |
972
+ | **key** | **String** | The key of the Label | |
973
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
974
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
975
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
976
+
977
+ ### Return type
978
+
979
+ **Object**
980
+
981
+ ### Authorization
982
+
983
+ Basic Authentication, Token Authentication
984
+
985
+ ### HTTP request headers
986
+
987
+ - **Content-Type**: Not defined
988
+ - **Accept**: application/json
989
+
990
+
991
+ ## datacenters_volumes_labels_find_by_key
992
+
993
+ > <LabelResource> datacenters_volumes_labels_find_by_key(datacenter_id, volume_id, key, opts)
994
+
995
+ Retrieve a Label of Volume
996
+
997
+ This will retrieve the properties of a associated label to a volume.
998
+
999
+ ### Examples
1000
+
1001
+ ```ruby
1002
+ require 'time'
1003
+ require 'ionoscloud'
1004
+ # setup authorization
1005
+ Ionoscloud.configure do |config|
1006
+ # Configure HTTP basic authorization: Basic Authentication
1007
+ config.username = 'YOUR USERNAME'
1008
+ config.password = 'YOUR PASSWORD'
1009
+
1010
+ # Configure API key authorization: Token Authentication
1011
+ config.api_key['Authorization'] = 'YOUR API KEY'
1012
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1013
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1014
+ end
1015
+
1016
+ api_instance = Ionoscloud::LabelApi.new
1017
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1018
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
1019
+ key = 'key_example' # String | The key of the Label
1020
+ opts = {
1021
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1022
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1023
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1024
+ }
1025
+
1026
+ begin
1027
+ # Retrieve a Label of Volume
1028
+ result = api_instance.datacenters_volumes_labels_find_by_key(datacenter_id, volume_id, key, opts)
1029
+ p result
1030
+ rescue Ionoscloud::ApiError => e
1031
+ puts "Error when calling LabelApi->datacenters_volumes_labels_find_by_key: #{e}"
1032
+ end
1033
+ ```
1034
+
1035
+ #### Using the datacenters_volumes_labels_find_by_key_with_http_info variant
1036
+
1037
+ This returns an Array which contains the response data, status code and headers.
1038
+
1039
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_volumes_labels_find_by_key_with_http_info(datacenter_id, volume_id, key, opts)
1040
+
1041
+ ```ruby
1042
+ begin
1043
+ # Retrieve a Label of Volume
1044
+ data, status_code, headers = api_instance.datacenters_volumes_labels_find_by_key_with_http_info(datacenter_id, volume_id, key, opts)
1045
+ p status_code # => 2xx
1046
+ p headers # => { ... }
1047
+ p data # => <LabelResource>
1048
+ rescue Ionoscloud::ApiError => e
1049
+ puts "Error when calling LabelApi->datacenters_volumes_labels_find_by_key_with_http_info: #{e}"
1050
+ end
1051
+ ```
1052
+
1053
+ ### Parameters
1054
+
1055
+ | Name | Type | Description | Notes |
1056
+ | ---- | ---- | ----------- | ----- |
1057
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1058
+ | **volume_id** | **String** | The unique ID of the Volume | |
1059
+ | **key** | **String** | The key of the Label | |
1060
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1061
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1062
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1063
+
1064
+ ### Return type
1065
+
1066
+ [**LabelResource**](LabelResource.md)
1067
+
1068
+ ### Authorization
1069
+
1070
+ Basic Authentication, Token Authentication
1071
+
1072
+ ### HTTP request headers
1073
+
1074
+ - **Content-Type**: Not defined
1075
+ - **Accept**: application/json
1076
+
1077
+
1078
+ ## datacenters_volumes_labels_get
1079
+
1080
+ > <LabelResources> datacenters_volumes_labels_get(datacenter_id, volume_id, opts)
1081
+
1082
+ List all Volume Labels
1083
+
1084
+ You can retrieve a list of all labels associated with a volume
1085
+
1086
+ ### Examples
1087
+
1088
+ ```ruby
1089
+ require 'time'
1090
+ require 'ionoscloud'
1091
+ # setup authorization
1092
+ Ionoscloud.configure do |config|
1093
+ # Configure HTTP basic authorization: Basic Authentication
1094
+ config.username = 'YOUR USERNAME'
1095
+ config.password = 'YOUR PASSWORD'
1096
+
1097
+ # Configure API key authorization: Token Authentication
1098
+ config.api_key['Authorization'] = 'YOUR API KEY'
1099
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1100
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1101
+ end
1102
+
1103
+ api_instance = Ionoscloud::LabelApi.new
1104
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1105
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
1106
+ opts = {
1107
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1108
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1109
+ x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1110
+ offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
1111
+ limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
1112
+ }
1113
+
1114
+ begin
1115
+ # List all Volume Labels
1116
+ result = api_instance.datacenters_volumes_labels_get(datacenter_id, volume_id, opts)
1117
+ p result
1118
+ rescue Ionoscloud::ApiError => e
1119
+ puts "Error when calling LabelApi->datacenters_volumes_labels_get: #{e}"
1120
+ end
1121
+ ```
1122
+
1123
+ #### Using the datacenters_volumes_labels_get_with_http_info variant
1124
+
1125
+ This returns an Array which contains the response data, status code and headers.
1126
+
1127
+ > <Array(<LabelResources>, Integer, Hash)> datacenters_volumes_labels_get_with_http_info(datacenter_id, volume_id, opts)
1128
+
1129
+ ```ruby
1130
+ begin
1131
+ # List all Volume Labels
1132
+ data, status_code, headers = api_instance.datacenters_volumes_labels_get_with_http_info(datacenter_id, volume_id, opts)
1133
+ p status_code # => 2xx
1134
+ p headers # => { ... }
1135
+ p data # => <LabelResources>
1136
+ rescue Ionoscloud::ApiError => e
1137
+ puts "Error when calling LabelApi->datacenters_volumes_labels_get_with_http_info: #{e}"
1138
+ end
1139
+ ```
1140
+
1141
+ ### Parameters
1142
+
1143
+ | Name | Type | Description | Notes |
1144
+ | ---- | ---- | ----------- | ----- |
1145
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1146
+ | **volume_id** | **String** | The unique ID of the Volume | |
1147
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1148
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1149
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1150
+ | **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with &lt;code&gt;limit&lt;/code&gt; for pagination) | [optional][default to 0] |
1151
+ | **limit** | **Integer** | the maximum number of elements to return (use together with &lt;code&gt;offset&lt;/code&gt; for pagination) | [optional][default to 1000] |
1152
+
1153
+ ### Return type
1154
+
1155
+ [**LabelResources**](LabelResources.md)
1156
+
1157
+ ### Authorization
1158
+
1159
+ Basic Authentication, Token Authentication
1160
+
1161
+ ### HTTP request headers
1162
+
1163
+ - **Content-Type**: Not defined
1164
+ - **Accept**: application/json
1165
+
1166
+
1167
+ ## datacenters_volumes_labels_post
1168
+
1169
+ > <LabelResource> datacenters_volumes_labels_post(datacenter_id, volume_id, label, opts)
1170
+
1171
+ Add a Label to Volume
1172
+
1173
+ This will add a label to the volume.
1174
+
1175
+ ### Examples
1176
+
1177
+ ```ruby
1178
+ require 'time'
1179
+ require 'ionoscloud'
1180
+ # setup authorization
1181
+ Ionoscloud.configure do |config|
1182
+ # Configure HTTP basic authorization: Basic Authentication
1183
+ config.username = 'YOUR USERNAME'
1184
+ config.password = 'YOUR PASSWORD'
1185
+
1186
+ # Configure API key authorization: Token Authentication
1187
+ config.api_key['Authorization'] = 'YOUR API KEY'
1188
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1189
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1190
+ end
1191
+
1192
+ api_instance = Ionoscloud::LabelApi.new
1193
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1194
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
1195
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
1196
+ opts = {
1197
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1198
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1199
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1200
+ }
1201
+
1202
+ begin
1203
+ # Add a Label to Volume
1204
+ result = api_instance.datacenters_volumes_labels_post(datacenter_id, volume_id, label, opts)
1205
+ p result
1206
+ rescue Ionoscloud::ApiError => e
1207
+ puts "Error when calling LabelApi->datacenters_volumes_labels_post: #{e}"
1208
+ end
1209
+ ```
1210
+
1211
+ #### Using the datacenters_volumes_labels_post_with_http_info variant
1212
+
1213
+ This returns an Array which contains the response data, status code and headers.
1214
+
1215
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_volumes_labels_post_with_http_info(datacenter_id, volume_id, label, opts)
1216
+
1217
+ ```ruby
1218
+ begin
1219
+ # Add a Label to Volume
1220
+ data, status_code, headers = api_instance.datacenters_volumes_labels_post_with_http_info(datacenter_id, volume_id, label, opts)
1221
+ p status_code # => 2xx
1222
+ p headers # => { ... }
1223
+ p data # => <LabelResource>
1224
+ rescue Ionoscloud::ApiError => e
1225
+ puts "Error when calling LabelApi->datacenters_volumes_labels_post_with_http_info: #{e}"
1226
+ end
1227
+ ```
1228
+
1229
+ ### Parameters
1230
+
1231
+ | Name | Type | Description | Notes |
1232
+ | ---- | ---- | ----------- | ----- |
1233
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1234
+ | **volume_id** | **String** | The unique ID of the Volume | |
1235
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
1236
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1237
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1238
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1239
+
1240
+ ### Return type
1241
+
1242
+ [**LabelResource**](LabelResource.md)
1243
+
1244
+ ### Authorization
1245
+
1246
+ Basic Authentication, Token Authentication
1247
+
1248
+ ### HTTP request headers
1249
+
1250
+ - **Content-Type**: application/json
1251
+ - **Accept**: application/json
1252
+
1253
+
1254
+ ## datacenters_volumes_labels_put
1255
+
1256
+ > <LabelResource> datacenters_volumes_labels_put(datacenter_id, volume_id, key, label, opts)
1257
+
1258
+ Modify a Label of Volume
1259
+
1260
+ This will modify the value of the label on a volume.
1261
+
1262
+ ### Examples
1263
+
1264
+ ```ruby
1265
+ require 'time'
1266
+ require 'ionoscloud'
1267
+ # setup authorization
1268
+ Ionoscloud.configure do |config|
1269
+ # Configure HTTP basic authorization: Basic Authentication
1270
+ config.username = 'YOUR USERNAME'
1271
+ config.password = 'YOUR PASSWORD'
1272
+
1273
+ # Configure API key authorization: Token Authentication
1274
+ config.api_key['Authorization'] = 'YOUR API KEY'
1275
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1276
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1277
+ end
1278
+
1279
+ api_instance = Ionoscloud::LabelApi.new
1280
+ datacenter_id = 'datacenter_id_example' # String | The unique ID of the Datacenter
1281
+ volume_id = 'volume_id_example' # String | The unique ID of the Volume
1282
+ key = 'key_example' # String | The key of the Label
1283
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
1284
+ opts = {
1285
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1286
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1287
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1288
+ }
1289
+
1290
+ begin
1291
+ # Modify a Label of Volume
1292
+ result = api_instance.datacenters_volumes_labels_put(datacenter_id, volume_id, key, label, opts)
1293
+ p result
1294
+ rescue Ionoscloud::ApiError => e
1295
+ puts "Error when calling LabelApi->datacenters_volumes_labels_put: #{e}"
1296
+ end
1297
+ ```
1298
+
1299
+ #### Using the datacenters_volumes_labels_put_with_http_info variant
1300
+
1301
+ This returns an Array which contains the response data, status code and headers.
1302
+
1303
+ > <Array(<LabelResource>, Integer, Hash)> datacenters_volumes_labels_put_with_http_info(datacenter_id, volume_id, key, label, opts)
1304
+
1305
+ ```ruby
1306
+ begin
1307
+ # Modify a Label of Volume
1308
+ data, status_code, headers = api_instance.datacenters_volumes_labels_put_with_http_info(datacenter_id, volume_id, key, label, opts)
1309
+ p status_code # => 2xx
1310
+ p headers # => { ... }
1311
+ p data # => <LabelResource>
1312
+ rescue Ionoscloud::ApiError => e
1313
+ puts "Error when calling LabelApi->datacenters_volumes_labels_put_with_http_info: #{e}"
1314
+ end
1315
+ ```
1316
+
1317
+ ### Parameters
1318
+
1319
+ | Name | Type | Description | Notes |
1320
+ | ---- | ---- | ----------- | ----- |
1321
+ | **datacenter_id** | **String** | The unique ID of the Datacenter | |
1322
+ | **volume_id** | **String** | The unique ID of the Volume | |
1323
+ | **key** | **String** | The key of the Label | |
1324
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
1325
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1326
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1327
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1328
+
1329
+ ### Return type
1330
+
1331
+ [**LabelResource**](LabelResource.md)
1332
+
1333
+ ### Authorization
1334
+
1335
+ Basic Authentication, Token Authentication
1336
+
1337
+ ### HTTP request headers
1338
+
1339
+ - **Content-Type**: application/json
1340
+ - **Accept**: application/json
1341
+
1342
+
1343
+ ## ipblocks_labels_delete
1344
+
1345
+ > Object ipblocks_labels_delete(ipblock_id, key, opts)
1346
+
1347
+ Delete a Label from IP Block
1348
+
1349
+ This will remove a label from the Ip Block.
1350
+
1351
+ ### Examples
1352
+
1353
+ ```ruby
1354
+ require 'time'
1355
+ require 'ionoscloud'
1356
+ # setup authorization
1357
+ Ionoscloud.configure do |config|
1358
+ # Configure HTTP basic authorization: Basic Authentication
1359
+ config.username = 'YOUR USERNAME'
1360
+ config.password = 'YOUR PASSWORD'
1361
+
1362
+ # Configure API key authorization: Token Authentication
1363
+ config.api_key['Authorization'] = 'YOUR API KEY'
1364
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1365
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1366
+ end
1367
+
1368
+ api_instance = Ionoscloud::LabelApi.new
1369
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1370
+ key = 'key_example' # String | The key of the Label
1371
+ opts = {
1372
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1373
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1374
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1375
+ }
1376
+
1377
+ begin
1378
+ # Delete a Label from IP Block
1379
+ result = api_instance.ipblocks_labels_delete(ipblock_id, key, opts)
1380
+ p result
1381
+ rescue Ionoscloud::ApiError => e
1382
+ puts "Error when calling LabelApi->ipblocks_labels_delete: #{e}"
1383
+ end
1384
+ ```
1385
+
1386
+ #### Using the ipblocks_labels_delete_with_http_info variant
1387
+
1388
+ This returns an Array which contains the response data, status code and headers.
1389
+
1390
+ > <Array(Object, Integer, Hash)> ipblocks_labels_delete_with_http_info(ipblock_id, key, opts)
1391
+
1392
+ ```ruby
1393
+ begin
1394
+ # Delete a Label from IP Block
1395
+ data, status_code, headers = api_instance.ipblocks_labels_delete_with_http_info(ipblock_id, key, opts)
1396
+ p status_code # => 2xx
1397
+ p headers # => { ... }
1398
+ p data # => Object
1399
+ rescue Ionoscloud::ApiError => e
1400
+ puts "Error when calling LabelApi->ipblocks_labels_delete_with_http_info: #{e}"
1401
+ end
1402
+ ```
1403
+
1404
+ ### Parameters
1405
+
1406
+ | Name | Type | Description | Notes |
1407
+ | ---- | ---- | ----------- | ----- |
1408
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1409
+ | **key** | **String** | The key of the Label | |
1410
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1411
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1412
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1413
+
1414
+ ### Return type
1415
+
1416
+ **Object**
1417
+
1418
+ ### Authorization
1419
+
1420
+ Basic Authentication, Token Authentication
1421
+
1422
+ ### HTTP request headers
1423
+
1424
+ - **Content-Type**: Not defined
1425
+ - **Accept**: application/json
1426
+
1427
+
1428
+ ## ipblocks_labels_find_by_key
1429
+
1430
+ > <LabelResource> ipblocks_labels_find_by_key(ipblock_id, key, opts)
1431
+
1432
+ Retrieve a Label of IP Block
1433
+
1434
+ This will retrieve the properties of a associated label to a Ip Block.
1435
+
1436
+ ### Examples
1437
+
1438
+ ```ruby
1439
+ require 'time'
1440
+ require 'ionoscloud'
1441
+ # setup authorization
1442
+ Ionoscloud.configure do |config|
1443
+ # Configure HTTP basic authorization: Basic Authentication
1444
+ config.username = 'YOUR USERNAME'
1445
+ config.password = 'YOUR PASSWORD'
1446
+
1447
+ # Configure API key authorization: Token Authentication
1448
+ config.api_key['Authorization'] = 'YOUR API KEY'
1449
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1450
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1451
+ end
1452
+
1453
+ api_instance = Ionoscloud::LabelApi.new
1454
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1455
+ key = 'key_example' # String | The key of the Label
1456
+ opts = {
1457
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1458
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1459
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1460
+ }
1461
+
1462
+ begin
1463
+ # Retrieve a Label of IP Block
1464
+ result = api_instance.ipblocks_labels_find_by_key(ipblock_id, key, opts)
1465
+ p result
1466
+ rescue Ionoscloud::ApiError => e
1467
+ puts "Error when calling LabelApi->ipblocks_labels_find_by_key: #{e}"
1468
+ end
1469
+ ```
1470
+
1471
+ #### Using the ipblocks_labels_find_by_key_with_http_info variant
1472
+
1473
+ This returns an Array which contains the response data, status code and headers.
1474
+
1475
+ > <Array(<LabelResource>, Integer, Hash)> ipblocks_labels_find_by_key_with_http_info(ipblock_id, key, opts)
1476
+
1477
+ ```ruby
1478
+ begin
1479
+ # Retrieve a Label of IP Block
1480
+ data, status_code, headers = api_instance.ipblocks_labels_find_by_key_with_http_info(ipblock_id, key, opts)
1481
+ p status_code # => 2xx
1482
+ p headers # => { ... }
1483
+ p data # => <LabelResource>
1484
+ rescue Ionoscloud::ApiError => e
1485
+ puts "Error when calling LabelApi->ipblocks_labels_find_by_key_with_http_info: #{e}"
1486
+ end
1487
+ ```
1488
+
1489
+ ### Parameters
1490
+
1491
+ | Name | Type | Description | Notes |
1492
+ | ---- | ---- | ----------- | ----- |
1493
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1494
+ | **key** | **String** | The key of the Label | |
1495
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1496
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1497
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1498
+
1499
+ ### Return type
1500
+
1501
+ [**LabelResource**](LabelResource.md)
1502
+
1503
+ ### Authorization
1504
+
1505
+ Basic Authentication, Token Authentication
1506
+
1507
+ ### HTTP request headers
1508
+
1509
+ - **Content-Type**: Not defined
1510
+ - **Accept**: application/json
1511
+
1512
+
1513
+ ## ipblocks_labels_get
1514
+
1515
+ > <LabelResources> ipblocks_labels_get(ipblock_id, opts)
1516
+
1517
+ List all Ip Block Labels
1518
+
1519
+ You can retrieve a list of all labels associated with a IP Block
1520
+
1521
+ ### Examples
1522
+
1523
+ ```ruby
1524
+ require 'time'
1525
+ require 'ionoscloud'
1526
+ # setup authorization
1527
+ Ionoscloud.configure do |config|
1528
+ # Configure HTTP basic authorization: Basic Authentication
1529
+ config.username = 'YOUR USERNAME'
1530
+ config.password = 'YOUR PASSWORD'
1531
+
1532
+ # Configure API key authorization: Token Authentication
1533
+ config.api_key['Authorization'] = 'YOUR API KEY'
1534
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1535
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1536
+ end
1537
+
1538
+ api_instance = Ionoscloud::LabelApi.new
1539
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1540
+ opts = {
1541
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1542
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1543
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1544
+ }
1545
+
1546
+ begin
1547
+ # List all Ip Block Labels
1548
+ result = api_instance.ipblocks_labels_get(ipblock_id, opts)
1549
+ p result
1550
+ rescue Ionoscloud::ApiError => e
1551
+ puts "Error when calling LabelApi->ipblocks_labels_get: #{e}"
1552
+ end
1553
+ ```
1554
+
1555
+ #### Using the ipblocks_labels_get_with_http_info variant
1556
+
1557
+ This returns an Array which contains the response data, status code and headers.
1558
+
1559
+ > <Array(<LabelResources>, Integer, Hash)> ipblocks_labels_get_with_http_info(ipblock_id, opts)
1560
+
1561
+ ```ruby
1562
+ begin
1563
+ # List all Ip Block Labels
1564
+ data, status_code, headers = api_instance.ipblocks_labels_get_with_http_info(ipblock_id, opts)
1565
+ p status_code # => 2xx
1566
+ p headers # => { ... }
1567
+ p data # => <LabelResources>
1568
+ rescue Ionoscloud::ApiError => e
1569
+ puts "Error when calling LabelApi->ipblocks_labels_get_with_http_info: #{e}"
1570
+ end
1571
+ ```
1572
+
1573
+ ### Parameters
1574
+
1575
+ | Name | Type | Description | Notes |
1576
+ | ---- | ---- | ----------- | ----- |
1577
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1578
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1579
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1580
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1581
+
1582
+ ### Return type
1583
+
1584
+ [**LabelResources**](LabelResources.md)
1585
+
1586
+ ### Authorization
1587
+
1588
+ Basic Authentication, Token Authentication
1589
+
1590
+ ### HTTP request headers
1591
+
1592
+ - **Content-Type**: Not defined
1593
+ - **Accept**: application/json
1594
+
1595
+
1596
+ ## ipblocks_labels_post
1597
+
1598
+ > <LabelResource> ipblocks_labels_post(ipblock_id, label, opts)
1599
+
1600
+ Add a Label to IP Block
1601
+
1602
+ This will add a label to the Ip Block.
1603
+
1604
+ ### Examples
1605
+
1606
+ ```ruby
1607
+ require 'time'
1608
+ require 'ionoscloud'
1609
+ # setup authorization
1610
+ Ionoscloud.configure do |config|
1611
+ # Configure HTTP basic authorization: Basic Authentication
1612
+ config.username = 'YOUR USERNAME'
1613
+ config.password = 'YOUR PASSWORD'
1614
+
1615
+ # Configure API key authorization: Token Authentication
1616
+ config.api_key['Authorization'] = 'YOUR API KEY'
1617
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1618
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1619
+ end
1620
+
1621
+ api_instance = Ionoscloud::LabelApi.new
1622
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1623
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
1624
+ opts = {
1625
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1626
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1627
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1628
+ }
1629
+
1630
+ begin
1631
+ # Add a Label to IP Block
1632
+ result = api_instance.ipblocks_labels_post(ipblock_id, label, opts)
1633
+ p result
1634
+ rescue Ionoscloud::ApiError => e
1635
+ puts "Error when calling LabelApi->ipblocks_labels_post: #{e}"
1636
+ end
1637
+ ```
1638
+
1639
+ #### Using the ipblocks_labels_post_with_http_info variant
1640
+
1641
+ This returns an Array which contains the response data, status code and headers.
1642
+
1643
+ > <Array(<LabelResource>, Integer, Hash)> ipblocks_labels_post_with_http_info(ipblock_id, label, opts)
1644
+
1645
+ ```ruby
1646
+ begin
1647
+ # Add a Label to IP Block
1648
+ data, status_code, headers = api_instance.ipblocks_labels_post_with_http_info(ipblock_id, label, opts)
1649
+ p status_code # => 2xx
1650
+ p headers # => { ... }
1651
+ p data # => <LabelResource>
1652
+ rescue Ionoscloud::ApiError => e
1653
+ puts "Error when calling LabelApi->ipblocks_labels_post_with_http_info: #{e}"
1654
+ end
1655
+ ```
1656
+
1657
+ ### Parameters
1658
+
1659
+ | Name | Type | Description | Notes |
1660
+ | ---- | ---- | ----------- | ----- |
1661
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1662
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
1663
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1664
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1665
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1666
+
1667
+ ### Return type
1668
+
1669
+ [**LabelResource**](LabelResource.md)
1670
+
1671
+ ### Authorization
1672
+
1673
+ Basic Authentication, Token Authentication
1674
+
1675
+ ### HTTP request headers
1676
+
1677
+ - **Content-Type**: application/json
1678
+ - **Accept**: application/json
1679
+
1680
+
1681
+ ## ipblocks_labels_put
1682
+
1683
+ > <LabelResource> ipblocks_labels_put(ipblock_id, key, label, opts)
1684
+
1685
+ Modify a Label of IP Block
1686
+
1687
+ This will modify the value of the label on a Ip Block.
1688
+
1689
+ ### Examples
1690
+
1691
+ ```ruby
1692
+ require 'time'
1693
+ require 'ionoscloud'
1694
+ # setup authorization
1695
+ Ionoscloud.configure do |config|
1696
+ # Configure HTTP basic authorization: Basic Authentication
1697
+ config.username = 'YOUR USERNAME'
1698
+ config.password = 'YOUR PASSWORD'
1699
+
1700
+ # Configure API key authorization: Token Authentication
1701
+ config.api_key['Authorization'] = 'YOUR API KEY'
1702
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1703
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1704
+ end
1705
+
1706
+ api_instance = Ionoscloud::LabelApi.new
1707
+ ipblock_id = 'ipblock_id_example' # String | The unique ID of the Ip Block
1708
+ key = 'key_example' # String | The key of the Label
1709
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
1710
+ opts = {
1711
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1712
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1713
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1714
+ }
1715
+
1716
+ begin
1717
+ # Modify a Label of IP Block
1718
+ result = api_instance.ipblocks_labels_put(ipblock_id, key, label, opts)
1719
+ p result
1720
+ rescue Ionoscloud::ApiError => e
1721
+ puts "Error when calling LabelApi->ipblocks_labels_put: #{e}"
1722
+ end
1723
+ ```
1724
+
1725
+ #### Using the ipblocks_labels_put_with_http_info variant
1726
+
1727
+ This returns an Array which contains the response data, status code and headers.
1728
+
1729
+ > <Array(<LabelResource>, Integer, Hash)> ipblocks_labels_put_with_http_info(ipblock_id, key, label, opts)
1730
+
1731
+ ```ruby
1732
+ begin
1733
+ # Modify a Label of IP Block
1734
+ data, status_code, headers = api_instance.ipblocks_labels_put_with_http_info(ipblock_id, key, label, opts)
1735
+ p status_code # => 2xx
1736
+ p headers # => { ... }
1737
+ p data # => <LabelResource>
1738
+ rescue Ionoscloud::ApiError => e
1739
+ puts "Error when calling LabelApi->ipblocks_labels_put_with_http_info: #{e}"
1740
+ end
1741
+ ```
1742
+
1743
+ ### Parameters
1744
+
1745
+ | Name | Type | Description | Notes |
1746
+ | ---- | ---- | ----------- | ----- |
1747
+ | **ipblock_id** | **String** | The unique ID of the Ip Block | |
1748
+ | **key** | **String** | The key of the Label | |
1749
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
1750
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1751
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1752
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1753
+
1754
+ ### Return type
1755
+
1756
+ [**LabelResource**](LabelResource.md)
1757
+
1758
+ ### Authorization
1759
+
1760
+ Basic Authentication, Token Authentication
1761
+
1762
+ ### HTTP request headers
1763
+
1764
+ - **Content-Type**: application/json
1765
+ - **Accept**: application/json
1766
+
1767
+
1768
+ ## labels_find_by_urn
1769
+
1770
+ > <Label> labels_find_by_urn(labelurn, opts)
1771
+
1772
+ Returns the label by its URN.
1773
+
1774
+ You can retrieve the details of a specific label using its URN. A URN is for uniqueness of a Label and composed using urn:label:<resource_type>:<resource_uuid>:<key>
1775
+
1776
+ ### Examples
1777
+
1778
+ ```ruby
1779
+ require 'time'
1780
+ require 'ionoscloud'
1781
+ # setup authorization
1782
+ Ionoscloud.configure do |config|
1783
+ # Configure HTTP basic authorization: Basic Authentication
1784
+ config.username = 'YOUR USERNAME'
1785
+ config.password = 'YOUR PASSWORD'
1786
+
1787
+ # Configure API key authorization: Token Authentication
1788
+ config.api_key['Authorization'] = 'YOUR API KEY'
1789
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1790
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1791
+ end
1792
+
1793
+ api_instance = Ionoscloud::LabelApi.new
1794
+ 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>
1795
+ opts = {
1796
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1797
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1798
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1799
+ }
1800
+
1801
+ begin
1802
+ # Returns the label by its URN.
1803
+ result = api_instance.labels_find_by_urn(labelurn, opts)
1804
+ p result
1805
+ rescue Ionoscloud::ApiError => e
1806
+ puts "Error when calling LabelApi->labels_find_by_urn: #{e}"
1807
+ end
1808
+ ```
1809
+
1810
+ #### Using the labels_find_by_urn_with_http_info variant
1811
+
1812
+ This returns an Array which contains the response data, status code and headers.
1813
+
1814
+ > <Array(<Label>, Integer, Hash)> labels_find_by_urn_with_http_info(labelurn, opts)
1815
+
1816
+ ```ruby
1817
+ begin
1818
+ # Returns the label by its URN.
1819
+ data, status_code, headers = api_instance.labels_find_by_urn_with_http_info(labelurn, opts)
1820
+ p status_code # => 2xx
1821
+ p headers # => { ... }
1822
+ p data # => <Label>
1823
+ rescue Ionoscloud::ApiError => e
1824
+ puts "Error when calling LabelApi->labels_find_by_urn_with_http_info: #{e}"
1825
+ end
1826
+ ```
1827
+
1828
+ ### Parameters
1829
+
1830
+ | Name | Type | Description | Notes |
1831
+ | ---- | ---- | ----------- | ----- |
1832
+ | **labelurn** | **String** | The URN representing the unique ID of the label. A URN is for uniqueness of a Label and composed using urn:label:&lt;resource_type&gt;:&lt;resource_uuid&gt;:&lt;key&gt; | |
1833
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1834
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1835
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1836
+
1837
+ ### Return type
1838
+
1839
+ [**Label**](Label.md)
1840
+
1841
+ ### Authorization
1842
+
1843
+ Basic Authentication, Token Authentication
1844
+
1845
+ ### HTTP request headers
1846
+
1847
+ - **Content-Type**: Not defined
1848
+ - **Accept**: application/json
1849
+
1850
+
1851
+ ## labels_get
1852
+
1853
+ > <Labels> labels_get(opts)
1854
+
1855
+ List Labels
1856
+
1857
+ You can retrieve a complete list of labels that you have access to.
1858
+
1859
+ ### Examples
1860
+
1861
+ ```ruby
1862
+ require 'time'
1863
+ require 'ionoscloud'
1864
+ # setup authorization
1865
+ Ionoscloud.configure do |config|
1866
+ # Configure HTTP basic authorization: Basic Authentication
1867
+ config.username = 'YOUR USERNAME'
1868
+ config.password = 'YOUR PASSWORD'
1869
+
1870
+ # Configure API key authorization: Token Authentication
1871
+ config.api_key['Authorization'] = 'YOUR API KEY'
1872
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1873
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1874
+ end
1875
+
1876
+ api_instance = Ionoscloud::LabelApi.new
1877
+ opts = {
1878
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1879
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1880
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1881
+ }
1882
+
1883
+ begin
1884
+ # List Labels
1885
+ result = api_instance.labels_get(opts)
1886
+ p result
1887
+ rescue Ionoscloud::ApiError => e
1888
+ puts "Error when calling LabelApi->labels_get: #{e}"
1889
+ end
1890
+ ```
1891
+
1892
+ #### Using the labels_get_with_http_info variant
1893
+
1894
+ This returns an Array which contains the response data, status code and headers.
1895
+
1896
+ > <Array(<Labels>, Integer, Hash)> labels_get_with_http_info(opts)
1897
+
1898
+ ```ruby
1899
+ begin
1900
+ # List Labels
1901
+ data, status_code, headers = api_instance.labels_get_with_http_info(opts)
1902
+ p status_code # => 2xx
1903
+ p headers # => { ... }
1904
+ p data # => <Labels>
1905
+ rescue Ionoscloud::ApiError => e
1906
+ puts "Error when calling LabelApi->labels_get_with_http_info: #{e}"
1907
+ end
1908
+ ```
1909
+
1910
+ ### Parameters
1911
+
1912
+ | Name | Type | Description | Notes |
1913
+ | ---- | ---- | ----------- | ----- |
1914
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
1915
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
1916
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
1917
+
1918
+ ### Return type
1919
+
1920
+ [**Labels**](Labels.md)
1921
+
1922
+ ### Authorization
1923
+
1924
+ Basic Authentication, Token Authentication
1925
+
1926
+ ### HTTP request headers
1927
+
1928
+ - **Content-Type**: Not defined
1929
+ - **Accept**: application/json
1930
+
1931
+
1932
+ ## snapshots_labels_delete
1933
+
1934
+ > Object snapshots_labels_delete(snapshot_id, key, opts)
1935
+
1936
+ Delete a Label from Snapshot
1937
+
1938
+ This will remove a label from the snapshot.
1939
+
1940
+ ### Examples
1941
+
1942
+ ```ruby
1943
+ require 'time'
1944
+ require 'ionoscloud'
1945
+ # setup authorization
1946
+ Ionoscloud.configure do |config|
1947
+ # Configure HTTP basic authorization: Basic Authentication
1948
+ config.username = 'YOUR USERNAME'
1949
+ config.password = 'YOUR PASSWORD'
1950
+
1951
+ # Configure API key authorization: Token Authentication
1952
+ config.api_key['Authorization'] = 'YOUR API KEY'
1953
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1954
+ # config.api_key_prefix['Authorization'] = 'Bearer'
1955
+ end
1956
+
1957
+ api_instance = Ionoscloud::LabelApi.new
1958
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
1959
+ key = 'key_example' # String | The key of the Label
1960
+ opts = {
1961
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
1962
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
1963
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
1964
+ }
1965
+
1966
+ begin
1967
+ # Delete a Label from Snapshot
1968
+ result = api_instance.snapshots_labels_delete(snapshot_id, key, opts)
1969
+ p result
1970
+ rescue Ionoscloud::ApiError => e
1971
+ puts "Error when calling LabelApi->snapshots_labels_delete: #{e}"
1972
+ end
1973
+ ```
1974
+
1975
+ #### Using the snapshots_labels_delete_with_http_info variant
1976
+
1977
+ This returns an Array which contains the response data, status code and headers.
1978
+
1979
+ > <Array(Object, Integer, Hash)> snapshots_labels_delete_with_http_info(snapshot_id, key, opts)
1980
+
1981
+ ```ruby
1982
+ begin
1983
+ # Delete a Label from Snapshot
1984
+ data, status_code, headers = api_instance.snapshots_labels_delete_with_http_info(snapshot_id, key, opts)
1985
+ p status_code # => 2xx
1986
+ p headers # => { ... }
1987
+ p data # => Object
1988
+ rescue Ionoscloud::ApiError => e
1989
+ puts "Error when calling LabelApi->snapshots_labels_delete_with_http_info: #{e}"
1990
+ end
1991
+ ```
1992
+
1993
+ ### Parameters
1994
+
1995
+ | Name | Type | Description | Notes |
1996
+ | ---- | ---- | ----------- | ----- |
1997
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
1998
+ | **key** | **String** | The key of the Label | |
1999
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2000
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2001
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2002
+
2003
+ ### Return type
2004
+
2005
+ **Object**
2006
+
2007
+ ### Authorization
2008
+
2009
+ Basic Authentication, Token Authentication
2010
+
2011
+ ### HTTP request headers
2012
+
2013
+ - **Content-Type**: Not defined
2014
+ - **Accept**: application/json
2015
+
2016
+
2017
+ ## snapshots_labels_find_by_key
2018
+
2019
+ > <LabelResource> snapshots_labels_find_by_key(snapshot_id, key, opts)
2020
+
2021
+ Retrieve a Label of Snapshot
2022
+
2023
+ This will retrieve the properties of a associated label to a snapshot.
2024
+
2025
+ ### Examples
2026
+
2027
+ ```ruby
2028
+ require 'time'
2029
+ require 'ionoscloud'
2030
+ # setup authorization
2031
+ Ionoscloud.configure do |config|
2032
+ # Configure HTTP basic authorization: Basic Authentication
2033
+ config.username = 'YOUR USERNAME'
2034
+ config.password = 'YOUR PASSWORD'
2035
+
2036
+ # Configure API key authorization: Token Authentication
2037
+ config.api_key['Authorization'] = 'YOUR API KEY'
2038
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2039
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2040
+ end
2041
+
2042
+ api_instance = Ionoscloud::LabelApi.new
2043
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
2044
+ key = 'key_example' # String | The key of the Label
2045
+ opts = {
2046
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2047
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2048
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2049
+ }
2050
+
2051
+ begin
2052
+ # Retrieve a Label of Snapshot
2053
+ result = api_instance.snapshots_labels_find_by_key(snapshot_id, key, opts)
2054
+ p result
2055
+ rescue Ionoscloud::ApiError => e
2056
+ puts "Error when calling LabelApi->snapshots_labels_find_by_key: #{e}"
2057
+ end
2058
+ ```
2059
+
2060
+ #### Using the snapshots_labels_find_by_key_with_http_info variant
2061
+
2062
+ This returns an Array which contains the response data, status code and headers.
2063
+
2064
+ > <Array(<LabelResource>, Integer, Hash)> snapshots_labels_find_by_key_with_http_info(snapshot_id, key, opts)
2065
+
2066
+ ```ruby
2067
+ begin
2068
+ # Retrieve a Label of Snapshot
2069
+ data, status_code, headers = api_instance.snapshots_labels_find_by_key_with_http_info(snapshot_id, key, opts)
2070
+ p status_code # => 2xx
2071
+ p headers # => { ... }
2072
+ p data # => <LabelResource>
2073
+ rescue Ionoscloud::ApiError => e
2074
+ puts "Error when calling LabelApi->snapshots_labels_find_by_key_with_http_info: #{e}"
2075
+ end
2076
+ ```
2077
+
2078
+ ### Parameters
2079
+
2080
+ | Name | Type | Description | Notes |
2081
+ | ---- | ---- | ----------- | ----- |
2082
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
2083
+ | **key** | **String** | The key of the Label | |
2084
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2085
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2086
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2087
+
2088
+ ### Return type
2089
+
2090
+ [**LabelResource**](LabelResource.md)
2091
+
2092
+ ### Authorization
2093
+
2094
+ Basic Authentication, Token Authentication
2095
+
2096
+ ### HTTP request headers
2097
+
2098
+ - **Content-Type**: Not defined
2099
+ - **Accept**: application/json
2100
+
2101
+
2102
+ ## snapshots_labels_get
2103
+
2104
+ > <LabelResources> snapshots_labels_get(snapshot_id, opts)
2105
+
2106
+ List all Snapshot Labels
2107
+
2108
+ You can retrieve a list of all labels associated with a snapshot
2109
+
2110
+ ### Examples
2111
+
2112
+ ```ruby
2113
+ require 'time'
2114
+ require 'ionoscloud'
2115
+ # setup authorization
2116
+ Ionoscloud.configure do |config|
2117
+ # Configure HTTP basic authorization: Basic Authentication
2118
+ config.username = 'YOUR USERNAME'
2119
+ config.password = 'YOUR PASSWORD'
2120
+
2121
+ # Configure API key authorization: Token Authentication
2122
+ config.api_key['Authorization'] = 'YOUR API KEY'
2123
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2124
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2125
+ end
2126
+
2127
+ api_instance = Ionoscloud::LabelApi.new
2128
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
2129
+ opts = {
2130
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2131
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2132
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2133
+ }
2134
+
2135
+ begin
2136
+ # List all Snapshot Labels
2137
+ result = api_instance.snapshots_labels_get(snapshot_id, opts)
2138
+ p result
2139
+ rescue Ionoscloud::ApiError => e
2140
+ puts "Error when calling LabelApi->snapshots_labels_get: #{e}"
2141
+ end
2142
+ ```
2143
+
2144
+ #### Using the snapshots_labels_get_with_http_info variant
2145
+
2146
+ This returns an Array which contains the response data, status code and headers.
2147
+
2148
+ > <Array(<LabelResources>, Integer, Hash)> snapshots_labels_get_with_http_info(snapshot_id, opts)
2149
+
2150
+ ```ruby
2151
+ begin
2152
+ # List all Snapshot Labels
2153
+ data, status_code, headers = api_instance.snapshots_labels_get_with_http_info(snapshot_id, opts)
2154
+ p status_code # => 2xx
2155
+ p headers # => { ... }
2156
+ p data # => <LabelResources>
2157
+ rescue Ionoscloud::ApiError => e
2158
+ puts "Error when calling LabelApi->snapshots_labels_get_with_http_info: #{e}"
2159
+ end
2160
+ ```
2161
+
2162
+ ### Parameters
2163
+
2164
+ | Name | Type | Description | Notes |
2165
+ | ---- | ---- | ----------- | ----- |
2166
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
2167
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2168
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2169
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2170
+
2171
+ ### Return type
2172
+
2173
+ [**LabelResources**](LabelResources.md)
2174
+
2175
+ ### Authorization
2176
+
2177
+ Basic Authentication, Token Authentication
2178
+
2179
+ ### HTTP request headers
2180
+
2181
+ - **Content-Type**: Not defined
2182
+ - **Accept**: application/json
2183
+
2184
+
2185
+ ## snapshots_labels_post
2186
+
2187
+ > <LabelResource> snapshots_labels_post(snapshot_id, label, opts)
2188
+
2189
+ Add a Label to Snapshot
2190
+
2191
+ This will add a label to the snapshot.
2192
+
2193
+ ### Examples
2194
+
2195
+ ```ruby
2196
+ require 'time'
2197
+ require 'ionoscloud'
2198
+ # setup authorization
2199
+ Ionoscloud.configure do |config|
2200
+ # Configure HTTP basic authorization: Basic Authentication
2201
+ config.username = 'YOUR USERNAME'
2202
+ config.password = 'YOUR PASSWORD'
2203
+
2204
+ # Configure API key authorization: Token Authentication
2205
+ config.api_key['Authorization'] = 'YOUR API KEY'
2206
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2207
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2208
+ end
2209
+
2210
+ api_instance = Ionoscloud::LabelApi.new
2211
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
2212
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Label to be added
2213
+ opts = {
2214
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2215
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2216
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2217
+ }
2218
+
2219
+ begin
2220
+ # Add a Label to Snapshot
2221
+ result = api_instance.snapshots_labels_post(snapshot_id, label, opts)
2222
+ p result
2223
+ rescue Ionoscloud::ApiError => e
2224
+ puts "Error when calling LabelApi->snapshots_labels_post: #{e}"
2225
+ end
2226
+ ```
2227
+
2228
+ #### Using the snapshots_labels_post_with_http_info variant
2229
+
2230
+ This returns an Array which contains the response data, status code and headers.
2231
+
2232
+ > <Array(<LabelResource>, Integer, Hash)> snapshots_labels_post_with_http_info(snapshot_id, label, opts)
2233
+
2234
+ ```ruby
2235
+ begin
2236
+ # Add a Label to Snapshot
2237
+ data, status_code, headers = api_instance.snapshots_labels_post_with_http_info(snapshot_id, label, opts)
2238
+ p status_code # => 2xx
2239
+ p headers # => { ... }
2240
+ p data # => <LabelResource>
2241
+ rescue Ionoscloud::ApiError => e
2242
+ puts "Error when calling LabelApi->snapshots_labels_post_with_http_info: #{e}"
2243
+ end
2244
+ ```
2245
+
2246
+ ### Parameters
2247
+
2248
+ | Name | Type | Description | Notes |
2249
+ | ---- | ---- | ----------- | ----- |
2250
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
2251
+ | **label** | [**LabelResource**](LabelResource.md) | Label to be added | |
2252
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2253
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2254
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2255
+
2256
+ ### Return type
2257
+
2258
+ [**LabelResource**](LabelResource.md)
2259
+
2260
+ ### Authorization
2261
+
2262
+ Basic Authentication, Token Authentication
2263
+
2264
+ ### HTTP request headers
2265
+
2266
+ - **Content-Type**: application/json
2267
+ - **Accept**: application/json
2268
+
2269
+
2270
+ ## snapshots_labels_put
2271
+
2272
+ > <LabelResource> snapshots_labels_put(snapshot_id, key, label, opts)
2273
+
2274
+ Modify a Label of Snapshot
2275
+
2276
+ This will modify the value of the label on a snapshot.
2277
+
2278
+ ### Examples
2279
+
2280
+ ```ruby
2281
+ require 'time'
2282
+ require 'ionoscloud'
2283
+ # setup authorization
2284
+ Ionoscloud.configure do |config|
2285
+ # Configure HTTP basic authorization: Basic Authentication
2286
+ config.username = 'YOUR USERNAME'
2287
+ config.password = 'YOUR PASSWORD'
2288
+
2289
+ # Configure API key authorization: Token Authentication
2290
+ config.api_key['Authorization'] = 'YOUR API KEY'
2291
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2292
+ # config.api_key_prefix['Authorization'] = 'Bearer'
2293
+ end
2294
+
2295
+ api_instance = Ionoscloud::LabelApi.new
2296
+ snapshot_id = 'snapshot_id_example' # String | The unique ID of the Snapshot
2297
+ key = 'key_example' # String | The key of the Label
2298
+ label = Ionoscloud::LabelResource.new({properties: Ionoscloud::LabelResourceProperties.new}) # LabelResource | Modified Label
2299
+ opts = {
2300
+ pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
2301
+ depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
2302
+ x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
2303
+ }
2304
+
2305
+ begin
2306
+ # Modify a Label of Snapshot
2307
+ result = api_instance.snapshots_labels_put(snapshot_id, key, label, opts)
2308
+ p result
2309
+ rescue Ionoscloud::ApiError => e
2310
+ puts "Error when calling LabelApi->snapshots_labels_put: #{e}"
2311
+ end
2312
+ ```
2313
+
2314
+ #### Using the snapshots_labels_put_with_http_info variant
2315
+
2316
+ This returns an Array which contains the response data, status code and headers.
2317
+
2318
+ > <Array(<LabelResource>, Integer, Hash)> snapshots_labels_put_with_http_info(snapshot_id, key, label, opts)
2319
+
2320
+ ```ruby
2321
+ begin
2322
+ # Modify a Label of Snapshot
2323
+ data, status_code, headers = api_instance.snapshots_labels_put_with_http_info(snapshot_id, key, label, opts)
2324
+ p status_code # => 2xx
2325
+ p headers # => { ... }
2326
+ p data # => <LabelResource>
2327
+ rescue Ionoscloud::ApiError => e
2328
+ puts "Error when calling LabelApi->snapshots_labels_put_with_http_info: #{e}"
2329
+ end
2330
+ ```
2331
+
2332
+ ### Parameters
2333
+
2334
+ | Name | Type | Description | Notes |
2335
+ | ---- | ---- | ----------- | ----- |
2336
+ | **snapshot_id** | **String** | The unique ID of the Snapshot | |
2337
+ | **key** | **String** | The key of the Label | |
2338
+ | **label** | [**LabelResource**](LabelResource.md) | Modified Label | |
2339
+ | **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
2340
+ | **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth&#x3D;0: only direct properties are included. Children (servers etc.) are not included - depth&#x3D;1: direct properties and children references are included - depth&#x3D;2: direct properties and children properties are included - depth&#x3D;3: direct properties and children properties and children&#39;s children are included - depth&#x3D;... and so on | [optional][default to 0] |
2341
+ | **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
2342
+
2343
+ ### Return type
2344
+
2345
+ [**LabelResource**](LabelResource.md)
2346
+
2347
+ ### Authorization
2348
+
2349
+ Basic Authentication, Token Authentication
2350
+
2351
+ ### HTTP request headers
2352
+
2353
+ - **Content-Type**: application/json
2354
+ - **Accept**: application/json
2355
+