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,36 @@
|
|
1
|
+
# GroupProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource | [optional] |
|
8
|
+
| **create_data_center** | **Boolean** | create data center privilege | [optional] |
|
9
|
+
| **create_snapshot** | **Boolean** | create snapshot privilege | [optional] |
|
10
|
+
| **reserve_ip** | **Boolean** | reserve ip block privilege | [optional] |
|
11
|
+
| **access_activity_log** | **Boolean** | activity log access privilege | [optional] |
|
12
|
+
| **create_pcc** | **Boolean** | create pcc privilege | [optional] |
|
13
|
+
| **s3_privilege** | **Boolean** | S3 privilege | [optional] |
|
14
|
+
| **create_backup_unit** | **Boolean** | create backup unit privilege | [optional] |
|
15
|
+
| **create_internet_access** | **Boolean** | create internet access privilege | [optional] |
|
16
|
+
| **create_k8s_cluster** | **Boolean** | create kubernetes cluster privilege | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'ionoscloud'
|
22
|
+
|
23
|
+
instance = Ionoscloud::GroupProperties.new(
|
24
|
+
name: My resource,
|
25
|
+
create_data_center: null,
|
26
|
+
create_snapshot: null,
|
27
|
+
reserve_ip: null,
|
28
|
+
access_activity_log: null,
|
29
|
+
create_pcc: null,
|
30
|
+
s3_privilege: null,
|
31
|
+
create_backup_unit: null,
|
32
|
+
create_internet_access: null,
|
33
|
+
create_k8s_cluster: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
data/docs/GroupShare.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# GroupShare
|
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) | resource as generic type | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **properties** | [**GroupShareProperties**](GroupShareProperties.md) | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::GroupShare.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "resource",
|
20
|
+
href: https://<API_HOST>/cloudapi/v5/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares/17faab13-13abc-4efc-a8ad-ef1fb31a481b,
|
21
|
+
properties: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# GroupShareProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **edit_privilege** | **Boolean** | edit privilege on a resource | [optional] |
|
8
|
+
| **share_privilege** | **Boolean** | share privilege on a resource | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ionoscloud'
|
14
|
+
|
15
|
+
instance = Ionoscloud::GroupShareProperties.new(
|
16
|
+
edit_privilege: null,
|
17
|
+
share_privilege: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/GroupShares.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# GroupShares
|
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) | Share representing groups and resource relationship | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<GroupShare>**](GroupShare.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::GroupShares.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "shares",
|
20
|
+
href: https://<API_HOST>/cloudapi/v5/um/groups/15f67991-0f51-4efc-a8ad-ef1fb31a480c/shares,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/GroupUsers.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# GroupUsers
|
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 the resource | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<Group>**](Group.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::GroupUsers.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "groups",
|
20
|
+
href: https://<API_HOST>/cloudapi/v5/um/users/9b1b4c62-1466-11e7-87d3-d7bb7dac0087/groups,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Groups.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Groups
|
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 the resource | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<Group>**](Group.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::Groups.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "groups",
|
20
|
+
href: https://<API_HOST>/cloudapi/v5/um/groups,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/IPBlocksApi.md
ADDED
@@ -0,0 +1,513 @@
|
|
1
|
+
# IPBlocksApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**ipblocks_delete**](IPBlocksApi.md#ipblocks_delete) | **DELETE** /ipblocks/{ipblockId} | Delete IP Block |
|
8
|
+
| [**ipblocks_find_by_id**](IPBlocksApi.md#ipblocks_find_by_id) | **GET** /ipblocks/{ipblockId} | Retrieve an IP Block |
|
9
|
+
| [**ipblocks_get**](IPBlocksApi.md#ipblocks_get) | **GET** /ipblocks | List IP Blocks |
|
10
|
+
| [**ipblocks_patch**](IPBlocksApi.md#ipblocks_patch) | **PATCH** /ipblocks/{ipblockId} | Partially modify IP Block |
|
11
|
+
| [**ipblocks_post**](IPBlocksApi.md#ipblocks_post) | **POST** /ipblocks | Reserve IP Block |
|
12
|
+
| [**ipblocks_put**](IPBlocksApi.md#ipblocks_put) | **PUT** /ipblocks/{ipblockId} | Modify IP Block |
|
13
|
+
|
14
|
+
|
15
|
+
## ipblocks_delete
|
16
|
+
|
17
|
+
> Object ipblocks_delete(ipblock_id, opts)
|
18
|
+
|
19
|
+
Delete IP Block
|
20
|
+
|
21
|
+
Removes the specific IP Block
|
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::IPBlocksApi.new
|
41
|
+
ipblock_id = 'ipblock_id_example' # String |
|
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 IP Block
|
50
|
+
result = api_instance.ipblocks_delete(ipblock_id, opts)
|
51
|
+
p result
|
52
|
+
rescue Ionoscloud::ApiError => e
|
53
|
+
puts "Error when calling IPBlocksApi->ipblocks_delete: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
#### Using the ipblocks_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)> ipblocks_delete_with_http_info(ipblock_id, opts)
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
begin
|
65
|
+
# Delete IP Block
|
66
|
+
data, status_code, headers = api_instance.ipblocks_delete_with_http_info(ipblock_id, opts)
|
67
|
+
p status_code # => 2xx
|
68
|
+
p headers # => { ... }
|
69
|
+
p data # => Object
|
70
|
+
rescue Ionoscloud::ApiError => e
|
71
|
+
puts "Error when calling IPBlocksApi->ipblocks_delete_with_http_info: #{e}"
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
### Parameters
|
76
|
+
|
77
|
+
| Name | Type | Description | Notes |
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
79
|
+
| **ipblock_id** | **String** | | |
|
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
|
+
## ipblocks_find_by_id
|
99
|
+
|
100
|
+
> <IpBlock> ipblocks_find_by_id(ipblock_id, opts)
|
101
|
+
|
102
|
+
Retrieve an IP Block
|
103
|
+
|
104
|
+
Retrieves the attributes of a given IP Block.
|
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::IPBlocksApi.new
|
124
|
+
ipblock_id = 'ipblock_id_example' # String |
|
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 an IP Block
|
133
|
+
result = api_instance.ipblocks_find_by_id(ipblock_id, opts)
|
134
|
+
p result
|
135
|
+
rescue Ionoscloud::ApiError => e
|
136
|
+
puts "Error when calling IPBlocksApi->ipblocks_find_by_id: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
#### Using the ipblocks_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(<IpBlock>, Integer, Hash)> ipblocks_find_by_id_with_http_info(ipblock_id, opts)
|
145
|
+
|
146
|
+
```ruby
|
147
|
+
begin
|
148
|
+
# Retrieve an IP Block
|
149
|
+
data, status_code, headers = api_instance.ipblocks_find_by_id_with_http_info(ipblock_id, opts)
|
150
|
+
p status_code # => 2xx
|
151
|
+
p headers # => { ... }
|
152
|
+
p data # => <IpBlock>
|
153
|
+
rescue Ionoscloud::ApiError => e
|
154
|
+
puts "Error when calling IPBlocksApi->ipblocks_find_by_id_with_http_info: #{e}"
|
155
|
+
end
|
156
|
+
```
|
157
|
+
|
158
|
+
### Parameters
|
159
|
+
|
160
|
+
| Name | Type | Description | Notes |
|
161
|
+
| ---- | ---- | ----------- | ----- |
|
162
|
+
| **ipblock_id** | **String** | | |
|
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
|
+
[**IpBlock**](IpBlock.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
|
+
## ipblocks_get
|
182
|
+
|
183
|
+
> <IpBlocks> ipblocks_get(opts)
|
184
|
+
|
185
|
+
List IP Blocks
|
186
|
+
|
187
|
+
Retrieve a list of all reserved IP Blocks
|
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::IPBlocksApi.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
|
+
}
|
212
|
+
|
213
|
+
begin
|
214
|
+
# List IP Blocks
|
215
|
+
result = api_instance.ipblocks_get(opts)
|
216
|
+
p result
|
217
|
+
rescue Ionoscloud::ApiError => e
|
218
|
+
puts "Error when calling IPBlocksApi->ipblocks_get: #{e}"
|
219
|
+
end
|
220
|
+
```
|
221
|
+
|
222
|
+
#### Using the ipblocks_get_with_http_info variant
|
223
|
+
|
224
|
+
This returns an Array which contains the response data, status code and headers.
|
225
|
+
|
226
|
+
> <Array(<IpBlocks>, Integer, Hash)> ipblocks_get_with_http_info(opts)
|
227
|
+
|
228
|
+
```ruby
|
229
|
+
begin
|
230
|
+
# List IP Blocks
|
231
|
+
data, status_code, headers = api_instance.ipblocks_get_with_http_info(opts)
|
232
|
+
p status_code # => 2xx
|
233
|
+
p headers # => { ... }
|
234
|
+
p data # => <IpBlocks>
|
235
|
+
rescue Ionoscloud::ApiError => e
|
236
|
+
puts "Error when calling IPBlocksApi->ipblocks_get_with_http_info: #{e}"
|
237
|
+
end
|
238
|
+
```
|
239
|
+
|
240
|
+
### Parameters
|
241
|
+
|
242
|
+
| Name | Type | Description | Notes |
|
243
|
+
| ---- | ---- | ----------- | ----- |
|
244
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
245
|
+
| **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] |
|
246
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
247
|
+
|
248
|
+
### Return type
|
249
|
+
|
250
|
+
[**IpBlocks**](IpBlocks.md)
|
251
|
+
|
252
|
+
### Authorization
|
253
|
+
|
254
|
+
Basic Authentication, Token Authentication
|
255
|
+
|
256
|
+
### HTTP request headers
|
257
|
+
|
258
|
+
- **Content-Type**: Not defined
|
259
|
+
- **Accept**: application/json
|
260
|
+
|
261
|
+
|
262
|
+
## ipblocks_patch
|
263
|
+
|
264
|
+
> <IpBlock> ipblocks_patch(ipblock_id, ipblock, opts)
|
265
|
+
|
266
|
+
Partially modify IP Block
|
267
|
+
|
268
|
+
You can use update attributes of a resource
|
269
|
+
|
270
|
+
### Examples
|
271
|
+
|
272
|
+
```ruby
|
273
|
+
require 'time'
|
274
|
+
require 'ionoscloud'
|
275
|
+
# setup authorization
|
276
|
+
Ionoscloud.configure do |config|
|
277
|
+
# Configure HTTP basic authorization: Basic Authentication
|
278
|
+
config.username = 'YOUR USERNAME'
|
279
|
+
config.password = 'YOUR PASSWORD'
|
280
|
+
|
281
|
+
# Configure API key authorization: Token Authentication
|
282
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
283
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
284
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
285
|
+
end
|
286
|
+
|
287
|
+
api_instance = Ionoscloud::IPBlocksApi.new
|
288
|
+
ipblock_id = 'ipblock_id_example' # String |
|
289
|
+
ipblock = Ionoscloud::IpBlockProperties.new({location: 'us/las', size: 5}) # IpBlockProperties | IP Block to be modified
|
290
|
+
opts = {
|
291
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
292
|
+
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
|
293
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
294
|
+
}
|
295
|
+
|
296
|
+
begin
|
297
|
+
# Partially modify IP Block
|
298
|
+
result = api_instance.ipblocks_patch(ipblock_id, ipblock, opts)
|
299
|
+
p result
|
300
|
+
rescue Ionoscloud::ApiError => e
|
301
|
+
puts "Error when calling IPBlocksApi->ipblocks_patch: #{e}"
|
302
|
+
end
|
303
|
+
```
|
304
|
+
|
305
|
+
#### Using the ipblocks_patch_with_http_info variant
|
306
|
+
|
307
|
+
This returns an Array which contains the response data, status code and headers.
|
308
|
+
|
309
|
+
> <Array(<IpBlock>, Integer, Hash)> ipblocks_patch_with_http_info(ipblock_id, ipblock, opts)
|
310
|
+
|
311
|
+
```ruby
|
312
|
+
begin
|
313
|
+
# Partially modify IP Block
|
314
|
+
data, status_code, headers = api_instance.ipblocks_patch_with_http_info(ipblock_id, ipblock, opts)
|
315
|
+
p status_code # => 2xx
|
316
|
+
p headers # => { ... }
|
317
|
+
p data # => <IpBlock>
|
318
|
+
rescue Ionoscloud::ApiError => e
|
319
|
+
puts "Error when calling IPBlocksApi->ipblocks_patch_with_http_info: #{e}"
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
### Parameters
|
324
|
+
|
325
|
+
| Name | Type | Description | Notes |
|
326
|
+
| ---- | ---- | ----------- | ----- |
|
327
|
+
| **ipblock_id** | **String** | | |
|
328
|
+
| **ipblock** | [**IpBlockProperties**](IpBlockProperties.md) | IP Block to be modified | |
|
329
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
330
|
+
| **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] |
|
331
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
332
|
+
|
333
|
+
### Return type
|
334
|
+
|
335
|
+
[**IpBlock**](IpBlock.md)
|
336
|
+
|
337
|
+
### Authorization
|
338
|
+
|
339
|
+
Basic Authentication, Token Authentication
|
340
|
+
|
341
|
+
### HTTP request headers
|
342
|
+
|
343
|
+
- **Content-Type**: application/json
|
344
|
+
- **Accept**: application/json
|
345
|
+
|
346
|
+
|
347
|
+
## ipblocks_post
|
348
|
+
|
349
|
+
> <IpBlock> ipblocks_post(ipblock, opts)
|
350
|
+
|
351
|
+
Reserve IP Block
|
352
|
+
|
353
|
+
This will reserve a new IP Block
|
354
|
+
|
355
|
+
### Examples
|
356
|
+
|
357
|
+
```ruby
|
358
|
+
require 'time'
|
359
|
+
require 'ionoscloud'
|
360
|
+
# setup authorization
|
361
|
+
Ionoscloud.configure do |config|
|
362
|
+
# Configure HTTP basic authorization: Basic Authentication
|
363
|
+
config.username = 'YOUR USERNAME'
|
364
|
+
config.password = 'YOUR PASSWORD'
|
365
|
+
|
366
|
+
# Configure API key authorization: Token Authentication
|
367
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
368
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
369
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
370
|
+
end
|
371
|
+
|
372
|
+
api_instance = Ionoscloud::IPBlocksApi.new
|
373
|
+
ipblock = Ionoscloud::IpBlock.new({properties: Ionoscloud::IpBlockProperties.new({location: 'us/las', size: 5})}) # IpBlock | IP Block to be reserved
|
374
|
+
opts = {
|
375
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
376
|
+
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
|
377
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
378
|
+
}
|
379
|
+
|
380
|
+
begin
|
381
|
+
# Reserve IP Block
|
382
|
+
result = api_instance.ipblocks_post(ipblock, opts)
|
383
|
+
p result
|
384
|
+
rescue Ionoscloud::ApiError => e
|
385
|
+
puts "Error when calling IPBlocksApi->ipblocks_post: #{e}"
|
386
|
+
end
|
387
|
+
```
|
388
|
+
|
389
|
+
#### Using the ipblocks_post_with_http_info variant
|
390
|
+
|
391
|
+
This returns an Array which contains the response data, status code and headers.
|
392
|
+
|
393
|
+
> <Array(<IpBlock>, Integer, Hash)> ipblocks_post_with_http_info(ipblock, opts)
|
394
|
+
|
395
|
+
```ruby
|
396
|
+
begin
|
397
|
+
# Reserve IP Block
|
398
|
+
data, status_code, headers = api_instance.ipblocks_post_with_http_info(ipblock, opts)
|
399
|
+
p status_code # => 2xx
|
400
|
+
p headers # => { ... }
|
401
|
+
p data # => <IpBlock>
|
402
|
+
rescue Ionoscloud::ApiError => e
|
403
|
+
puts "Error when calling IPBlocksApi->ipblocks_post_with_http_info: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
### Parameters
|
408
|
+
|
409
|
+
| Name | Type | Description | Notes |
|
410
|
+
| ---- | ---- | ----------- | ----- |
|
411
|
+
| **ipblock** | [**IpBlock**](IpBlock.md) | IP Block to be reserved | |
|
412
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
413
|
+
| **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] |
|
414
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
415
|
+
|
416
|
+
### Return type
|
417
|
+
|
418
|
+
[**IpBlock**](IpBlock.md)
|
419
|
+
|
420
|
+
### Authorization
|
421
|
+
|
422
|
+
Basic Authentication, Token Authentication
|
423
|
+
|
424
|
+
### HTTP request headers
|
425
|
+
|
426
|
+
- **Content-Type**: application/json
|
427
|
+
- **Accept**: application/json
|
428
|
+
|
429
|
+
|
430
|
+
## ipblocks_put
|
431
|
+
|
432
|
+
> <IpBlock> ipblocks_put(ipblock_id, ipblock, opts)
|
433
|
+
|
434
|
+
Modify IP Block
|
435
|
+
|
436
|
+
You can use update attributes of a resource
|
437
|
+
|
438
|
+
### Examples
|
439
|
+
|
440
|
+
```ruby
|
441
|
+
require 'time'
|
442
|
+
require 'ionoscloud'
|
443
|
+
# setup authorization
|
444
|
+
Ionoscloud.configure do |config|
|
445
|
+
# Configure HTTP basic authorization: Basic Authentication
|
446
|
+
config.username = 'YOUR USERNAME'
|
447
|
+
config.password = 'YOUR PASSWORD'
|
448
|
+
|
449
|
+
# Configure API key authorization: Token Authentication
|
450
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
451
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
452
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
453
|
+
end
|
454
|
+
|
455
|
+
api_instance = Ionoscloud::IPBlocksApi.new
|
456
|
+
ipblock_id = 'ipblock_id_example' # String |
|
457
|
+
ipblock = Ionoscloud::IpBlock.new({properties: Ionoscloud::IpBlockProperties.new({location: 'us/las', size: 5})}) # IpBlock | IP Block to be modified
|
458
|
+
opts = {
|
459
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
460
|
+
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
|
461
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
462
|
+
}
|
463
|
+
|
464
|
+
begin
|
465
|
+
# Modify IP Block
|
466
|
+
result = api_instance.ipblocks_put(ipblock_id, ipblock, opts)
|
467
|
+
p result
|
468
|
+
rescue Ionoscloud::ApiError => e
|
469
|
+
puts "Error when calling IPBlocksApi->ipblocks_put: #{e}"
|
470
|
+
end
|
471
|
+
```
|
472
|
+
|
473
|
+
#### Using the ipblocks_put_with_http_info variant
|
474
|
+
|
475
|
+
This returns an Array which contains the response data, status code and headers.
|
476
|
+
|
477
|
+
> <Array(<IpBlock>, Integer, Hash)> ipblocks_put_with_http_info(ipblock_id, ipblock, opts)
|
478
|
+
|
479
|
+
```ruby
|
480
|
+
begin
|
481
|
+
# Modify IP Block
|
482
|
+
data, status_code, headers = api_instance.ipblocks_put_with_http_info(ipblock_id, ipblock, opts)
|
483
|
+
p status_code # => 2xx
|
484
|
+
p headers # => { ... }
|
485
|
+
p data # => <IpBlock>
|
486
|
+
rescue Ionoscloud::ApiError => e
|
487
|
+
puts "Error when calling IPBlocksApi->ipblocks_put_with_http_info: #{e}"
|
488
|
+
end
|
489
|
+
```
|
490
|
+
|
491
|
+
### Parameters
|
492
|
+
|
493
|
+
| Name | Type | Description | Notes |
|
494
|
+
| ---- | ---- | ----------- | ----- |
|
495
|
+
| **ipblock_id** | **String** | | |
|
496
|
+
| **ipblock** | [**IpBlock**](IpBlock.md) | IP Block to be modified | |
|
497
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
498
|
+
| **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] |
|
499
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
500
|
+
|
501
|
+
### Return type
|
502
|
+
|
503
|
+
[**IpBlock**](IpBlock.md)
|
504
|
+
|
505
|
+
### Authorization
|
506
|
+
|
507
|
+
Basic Authentication, Token Authentication
|
508
|
+
|
509
|
+
### HTTP request headers
|
510
|
+
|
511
|
+
- **Content-Type**: application/json
|
512
|
+
- **Accept**: application/json
|
513
|
+
|