ImageApi
Method | HTTP request | Description |
DELETE /images/{imageId} | Delete an Image | |
GET /images/{imageId} | Retrieve an Image | |
GET /images | List Images | |
PATCH /images/{imageId} | Partially modify an Image | |
PUT /images/{imageId} | Modify an Image |
object imagesDelete(imageId, opts)
Delete an Image
Deletes the specified image. This operation is permitted on private image only.
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.ImageApi(config);
// Delete an Image
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));
Name | Type | Description | Notes |
imageId | string | | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
object
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
imagesFindById(imageId, opts)
Retrieve an Image
Retrieves the attributes of a given image.
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.ImageApi(config);
// Retrieve an Image
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));
Name | Type | Description | Notes |
imageId | string | | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
imagesGet(opts)
List Images
Retrieve a list of images within the datacenter
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.ImageApi(config);
// List Images
api_instance
.imagesGet({
pretty: true,
depth: 56,
xContractNumber: 56
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
imagesPatch(imageId, image, opts)
Partially modify an Image
You can use update attributes of a resource
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.ImageApi(config);
// Partially modify an Image
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));
Name | Type | Description | Notes |
imageId | string | | [default to undefined] |
image | Modified Image | | |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
imagesPut(imageId, image, opts)
Modify an Image
You can use update attributes of a resource
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.ImageApi(config);
// Modify an Image
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));
Name | Type | Description | Notes |
imageId | string | | [default to undefined] |
image | Modified Image | | |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Basic Authentication, Token Authentication
- Content-Type: application/json
- Accept: application/json
Last modified 1yr ago