Comment on page

ImagesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
​imagesDelete​
DELETE /images/{imageId}
Delete images
​imagesFindById​
GET /images/{imageId}
Retrieve images
​imagesGet​
GET /images
List images
​imagesPatch​
PATCH /images/{imageId}
Partially modify images
​imagesPut​
PUT /images/{imageId}
Modify an Image by ID
imagesDelete
imagesDelete(imageId, opts)
Delete images
Delete the specified image; this operation is only supported for private images.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ImagesApi(config);
// Delete images
api_instance
  .imagesDelete({
    imageId: imageId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
imageId
string
The unique ID of the image.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
imagesFindById
 imagesFindById(imageId, opts)
Retrieve images
Retrieve the properties of the specified image.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ImagesApi(config);
// Retrieve images
api_instance
  .imagesFindById({
    imageId: imageId_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
imageId
string
The unique ID of the image.
[default to undefined]
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​Image​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
imagesGet
imagesGet(opts)
List images
List all the images within the data center.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ImagesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// List images
api_instance
  .imagesGet({
    pretty: true,
    depth: 56,
    xContractNumber: 56
    orderBy: "<property_name>"
    maxResults: 2,
    filters: filterMap
    options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​Images​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
imagesPatch
 imagesPatch(imageId, image, opts)
Partially modify images
Update the properties of the specified image.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ImagesApi(config);
// Partially modify images
api_instance
  .imagesPatch({
    imageId: imageId_example,
    image: image_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
imageId
string
The unique ID of the image.
[default to undefined]
image
​ImageProperties​
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
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​Image​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
imagesPut
 imagesPut(imageId, image, opts)
Modify an Image by ID
Modifies the properties of the specified image.
Examples
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
    apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.ImagesApi(config);
// Modify an Image by ID
api_instance
  .imagesPut({
    imageId: imageId_example,
    image: image_example,
    pretty: true,
    depth: 56,
    xContractNumber: 56, 
        options: {}
  })
  .then((response) => console.log(response.data))
  .catch((error) => console.log(error.response.data));
Parameters
Name
Type
Description
Notes
imageId
string
The unique ID of the image.
[default to undefined]
image
​Image​
The modified image
​
pretty
boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
number
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&#39;s children are included. - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional][default to undefined]
Return type
​Image​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json

Method	HTTP request	Description
imagesDelete	DELETE /images/{imageId}	Delete images
imagesFindById	GET /images/{imageId}	Retrieve images
imagesGet	GET /images	List images
imagesPatch	PATCH /images/{imageId}	Partially modify images
imagesPut	PUT /images/{imageId}	Modify an Image by ID

Name	Type	Description	Notes
imageId	string	The unique ID of the image.	[default to undefined]
pretty	boolean	Controls whether the response is pretty-printed (with indentations and new lines).	[optional][default to true]
depth	number	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]
xContractNumber	number	Users with multiple contracts must provide the contract number, for which all API requests are to be executed.	[optional][default to undefined]

Name	Type	Description	Notes
imageId	string	The unique ID of the image.	[default to undefined]
pretty	boolean	Controls whether the response is pretty-printed (with indentations and new lines).	[optional][default to true]
depth	number	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]
xContractNumber	number	Users with multiple contracts must provide the contract number, for which all API requests are to be executed.	[optional][default to undefined]

Name	Type	Description	Notes
pretty	boolean	Controls whether the response is pretty-printed (with indentations and new lines).	[optional][default to true]
depth	number	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]
xContractNumber	number	Users with multiple contracts must provide the contract number, for which all API requests are to be executed.	[optional][default to undefined]

Name	Type	Description	Notes
imageId	string	The unique ID of the image.	[default to undefined]
image	ImageProperties	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	number	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]
xContractNumber	number	Users with multiple contracts must provide the contract number, for which all API requests are to be executed.	[optional][default to undefined]

Name	Type	Description	Notes
imageId	string	The unique ID of the image.	[default to undefined]
image	Image	The modified image
pretty	boolean	Controls whether the response is pretty-printed (with indentations and new lines).	[optional][default to true]
depth	number	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]
xContractNumber	number	Users with multiple contracts must provide the contract number, for which all API requests are to be executed.	[optional][default to undefined]

Last modified 4mo ago