ionoscloud 5.0.0 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/AttachedVolumes.md +30 -0
- data/docs/BackupUnit.md +26 -0
- data/docs/BackupUnitApi.md +595 -0
- data/docs/BackupUnitProperties.md +22 -0
- data/docs/BackupUnitSSO.md +18 -0
- data/docs/BackupUnits.md +24 -0
- data/docs/BalancedNics.md +30 -0
- data/docs/CHANGELOG.md +1 -0
- data/docs/Cdroms.md +30 -0
- data/docs/ConnectableDatacenter.md +22 -0
- data/docs/Contract.md +20 -0
- data/docs/ContractApi.md +89 -0
- data/docs/ContractProperties.md +26 -0
- data/docs/DataCenterApi.md +517 -0
- data/docs/DataCenterEntities.md +24 -0
- data/docs/Datacenter.md +28 -0
- data/docs/DatacenterElementMetadata.md +32 -0
- data/docs/DatacenterProperties.md +28 -0
- data/docs/Datacenters.md +30 -0
- data/docs/DefaultApi.md +84 -0
- data/docs/Error.md +20 -0
- data/docs/ErrorMessage.md +20 -0
- data/docs/FirewallRule.md +26 -0
- data/docs/FirewallRules.md +30 -0
- data/docs/FirewallruleProperties.md +34 -0
- data/docs/Group.md +26 -0
- data/docs/GroupEntities.md +20 -0
- data/docs/GroupMembers.md +24 -0
- data/docs/GroupProperties.md +36 -0
- data/docs/GroupShare.md +24 -0
- data/docs/GroupShareProperties.md +20 -0
- data/docs/GroupShares.md +24 -0
- data/docs/GroupUsers.md +24 -0
- data/docs/Groups.md +24 -0
- data/docs/IPBlocksApi.md +513 -0
- data/docs/IPFailover.md +20 -0
- data/docs/Image.md +26 -0
- data/docs/ImageApi.md +429 -0
- data/docs/ImageProperties.md +50 -0
- data/docs/Images.md +24 -0
- data/docs/Info.md +22 -0
- data/docs/IpBlock.md +26 -0
- data/docs/IpBlockProperties.md +26 -0
- data/docs/IpBlocks.md +24 -0
- data/docs/IpConsumer.md +30 -0
- data/docs/KubernetesApi.md +1513 -0
- data/docs/KubernetesAutoScaling.md +20 -0
- data/docs/KubernetesCluster.md +28 -0
- data/docs/KubernetesClusterEntities.md +18 -0
- data/docs/KubernetesClusterProperties.md +26 -0
- data/docs/KubernetesClusterPropertiesForPostAndPut.md +22 -0
- data/docs/KubernetesClusters.md +24 -0
- data/docs/KubernetesConfig.md +24 -0
- data/docs/KubernetesConfigProperties.md +18 -0
- data/docs/KubernetesMaintenanceWindow.md +20 -0
- data/docs/KubernetesNode.md +26 -0
- data/docs/KubernetesNodeMetadata.md +26 -0
- data/docs/KubernetesNodePool.md +26 -0
- data/docs/KubernetesNodePoolForPut.md +26 -0
- data/docs/KubernetesNodePoolLan.md +18 -0
- data/docs/KubernetesNodePoolProperties.md +50 -0
- data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
- data/docs/KubernetesNodePoolPropertiesForPut.md +48 -0
- data/docs/KubernetesNodePools.md +24 -0
- data/docs/KubernetesNodeProperties.md +22 -0
- data/docs/KubernetesNodes.md +24 -0
- data/docs/Label.md +26 -0
- data/docs/LabelApi.md +2355 -0
- data/docs/LabelProperties.md +26 -0
- data/docs/LabelResource.md +26 -0
- data/docs/LabelResourceProperties.md +20 -0
- data/docs/LabelResources.md +30 -0
- data/docs/Labels.md +24 -0
- data/docs/Lan.md +28 -0
- data/docs/LanApi.md +795 -0
- data/docs/LanEntities.md +18 -0
- data/docs/LanNics.md +30 -0
- data/docs/LanPost.md +28 -0
- data/docs/LanProperties.md +24 -0
- data/docs/LanPropertiesPost.md +24 -0
- data/docs/Lans.md +30 -0
- data/docs/LoadBalancerApi.md +883 -0
- data/docs/Loadbalancer.md +28 -0
- data/docs/LoadbalancerEntities.md +18 -0
- data/docs/LoadbalancerProperties.md +22 -0
- data/docs/Loadbalancers.md +30 -0
- data/docs/Location.md +26 -0
- data/docs/LocationApi.md +259 -0
- data/docs/LocationProperties.md +22 -0
- data/docs/Locations.md +24 -0
- data/docs/Nic.md +28 -0
- data/docs/NicApi.md +1087 -0
- data/docs/NicEntities.md +18 -0
- data/docs/NicProperties.md +30 -0
- data/docs/Nics.md +30 -0
- data/docs/NoStateMetaData.md +30 -0
- data/docs/PaginationLinks.md +22 -0
- data/docs/Peer.md +26 -0
- data/docs/PrivateCrossConnect.md +26 -0
- data/docs/PrivateCrossConnectApi.md +427 -0
- data/docs/PrivateCrossConnectProperties.md +24 -0
- data/docs/PrivateCrossConnects.md +24 -0
- data/docs/README.md +111 -0
- data/docs/Request.md +26 -0
- data/docs/RequestApi.md +267 -0
- data/docs/RequestMetadata.md +24 -0
- data/docs/RequestProperties.md +24 -0
- data/docs/RequestStatus.md +24 -0
- data/docs/RequestStatusMetadata.md +24 -0
- data/docs/RequestTarget.md +20 -0
- data/docs/Requests.md +30 -0
- data/docs/Resource.md +28 -0
- data/docs/ResourceEntities.md +18 -0
- data/docs/ResourceGroups.md +24 -0
- data/docs/ResourceLimits.md +50 -0
- data/docs/ResourceProperties.md +20 -0
- data/docs/ResourceReference.md +22 -0
- data/docs/Resources.md +24 -0
- data/docs/ResourcesUsers.md +24 -0
- data/docs/S3Key.md +26 -0
- data/docs/S3KeyMetadata.md +20 -0
- data/docs/S3KeyProperties.md +20 -0
- data/docs/S3Keys.md +24 -0
- data/docs/S3ObjectStorageSSO.md +18 -0
- data/docs/Server.md +28 -0
- data/docs/ServerApi.md +1573 -0
- data/docs/ServerEntities.md +22 -0
- data/docs/ServerProperties.md +32 -0
- data/docs/Servers.md +30 -0
- data/docs/Snapshot.md +26 -0
- data/docs/SnapshotApi.md +429 -0
- data/docs/SnapshotProperties.md +48 -0
- data/docs/Snapshots.md +24 -0
- data/docs/Type.md +15 -0
- data/docs/User.md +28 -0
- data/docs/UserManagementApi.md +2547 -0
- data/docs/UserMetadata.md +22 -0
- data/docs/UserProperties.md +34 -0
- data/docs/Users.md +24 -0
- data/docs/UsersEntities.md +20 -0
- data/docs/Volume.md +26 -0
- data/docs/VolumeApi.md +711 -0
- data/docs/VolumeProperties.md +54 -0
- data/docs/Volumes.md +30 -0
- data/docs/summary.md +295 -0
- data/gitbook.yaml +4 -0
- data/lib/ionoscloud/api/_api.rb +1 -1
- data/lib/ionoscloud/api_client.rb +1 -4
- data/lib/ionoscloud/models/backup_units.rb +2 -2
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +2 -2
- data/lib/ionoscloud/models/firewallrule_properties.rb +36 -21
- data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
- data/lib/ionoscloud/models/label_resources.rb +2 -2
- data/lib/ionoscloud/models/labels.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer_properties.rb +12 -29
- data/lib/ionoscloud/models/type.rb +1 -0
- data/lib/ionoscloud/models/volume_properties.rb +14 -4
- data/lib/ionoscloud/version.rb +1 -1
- data/spec/models/backup_units_spec.rb +1 -1
- data/spec/models/datacenter_element_metadata_spec.rb +1 -1
- data/spec/models/firewallrule_properties_spec.rb +0 -12
- data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
- data/spec/models/kubernetes_node_spec.rb +1 -1
- data/spec/models/kubernetes_nodes_spec.rb +1 -1
- data/spec/models/label_resources_spec.rb +1 -1
- data/spec/models/labels_spec.rb +1 -1
- data/spec/models/loadbalancer_properties_spec.rb +0 -4
- data/spec/models/volume_properties_spec.rb +6 -0
- metadata +264 -120
- data/DOCS.md +0 -14618
- data/README.md +0 -55
@@ -0,0 +1,22 @@
|
|
1
|
+
# BackupUnitProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource (only alphanumeric characters are acceptable) | |
|
8
|
+
| **password** | **String** | the password associated to that resource | [optional] |
|
9
|
+
| **email** | **String** | The email associated with the backup unit. Bear in mind that this email does not be the same email as of the user. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud'
|
15
|
+
|
16
|
+
instance = Ionoscloud::BackupUnitProperties.new(
|
17
|
+
name: BackupUnitName,
|
18
|
+
password: mypass123,
|
19
|
+
email: email@email.com
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# BackupUnitSSO
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sso_url** | **String** | The backup unit single sign on url | [optional][readonly] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ionoscloud'
|
13
|
+
|
14
|
+
instance = Ionoscloud::BackupUnitSSO.new(
|
15
|
+
sso_url: https://<hostname>/?jwt=eyJ0eXAiO...W47AN5-_x7E
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/BackupUnits.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# BackupUnits
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [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
|
+
| **items** | [**Array<BackupUnit>**](BackupUnit.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::BackupUnits.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: collection,
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# BalancedNics
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<Nic>**](Nic.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
| **offset** | **Float** | the offset (if specified in the request) | [optional] |
|
12
|
+
| **limit** | **Float** | the limit (if specified in the request) | [optional] |
|
13
|
+
| **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud'
|
19
|
+
|
20
|
+
instance = Ionoscloud::BalancedNics.new(
|
21
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
22
|
+
type: "collection",
|
23
|
+
href: <RESOURCE-URI>,
|
24
|
+
items: null,
|
25
|
+
offset: 0,
|
26
|
+
limit: 1000,
|
27
|
+
_links: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
data/docs/CHANGELOG.md
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
# CHANGELOG
|
data/docs/Cdroms.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# Cdroms
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<Image>**](Image.md) | Array of items in that collection | [optional] |
|
11
|
+
| **offset** | **Float** | the offset (if specified in the request) | [optional] |
|
12
|
+
| **limit** | **Float** | the limit (if specified in the request) | [optional] |
|
13
|
+
| **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud'
|
19
|
+
|
20
|
+
instance = Ionoscloud::Cdroms.new(
|
21
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
22
|
+
type: "collection",
|
23
|
+
href: <RESOURCE-URI>,
|
24
|
+
items: null,
|
25
|
+
offset: 0,
|
26
|
+
limit: 1000,
|
27
|
+
_links: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# ConnectableDatacenter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
| **location** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud'
|
15
|
+
|
16
|
+
instance = Ionoscloud::ConnectableDatacenter.new(
|
17
|
+
id: null,
|
18
|
+
name: null,
|
19
|
+
location: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Contract.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# Contract
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | [**Type**](Type.md) | The type of the resource | [optional] |
|
8
|
+
| **properties** | [**ContractProperties**](ContractProperties.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ionoscloud'
|
14
|
+
|
15
|
+
instance = Ionoscloud::Contract.new(
|
16
|
+
type: "resource",
|
17
|
+
properties: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/ContractApi.md
ADDED
@@ -0,0 +1,89 @@
|
|
1
|
+
# ContractApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**contracts_get**](ContractApi.md#contracts_get) | **GET** /contracts | Retrieve a Contract |
|
8
|
+
|
9
|
+
|
10
|
+
## contracts_get
|
11
|
+
|
12
|
+
> <Contract> contracts_get(opts)
|
13
|
+
|
14
|
+
Retrieve a Contract
|
15
|
+
|
16
|
+
Retrieves the attributes of user's contract.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'ionoscloud'
|
23
|
+
# setup authorization
|
24
|
+
Ionoscloud.configure do |config|
|
25
|
+
# Configure HTTP basic authorization: Basic Authentication
|
26
|
+
config.username = 'YOUR USERNAME'
|
27
|
+
config.password = 'YOUR PASSWORD'
|
28
|
+
|
29
|
+
# Configure API key authorization: Token Authentication
|
30
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = Ionoscloud::ContractApi.new
|
36
|
+
opts = {
|
37
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
38
|
+
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
|
39
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
40
|
+
}
|
41
|
+
|
42
|
+
begin
|
43
|
+
# Retrieve a Contract
|
44
|
+
result = api_instance.contracts_get(opts)
|
45
|
+
p result
|
46
|
+
rescue Ionoscloud::ApiError => e
|
47
|
+
puts "Error when calling ContractApi->contracts_get: #{e}"
|
48
|
+
end
|
49
|
+
```
|
50
|
+
|
51
|
+
#### Using the contracts_get_with_http_info variant
|
52
|
+
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
54
|
+
|
55
|
+
> <Array(<Contract>, Integer, Hash)> contracts_get_with_http_info(opts)
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
begin
|
59
|
+
# Retrieve a Contract
|
60
|
+
data, status_code, headers = api_instance.contracts_get_with_http_info(opts)
|
61
|
+
p status_code # => 2xx
|
62
|
+
p headers # => { ... }
|
63
|
+
p data # => <Contract>
|
64
|
+
rescue Ionoscloud::ApiError => e
|
65
|
+
puts "Error when calling ContractApi->contracts_get_with_http_info: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
| Name | Type | Description | Notes |
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
73
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
74
|
+
| **depth** | **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 | [optional][default to 0] |
|
75
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
76
|
+
|
77
|
+
### Return type
|
78
|
+
|
79
|
+
[**Contract**](Contract.md)
|
80
|
+
|
81
|
+
### Authorization
|
82
|
+
|
83
|
+
Basic Authentication, Token Authentication
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: Not defined
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# ContractProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **contract_number** | **Integer** | contract number | [optional][readonly] |
|
8
|
+
| **owner** | **String** | owner of the contract | [optional][readonly] |
|
9
|
+
| **status** | **String** | status of the contract | [optional][readonly] |
|
10
|
+
| **reg_domain** | **String** | Registration domain of the contract | [optional][readonly] |
|
11
|
+
| **resource_limits** | [**ResourceLimits**](ResourceLimits.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::ContractProperties.new(
|
19
|
+
contract_number: null,
|
20
|
+
owner: null,
|
21
|
+
status: null,
|
22
|
+
reg_domain: null,
|
23
|
+
resource_limits: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,517 @@
|
|
1
|
+
# DataCenterApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**datacenters_delete**](DataCenterApi.md#datacenters_delete) | **DELETE** /datacenters/{datacenterId} | Delete a Data Center |
|
8
|
+
| [**datacenters_find_by_id**](DataCenterApi.md#datacenters_find_by_id) | **GET** /datacenters/{datacenterId} | Retrieve a Data Center |
|
9
|
+
| [**datacenters_get**](DataCenterApi.md#datacenters_get) | **GET** /datacenters | List Data Centers under your account |
|
10
|
+
| [**datacenters_patch**](DataCenterApi.md#datacenters_patch) | **PATCH** /datacenters/{datacenterId} | Partially modify a Data Center |
|
11
|
+
| [**datacenters_post**](DataCenterApi.md#datacenters_post) | **POST** /datacenters | Create a Data Center |
|
12
|
+
| [**datacenters_put**](DataCenterApi.md#datacenters_put) | **PUT** /datacenters/{datacenterId} | Modify a Data Center |
|
13
|
+
|
14
|
+
|
15
|
+
## datacenters_delete
|
16
|
+
|
17
|
+
> Object datacenters_delete(datacenter_id, opts)
|
18
|
+
|
19
|
+
Delete a Data Center
|
20
|
+
|
21
|
+
Will remove all objects within the datacenter and remove the datacenter object itself, too. This is a highly destructive method which should be used with caution
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'ionoscloud'
|
28
|
+
# setup authorization
|
29
|
+
Ionoscloud.configure do |config|
|
30
|
+
# Configure HTTP basic authorization: Basic Authentication
|
31
|
+
config.username = 'YOUR USERNAME'
|
32
|
+
config.password = 'YOUR PASSWORD'
|
33
|
+
|
34
|
+
# Configure API key authorization: Token Authentication
|
35
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
38
|
+
end
|
39
|
+
|
40
|
+
api_instance = Ionoscloud::DataCenterApi.new
|
41
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
42
|
+
opts = {
|
43
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
44
|
+
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
|
45
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
46
|
+
}
|
47
|
+
|
48
|
+
begin
|
49
|
+
# Delete a Data Center
|
50
|
+
result = api_instance.datacenters_delete(datacenter_id, opts)
|
51
|
+
p result
|
52
|
+
rescue Ionoscloud::ApiError => e
|
53
|
+
puts "Error when calling DataCenterApi->datacenters_delete: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
#### Using the datacenters_delete_with_http_info variant
|
58
|
+
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
60
|
+
|
61
|
+
> <Array(Object, Integer, Hash)> datacenters_delete_with_http_info(datacenter_id, opts)
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
begin
|
65
|
+
# Delete a Data Center
|
66
|
+
data, status_code, headers = api_instance.datacenters_delete_with_http_info(datacenter_id, opts)
|
67
|
+
p status_code # => 2xx
|
68
|
+
p headers # => { ... }
|
69
|
+
p data # => Object
|
70
|
+
rescue Ionoscloud::ApiError => e
|
71
|
+
puts "Error when calling DataCenterApi->datacenters_delete_with_http_info: #{e}"
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
### Parameters
|
76
|
+
|
77
|
+
| Name | Type | Description | Notes |
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
79
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
80
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
81
|
+
| **depth** | **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 | [optional][default to 0] |
|
82
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
83
|
+
|
84
|
+
### Return type
|
85
|
+
|
86
|
+
**Object**
|
87
|
+
|
88
|
+
### Authorization
|
89
|
+
|
90
|
+
Basic Authentication, Token Authentication
|
91
|
+
|
92
|
+
### HTTP request headers
|
93
|
+
|
94
|
+
- **Content-Type**: Not defined
|
95
|
+
- **Accept**: application/json
|
96
|
+
|
97
|
+
|
98
|
+
## datacenters_find_by_id
|
99
|
+
|
100
|
+
> <Datacenter> datacenters_find_by_id(datacenter_id, opts)
|
101
|
+
|
102
|
+
Retrieve a Data Center
|
103
|
+
|
104
|
+
You can retrieve a data center by using the resource's ID. This value can be found in the response body when a datacenter is created or when you GET a list of datacenters.
|
105
|
+
|
106
|
+
### Examples
|
107
|
+
|
108
|
+
```ruby
|
109
|
+
require 'time'
|
110
|
+
require 'ionoscloud'
|
111
|
+
# setup authorization
|
112
|
+
Ionoscloud.configure do |config|
|
113
|
+
# Configure HTTP basic authorization: Basic Authentication
|
114
|
+
config.username = 'YOUR USERNAME'
|
115
|
+
config.password = 'YOUR PASSWORD'
|
116
|
+
|
117
|
+
# Configure API key authorization: Token Authentication
|
118
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
119
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
120
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
121
|
+
end
|
122
|
+
|
123
|
+
api_instance = Ionoscloud::DataCenterApi.new
|
124
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
125
|
+
opts = {
|
126
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
127
|
+
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
|
128
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
129
|
+
}
|
130
|
+
|
131
|
+
begin
|
132
|
+
# Retrieve a Data Center
|
133
|
+
result = api_instance.datacenters_find_by_id(datacenter_id, opts)
|
134
|
+
p result
|
135
|
+
rescue Ionoscloud::ApiError => e
|
136
|
+
puts "Error when calling DataCenterApi->datacenters_find_by_id: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
#### Using the datacenters_find_by_id_with_http_info variant
|
141
|
+
|
142
|
+
This returns an Array which contains the response data, status code and headers.
|
143
|
+
|
144
|
+
> <Array(<Datacenter>, Integer, Hash)> datacenters_find_by_id_with_http_info(datacenter_id, opts)
|
145
|
+
|
146
|
+
```ruby
|
147
|
+
begin
|
148
|
+
# Retrieve a Data Center
|
149
|
+
data, status_code, headers = api_instance.datacenters_find_by_id_with_http_info(datacenter_id, opts)
|
150
|
+
p status_code # => 2xx
|
151
|
+
p headers # => { ... }
|
152
|
+
p data # => <Datacenter>
|
153
|
+
rescue Ionoscloud::ApiError => e
|
154
|
+
puts "Error when calling DataCenterApi->datacenters_find_by_id_with_http_info: #{e}"
|
155
|
+
end
|
156
|
+
```
|
157
|
+
|
158
|
+
### Parameters
|
159
|
+
|
160
|
+
| Name | Type | Description | Notes |
|
161
|
+
| ---- | ---- | ----------- | ----- |
|
162
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
163
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
164
|
+
| **depth** | **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 | [optional][default to 0] |
|
165
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
166
|
+
|
167
|
+
### Return type
|
168
|
+
|
169
|
+
[**Datacenter**](Datacenter.md)
|
170
|
+
|
171
|
+
### Authorization
|
172
|
+
|
173
|
+
Basic Authentication, Token Authentication
|
174
|
+
|
175
|
+
### HTTP request headers
|
176
|
+
|
177
|
+
- **Content-Type**: Not defined
|
178
|
+
- **Accept**: application/json
|
179
|
+
|
180
|
+
|
181
|
+
## datacenters_get
|
182
|
+
|
183
|
+
> <Datacenters> datacenters_get(opts)
|
184
|
+
|
185
|
+
List Data Centers under your account
|
186
|
+
|
187
|
+
You can retrieve a complete list of data centers provisioned under your account
|
188
|
+
|
189
|
+
### Examples
|
190
|
+
|
191
|
+
```ruby
|
192
|
+
require 'time'
|
193
|
+
require 'ionoscloud'
|
194
|
+
# setup authorization
|
195
|
+
Ionoscloud.configure do |config|
|
196
|
+
# Configure HTTP basic authorization: Basic Authentication
|
197
|
+
config.username = 'YOUR USERNAME'
|
198
|
+
config.password = 'YOUR PASSWORD'
|
199
|
+
|
200
|
+
# Configure API key authorization: Token Authentication
|
201
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
202
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
203
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
204
|
+
end
|
205
|
+
|
206
|
+
api_instance = Ionoscloud::DataCenterApi.new
|
207
|
+
opts = {
|
208
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
209
|
+
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
|
210
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
211
|
+
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)
|
212
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
213
|
+
}
|
214
|
+
|
215
|
+
begin
|
216
|
+
# List Data Centers under your account
|
217
|
+
result = api_instance.datacenters_get(opts)
|
218
|
+
p result
|
219
|
+
rescue Ionoscloud::ApiError => e
|
220
|
+
puts "Error when calling DataCenterApi->datacenters_get: #{e}"
|
221
|
+
end
|
222
|
+
```
|
223
|
+
|
224
|
+
#### Using the datacenters_get_with_http_info variant
|
225
|
+
|
226
|
+
This returns an Array which contains the response data, status code and headers.
|
227
|
+
|
228
|
+
> <Array(<Datacenters>, Integer, Hash)> datacenters_get_with_http_info(opts)
|
229
|
+
|
230
|
+
```ruby
|
231
|
+
begin
|
232
|
+
# List Data Centers under your account
|
233
|
+
data, status_code, headers = api_instance.datacenters_get_with_http_info(opts)
|
234
|
+
p status_code # => 2xx
|
235
|
+
p headers # => { ... }
|
236
|
+
p data # => <Datacenters>
|
237
|
+
rescue Ionoscloud::ApiError => e
|
238
|
+
puts "Error when calling DataCenterApi->datacenters_get_with_http_info: #{e}"
|
239
|
+
end
|
240
|
+
```
|
241
|
+
|
242
|
+
### Parameters
|
243
|
+
|
244
|
+
| Name | Type | Description | Notes |
|
245
|
+
| ---- | ---- | ----------- | ----- |
|
246
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
247
|
+
| **depth** | **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 | [optional][default to 0] |
|
248
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
249
|
+
| **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) | [optional][default to 0] |
|
250
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
|
251
|
+
|
252
|
+
### Return type
|
253
|
+
|
254
|
+
[**Datacenters**](Datacenters.md)
|
255
|
+
|
256
|
+
### Authorization
|
257
|
+
|
258
|
+
Basic Authentication, Token Authentication
|
259
|
+
|
260
|
+
### HTTP request headers
|
261
|
+
|
262
|
+
- **Content-Type**: Not defined
|
263
|
+
- **Accept**: application/json
|
264
|
+
|
265
|
+
|
266
|
+
## datacenters_patch
|
267
|
+
|
268
|
+
> <Datacenter> datacenters_patch(datacenter_id, datacenter, opts)
|
269
|
+
|
270
|
+
Partially modify a Data Center
|
271
|
+
|
272
|
+
You can use update datacenter to re-name the datacenter or update its description
|
273
|
+
|
274
|
+
### Examples
|
275
|
+
|
276
|
+
```ruby
|
277
|
+
require 'time'
|
278
|
+
require 'ionoscloud'
|
279
|
+
# setup authorization
|
280
|
+
Ionoscloud.configure do |config|
|
281
|
+
# Configure HTTP basic authorization: Basic Authentication
|
282
|
+
config.username = 'YOUR USERNAME'
|
283
|
+
config.password = 'YOUR PASSWORD'
|
284
|
+
|
285
|
+
# Configure API key authorization: Token Authentication
|
286
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
287
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
288
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
289
|
+
end
|
290
|
+
|
291
|
+
api_instance = Ionoscloud::DataCenterApi.new
|
292
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
293
|
+
datacenter = Ionoscloud::DatacenterProperties.new({location: 'us/las'}) # DatacenterProperties | Modified properties of Data Center
|
294
|
+
opts = {
|
295
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
296
|
+
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
|
297
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
298
|
+
}
|
299
|
+
|
300
|
+
begin
|
301
|
+
# Partially modify a Data Center
|
302
|
+
result = api_instance.datacenters_patch(datacenter_id, datacenter, opts)
|
303
|
+
p result
|
304
|
+
rescue Ionoscloud::ApiError => e
|
305
|
+
puts "Error when calling DataCenterApi->datacenters_patch: #{e}"
|
306
|
+
end
|
307
|
+
```
|
308
|
+
|
309
|
+
#### Using the datacenters_patch_with_http_info variant
|
310
|
+
|
311
|
+
This returns an Array which contains the response data, status code and headers.
|
312
|
+
|
313
|
+
> <Array(<Datacenter>, Integer, Hash)> datacenters_patch_with_http_info(datacenter_id, datacenter, opts)
|
314
|
+
|
315
|
+
```ruby
|
316
|
+
begin
|
317
|
+
# Partially modify a Data Center
|
318
|
+
data, status_code, headers = api_instance.datacenters_patch_with_http_info(datacenter_id, datacenter, opts)
|
319
|
+
p status_code # => 2xx
|
320
|
+
p headers # => { ... }
|
321
|
+
p data # => <Datacenter>
|
322
|
+
rescue Ionoscloud::ApiError => e
|
323
|
+
puts "Error when calling DataCenterApi->datacenters_patch_with_http_info: #{e}"
|
324
|
+
end
|
325
|
+
```
|
326
|
+
|
327
|
+
### Parameters
|
328
|
+
|
329
|
+
| Name | Type | Description | Notes |
|
330
|
+
| ---- | ---- | ----------- | ----- |
|
331
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
332
|
+
| **datacenter** | [**DatacenterProperties**](DatacenterProperties.md) | Modified properties of Data Center | |
|
333
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
334
|
+
| **depth** | **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 | [optional][default to 0] |
|
335
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
336
|
+
|
337
|
+
### Return type
|
338
|
+
|
339
|
+
[**Datacenter**](Datacenter.md)
|
340
|
+
|
341
|
+
### Authorization
|
342
|
+
|
343
|
+
Basic Authentication, Token Authentication
|
344
|
+
|
345
|
+
### HTTP request headers
|
346
|
+
|
347
|
+
- **Content-Type**: application/json
|
348
|
+
- **Accept**: application/json
|
349
|
+
|
350
|
+
|
351
|
+
## datacenters_post
|
352
|
+
|
353
|
+
> <Datacenter> datacenters_post(datacenter, opts)
|
354
|
+
|
355
|
+
Create a Data Center
|
356
|
+
|
357
|
+
Virtual data centers are the foundation of the platform. They act as logical containers for all other objects you will be creating, e.g. servers. You can provision as many data centers as you want. Datacenters have their own private network and are logically segmented from each other to create isolation. You can use this POST method to create a simple datacenter or to create a datacenter with multiple objects under it such as servers and storage volumes.
|
358
|
+
|
359
|
+
### Examples
|
360
|
+
|
361
|
+
```ruby
|
362
|
+
require 'time'
|
363
|
+
require 'ionoscloud'
|
364
|
+
# setup authorization
|
365
|
+
Ionoscloud.configure do |config|
|
366
|
+
# Configure HTTP basic authorization: Basic Authentication
|
367
|
+
config.username = 'YOUR USERNAME'
|
368
|
+
config.password = 'YOUR PASSWORD'
|
369
|
+
|
370
|
+
# Configure API key authorization: Token Authentication
|
371
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
372
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
373
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
374
|
+
end
|
375
|
+
|
376
|
+
api_instance = Ionoscloud::DataCenterApi.new
|
377
|
+
datacenter = Ionoscloud::Datacenter.new({properties: Ionoscloud::DatacenterProperties.new({location: 'us/las'})}) # Datacenter | Datacenter to be created
|
378
|
+
opts = {
|
379
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
380
|
+
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
|
381
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
382
|
+
}
|
383
|
+
|
384
|
+
begin
|
385
|
+
# Create a Data Center
|
386
|
+
result = api_instance.datacenters_post(datacenter, opts)
|
387
|
+
p result
|
388
|
+
rescue Ionoscloud::ApiError => e
|
389
|
+
puts "Error when calling DataCenterApi->datacenters_post: #{e}"
|
390
|
+
end
|
391
|
+
```
|
392
|
+
|
393
|
+
#### Using the datacenters_post_with_http_info variant
|
394
|
+
|
395
|
+
This returns an Array which contains the response data, status code and headers.
|
396
|
+
|
397
|
+
> <Array(<Datacenter>, Integer, Hash)> datacenters_post_with_http_info(datacenter, opts)
|
398
|
+
|
399
|
+
```ruby
|
400
|
+
begin
|
401
|
+
# Create a Data Center
|
402
|
+
data, status_code, headers = api_instance.datacenters_post_with_http_info(datacenter, opts)
|
403
|
+
p status_code # => 2xx
|
404
|
+
p headers # => { ... }
|
405
|
+
p data # => <Datacenter>
|
406
|
+
rescue Ionoscloud::ApiError => e
|
407
|
+
puts "Error when calling DataCenterApi->datacenters_post_with_http_info: #{e}"
|
408
|
+
end
|
409
|
+
```
|
410
|
+
|
411
|
+
### Parameters
|
412
|
+
|
413
|
+
| Name | Type | Description | Notes |
|
414
|
+
| ---- | ---- | ----------- | ----- |
|
415
|
+
| **datacenter** | [**Datacenter**](Datacenter.md) | Datacenter to be created | |
|
416
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
417
|
+
| **depth** | **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 | [optional][default to 0] |
|
418
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
419
|
+
|
420
|
+
### Return type
|
421
|
+
|
422
|
+
[**Datacenter**](Datacenter.md)
|
423
|
+
|
424
|
+
### Authorization
|
425
|
+
|
426
|
+
Basic Authentication, Token Authentication
|
427
|
+
|
428
|
+
### HTTP request headers
|
429
|
+
|
430
|
+
- **Content-Type**: application/json
|
431
|
+
- **Accept**: application/json
|
432
|
+
|
433
|
+
|
434
|
+
## datacenters_put
|
435
|
+
|
436
|
+
> <Datacenter> datacenters_put(datacenter_id, datacenter, opts)
|
437
|
+
|
438
|
+
Modify a Data Center
|
439
|
+
|
440
|
+
You can use update datacenter to re-name the datacenter or update its description
|
441
|
+
|
442
|
+
### Examples
|
443
|
+
|
444
|
+
```ruby
|
445
|
+
require 'time'
|
446
|
+
require 'ionoscloud'
|
447
|
+
# setup authorization
|
448
|
+
Ionoscloud.configure do |config|
|
449
|
+
# Configure HTTP basic authorization: Basic Authentication
|
450
|
+
config.username = 'YOUR USERNAME'
|
451
|
+
config.password = 'YOUR PASSWORD'
|
452
|
+
|
453
|
+
# Configure API key authorization: Token Authentication
|
454
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
455
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
456
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
457
|
+
end
|
458
|
+
|
459
|
+
api_instance = Ionoscloud::DataCenterApi.new
|
460
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
461
|
+
datacenter = Ionoscloud::Datacenter.new({properties: Ionoscloud::DatacenterProperties.new({location: 'us/las'})}) # Datacenter | Modified Data Center
|
462
|
+
opts = {
|
463
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
464
|
+
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
|
465
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
466
|
+
}
|
467
|
+
|
468
|
+
begin
|
469
|
+
# Modify a Data Center
|
470
|
+
result = api_instance.datacenters_put(datacenter_id, datacenter, opts)
|
471
|
+
p result
|
472
|
+
rescue Ionoscloud::ApiError => e
|
473
|
+
puts "Error when calling DataCenterApi->datacenters_put: #{e}"
|
474
|
+
end
|
475
|
+
```
|
476
|
+
|
477
|
+
#### Using the datacenters_put_with_http_info variant
|
478
|
+
|
479
|
+
This returns an Array which contains the response data, status code and headers.
|
480
|
+
|
481
|
+
> <Array(<Datacenter>, Integer, Hash)> datacenters_put_with_http_info(datacenter_id, datacenter, opts)
|
482
|
+
|
483
|
+
```ruby
|
484
|
+
begin
|
485
|
+
# Modify a Data Center
|
486
|
+
data, status_code, headers = api_instance.datacenters_put_with_http_info(datacenter_id, datacenter, opts)
|
487
|
+
p status_code # => 2xx
|
488
|
+
p headers # => { ... }
|
489
|
+
p data # => <Datacenter>
|
490
|
+
rescue Ionoscloud::ApiError => e
|
491
|
+
puts "Error when calling DataCenterApi->datacenters_put_with_http_info: #{e}"
|
492
|
+
end
|
493
|
+
```
|
494
|
+
|
495
|
+
### Parameters
|
496
|
+
|
497
|
+
| Name | Type | Description | Notes |
|
498
|
+
| ---- | ---- | ----------- | ----- |
|
499
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
500
|
+
| **datacenter** | [**Datacenter**](Datacenter.md) | Modified Data Center | |
|
501
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
502
|
+
| **depth** | **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 | [optional][default to 0] |
|
503
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
504
|
+
|
505
|
+
### Return type
|
506
|
+
|
507
|
+
[**Datacenter**](Datacenter.md)
|
508
|
+
|
509
|
+
### Authorization
|
510
|
+
|
511
|
+
Basic Authentication, Token Authentication
|
512
|
+
|
513
|
+
### HTTP request headers
|
514
|
+
|
515
|
+
- **Content-Type**: application/json
|
516
|
+
- **Accept**: application/json
|
517
|
+
|