AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

Images

List images

get

List all the images in the current contract.

Authorizations
Query parameters
prettybooleanOptional

Controls whether the response is pretty-printed (with indentations and new lines).

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Responses
200
Successful operation
application/json
get
GET /cloudapi/v6/images HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "collection",
  "href": "<RESOURCE-URI>",
  "items": [
    {
      "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
      "type": "image",
      "href": "<RESOURCE-URI>",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "My resource",
        "description": "The image/snapshot of Ubuntu ",
        "location": "us/las",
        "size": 100,
        "cpuHotPlug": true,
        "cpuHotUnplug": true,
        "ramHotPlug": true,
        "ramHotUnplug": true,
        "nicHotPlug": true,
        "nicHotUnplug": true,
        "discVirtioHotPlug": true,
        "discVirtioHotUnplug": true,
        "discScsiHotPlug": true,
        "discScsiHotUnplug": true,
        "exposeSerial": true,
        "requireLegacyBios": true,
        "licenceType": "LINUX",
        "applicationType": "MSSQL-2019-Standard",
        "imageType": "HDD",
        "public": true,
        "imageAliases": [
          "text"
        ],
        "cloudInit": "V1"
      }
    }
  ]
}

Retrieve images

get

Retrieve the properties of the specified image.

Authorizations
Path parameters
imageIdstringRequired

The unique ID of the image.

Query parameters
prettybooleanOptional

Controls whether the response is pretty-printed (with indentations and new lines).

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Responses
200
Successful operation
application/json
get
GET /cloudapi/v6/images/{imageId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "image",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "My resource",
    "description": "The image/snapshot of Ubuntu ",
    "location": "us/las",
    "size": 100,
    "cpuHotPlug": true,
    "cpuHotUnplug": true,
    "ramHotPlug": true,
    "ramHotUnplug": true,
    "nicHotPlug": true,
    "nicHotUnplug": true,
    "discVirtioHotPlug": true,
    "discVirtioHotUnplug": true,
    "discScsiHotPlug": true,
    "discScsiHotUnplug": true,
    "exposeSerial": true,
    "requireLegacyBios": true,
    "licenceType": "LINUX",
    "applicationType": "MSSQL-2019-Standard",
    "imageType": "HDD",
    "public": true,
    "imageAliases": [
      "text"
    ],
    "cloudInit": "V1"
  }
}

Modify an Image by ID

put

Modifies the properties of the specified image.

Authorizations
Path parameters
imageIdstringRequired

The unique ID of the image.

Query parameters
prettybooleanOptional

Controls whether the response is pretty-printed (with indentations and new lines).

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Body
idstringRead-onlyOptional

The resource's unique identifier.

Example: 15f67991-0f51-4efc-a8ad-ef1fb31a480c
typeall ofOptional

The type of object that has been created.

Example: image
string · enumOptionalPossible values:
hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: <RESOURCE-URI>
Responses
202
Successful operation
application/json
put
PUT /cloudapi/v6/images/{imageId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 450

{
  "type": "image",
  "metadata": {},
  "properties": {
    "name": "My resource",
    "description": "The image/snapshot of Ubuntu ",
    "cpuHotPlug": true,
    "cpuHotUnplug": true,
    "ramHotPlug": true,
    "ramHotUnplug": true,
    "nicHotPlug": true,
    "nicHotUnplug": true,
    "discVirtioHotPlug": true,
    "discVirtioHotUnplug": true,
    "discScsiHotPlug": true,
    "discScsiHotUnplug": true,
    "exposeSerial": true,
    "requireLegacyBios": true,
    "licenceType": "LINUX",
    "applicationType": "MSSQL-2019-Standard",
    "cloudInit": "V1"
  }
}
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "image",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "My resource",
    "description": "The image/snapshot of Ubuntu ",
    "location": "us/las",
    "size": 100,
    "cpuHotPlug": true,
    "cpuHotUnplug": true,
    "ramHotPlug": true,
    "ramHotUnplug": true,
    "nicHotPlug": true,
    "nicHotUnplug": true,
    "discVirtioHotPlug": true,
    "discVirtioHotUnplug": true,
    "discScsiHotPlug": true,
    "discScsiHotUnplug": true,
    "exposeSerial": true,
    "requireLegacyBios": true,
    "licenceType": "LINUX",
    "applicationType": "MSSQL-2019-Standard",
    "imageType": "HDD",
    "public": true,
    "imageAliases": [
      "text"
    ],
    "cloudInit": "V1"
  }
}

Delete images

delete

Delete the specified image; this operation is only supported for private images.

Authorizations
Path parameters
imageIdstringRequired

