All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
DELETE /images/{imageId}
Delete images
GET /images/{imageId}
Retrieve images
GET /images
List images
PATCH /images/{imageId}
Partially modify images
PUT /images/{imageId}
Modify an Image by ID
images_delete
images_delete(image_id, opts)
Delete images
Delete the specified image; this operation is only supported for private images.
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::ImagesApi.newimage_id ='image_id_example'# String | The unique ID of the image.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 images api_instance.images_delete(image_id, opts)rescueIonoscloud::ApiError=> eputs"Error when calling ImagesApi->images_delete: #{e}"end
Using the images_delete_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
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
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
images_find_by_id
images_find_by_id(image_id, opts)
Retrieve images
Retrieve the properties of the specified image.
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::ImagesApi.newimage_id ='image_id_example'# String | The unique ID of the image.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 images result = api_instance.images_find_by_id(image_id, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ImagesApi->images_find_by_id: #{e}"end
Using the images_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
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
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
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::ImagesApi.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 images result = api_instance.images_get(opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ImagesApi->images_get: #{e}"end
Using the images_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# List images data, status_code, headers = api_instance.images_get_with_http_info(opts)p status_code # => 2xxp headers # => { ... }p data # => <Images>rescueIonoscloud::ApiError=> eputs"Error when calling ImagesApi->images_get_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
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
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
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::ImagesApi.newimage_id ='image_id_example'# String | The unique ID of the image.image =Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'}) # ImageProperties | The image properties 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 images result = api_instance.images_patch(image_id, image, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ImagesApi->images_patch: #{e}"end
Using the images_patch_with_http_info variant
This returns an Array which contains the response data, status code and headers.
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
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
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
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::ImagesApi.newimage_id ='image_id_example'# String | The unique ID of the image.image =Ionoscloud::Image.new({properties: Ionoscloud::ImageProperties.new({licence_type: 'UNKNOWN'})}) # Image | The modified imageopts = { 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 an Image by ID result = api_instance.images_put(image_id, image, opts)p resultrescueIonoscloud::ApiError=> eputs"Error when calling ImagesApi->images_put: #{e}"end
Using the images_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
begin# Modify an Image by ID data, status_code, headers = api_instance.images_put_with_http_info(image_id, image, opts)p status_code # => 2xxp headers # => { ... }p data # => <Image>rescueIonoscloud::ApiError=> eputs"Error when calling ImagesApi->images_put_with_http_info: #{e}"end
Parameters
Name
Type
Description
Notes
image_id
String
The unique ID of the image.
image
The modified image
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
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
[optional][default to 0]
x_contract_number
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.