All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
snapshots_delete
snapshots_delete(snapshot_id, opts)
Delete snapshots
Deletes the specified snapshot.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::SnapshotsApi.newsnapshot_id ='snapshot_id_example'# String | The unique ID of the snapshot.opts = { pretty: true,# Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}begin# Delete snapshots api_instance.snapshots_delete(snapshot_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling SnapshotsApi->snapshots_delete: #{e}"end
Using the snapshots_delete_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
Retrieve the properties of the specified snapshot.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::SnapshotsApi.newsnapshot_id ='snapshot_id_example'# String | The unique ID of the snapshot.opts = { pretty: true,# Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}begin# Retrieve snapshots by ID result = api_instance.snapshots_find_by_id(snapshot_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling SnapshotsApi->snapshots_find_by_id: #{e}"end
Using the snapshots_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::SnapshotsApi.newopts = { pretty: true,# Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}begin# List snapshots result = api_instance.snapshots_get(opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling SnapshotsApi->snapshots_get: #{e}"end
Using the snapshots_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::SnapshotsApi.newsnapshot_id ='snapshot_id_example'# String | The unique ID of the snapshot.snapshot =Ionoscloud::SnapshotProperties.new# SnapshotProperties | The properties of the snapshot to be updated.opts = { pretty: true,# Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}begin# Partially modify snapshots result = api_instance.snapshots_patch(snapshot_id, snapshot, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling SnapshotsApi->snapshots_patch: #{e}"end
Using the snapshots_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
Modifies the properties of the specified snapshot.
Examples
require'time'require'ionoscloud'# setup authorizationIonoscloud.configure do|config|# Configure HTTP basic authorization: Basic Authentication config.username ='YOUR USERNAME' config.password ='YOUR PASSWORD'# Configure API key authorization: Token Authentication config.api_key['Authorization'] ='YOUR API KEY'# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)# config.api_key_prefix['Authorization'] = 'Bearer'endapi_instance =Ionoscloud::SnapshotsApi.newsnapshot_id ='snapshot_id_example'# String | The unique ID of the snapshot.snapshot = Ionoscloud::Snapshot.new({properties: Ionoscloud::SnapshotProperties.new}) # Snapshot | The modified snapshot
opts = { pretty: true,# Boolean | Controls whether the response is pretty-printed (with indentations and new lines). depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}begin# Modify a Snapshot by ID result = api_instance.snapshots_put(snapshot_id, snapshot, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling SnapshotsApi->snapshots_put: #{e}"end
Using the snapshots_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.