The unique ID of the image.

Query parameters
prettybooleanOptional

Controls whether the response is pretty-printed (with indentations and new lines).

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Responses
202
Successful operation
delete
DELETE /cloudapi/v6/images/{imageId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Partially modify images

patch

Update the properties of the specified image.

Authorizations
Path parameters
imageIdstringRequired

The unique ID of the image.

Query parameters
prettybooleanOptional

Controls whether the response is pretty-printed (with indentations and new lines).

Default: true
depthinteger · int32 · max: 10Optional

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

Default: 0
Header parameters
X-Contract-Numberinteger · int32Optional

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Body
namestringOptional

The resource name.

Example: My resource
descriptionstringOptional

Human-readable description.

Example: The image/snapshot of Ubuntu
locationstringRead-onlyOptional

The location of this image/snapshot.

Example: us/las
sizenumberRead-onlyOptional

The image size in GB.

Example: 100
cpuHotPlugbooleanOptional

Hot-plug capable CPU (no reboot required).

Example: true
cpuHotUnplugbooleanOptional

Hot-unplug capable CPU (no reboot required).

Example: true
ramHotPlugbooleanOptional

Hot-plug capable RAM (no reboot required).

Example: true
ramHotUnplugbooleanOptional

Hot-unplug capable RAM (no reboot required).

Example: true
nicHotPlugbooleanOptional

Hot-plug capable NIC (no reboot required).

Example: true
nicHotUnplugbooleanOptional

Hot-unplug capable NIC (no reboot required).

Example: true
discVirtioHotPlugbooleanOptional

Hot-plug capable Virt-IO drive (no reboot required).

Example: true
discVirtioHotUnplugbooleanOptional

Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.

Example: true
discScsiHotPlugbooleanOptional

Hot-plug capable SCSI drive (no reboot required).

Example: true
discScsiHotUnplugbooleanOptional

Hot-unplug capable SCSI drive (no reboot required). Not supported with Windows VMs.

Example: true
exposeSerialbooleanOptional

If set to true will expose the serial id of the disk attached to the server. If set to false will not expose the serial id. Some operating systems or software solutions require the serial id to be exposed to work properly. Exposing the serial can influence licensed software (e.g. Windows) behavior

Default: falseExample: true
requireLegacyBiosbooleanOptional

Indicates if the image requires the legacy BIOS for compatibility or specific needs.

Default: trueExample: true
licenceTypestringRequired

The OS type of this image.

Example: LINUX
applicationTypestringOptional

The type of application that is hosted on this resource. Only public images can have an Application type different than UNKNOWN.

Default: UNKNOWNExample: MSSQL-2019-Standard
imageTypestring · enumRead-onlyOptional

The image type.

Example: HDDPossible values:
publicbooleanRead-onlyOptional

Indicates whether the image is part of a public repository.

Example: true
imageAliasesstring[]Read-onlyOptional

List of image aliases mapped for this image

cloudInitstring · enumOptional

Cloud init compatibility.

Example: V1Possible values:
Responses
202
Successful operation
application/json
patch
PATCH /cloudapi/v6/images/{imageId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 406

{
  "name": "My resource",
  "description": "The image/snapshot of Ubuntu ",
  "cpuHotPlug": true,
  "cpuHotUnplug": true,
  "ramHotPlug": true,
  "ramHotUnplug": true,
  "nicHotPlug": true,
  "nicHotUnplug": true,
  "discVirtioHotPlug": true,
  "discVirtioHotUnplug": true,
  "discScsiHotPlug": true,
  "discScsiHotUnplug": true,
  "exposeSerial": true,
  "requireLegacyBios": true,
  "licenceType": "LINUX",
  "applicationType": "MSSQL-2019-Standard",
  "cloudInit": "V1"
}
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "image",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "My resource",
    "description": "The image/snapshot of Ubuntu ",
    "location": "us/las",
    "size": 100,
    "cpuHotPlug": true,
    "cpuHotUnplug": true,
    "ramHotPlug": true,
    "ramHotUnplug": true,
    "nicHotPlug": true,
    "nicHotUnplug": true,
    "discVirtioHotPlug": true,
    "discVirtioHotUnplug": true,
    "discScsiHotPlug": true,
    "discScsiHotUnplug": true,
    "exposeSerial": true,
    "requireLegacyBios": true,
    "licenceType": "LINUX",
    "applicationType": "MSSQL-2019-Standard",
    "imageType": "HDD",
    "public": true,
    "imageAliases": [
      "text"
    ],
    "cloudInit": "V1"
  }
}
PreviousServersNextVolumes

Was this helpful?