ImagesApi
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(image_id, opts)
Delete images
Delete the specified image; this operation is only supported for private images.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::ImagesApi.new
image_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)
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_delete: #{e}"
end
This returns an Array which contains the response data (
nil in this case), status code and headers.<Array(nil, Integer, Hash)> images_delete_with_http_info(image_id, opts)
begin
# Delete images
data, status_code, headers = api_instance.images_delete_with_http_info(image_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_delete_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
image_id | String | The unique ID of the 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. | [optional] |
nil (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
images_find_by_id(image_id, opts)
Retrieve images
Retrieve the properties of the specified image.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::ImagesApi.new
image_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 result
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_find_by_id: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> images_find_by_id_with_http_info(image_id, opts)
begin
# Retrieve images
data, status_code, headers = api_instance.images_find_by_id_with_http_info(image_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Image>
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_find_by_id_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
image_id | String | The unique ID of the 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. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
images_get(opts)
List images
List all the images within the data center.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::ImagesApi.new
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
# List images
result = api_instance.images_get(opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_get: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> images_get_with_http_info(opts)
begin
# List images
data, status_code, headers = api_instance.images_get_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Images>
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_get_with_http_info: #{e}"
end
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. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
images_patch(image_id, image, opts)
Partially modify images
Update the properties of the specified image.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::ImagesApi.new
image_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 result
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_patch: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> images_patch_with_http_info(image_id, image, opts)
begin
# Partially modify images
data, status_code, headers = api_instance.images_patch_with_http_info(image_id, image, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Image>
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_patch_with_http_info: #{e}"
end
Name | Type | Description | Notes |
|---|---|---|---|
image_id | String | The unique ID of the image. | |
image | The image properties to be updated. | | |
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. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
images_put(image_id, image, opts)
Modify an Image by ID
Modifies the properties of the specified image.
require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.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'
end
api_instance = Ionoscloud::ImagesApi.new
image_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 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
# Modify an Image by ID
result = api_instance.images_put(image_id, image, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_put: #{e}"
end
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> images_put_with_http_info(image_id, image, opts)
begin
# Modify an Image by ID
data, status_code, headers = api_instance.images_put_with_http_info(image_id, image, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <Image>
rescue Ionoscloud::ApiError => e
puts "Error when calling ImagesApi->images_put_with_http_info: #{e}"
end
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. | [optional] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
Last modified 3mo ago