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

Snapshots

List snapshots

get

List all available snapshots.

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/snapshots 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": "snapshot",
      "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": "Image/Snapshot of Ubuntu ",
        "location": "us/las",
        "size": 100,
        "secAuthProtection": true,
        "cpuHotPlug": true,
        "cpuHotUnplug": true,
        "ramHotPlug": true,
        "ramHotUnplug": true,
        "nicHotPlug": true,
        "nicHotUnplug": true,
        "discVirtioHotPlug": true,
        "discVirtioHotUnplug": true,
        "discScsiHotPlug": true,
        "exposeSerial": true,
        "requireLegacyBios": true,
        "discScsiHotUnplug": true,
        "licenceType": "LINUX",
        "applicationType": "MSSQL-2019-Standard"
      }
    }
  ]
}

Retrieve snapshots by ID

get

Retrieve the properties of the specified snapshot.

Authorizations
Path parameters
snapshotIdstringRequired

The unique ID of the snapshot.

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/snapshots/{snapshotId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "snapshot",
  "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": "Image/Snapshot of Ubuntu ",
    "location": "us/las",
    "size": 100,
    "secAuthProtection": true,
    "cpuHotPlug": true,
    "cpuHotUnplug": true,
    "ramHotPlug": true,
    "ramHotUnplug": true,
    "nicHotPlug": true,
    "nicHotUnplug": true,
    "discVirtioHotPlug": true,
    "discVirtioHotUnplug": true,
    "discScsiHotPlug": true,
    "exposeSerial": true,
    "requireLegacyBios": true,
    "discScsiHotUnplug": true,
    "licenceType": "LINUX",
    "applicationType": "MSSQL-2019-Standard"
  }
}

Modify a Snapshot by ID

put

Modifies the properties of the specified snapshot.

Authorizations
Path parameters
snapshotIdstringRequired

The unique ID of the snapshot.

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: snapshot
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/snapshots/{snapshotId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 457

{
  "type": "snapshot",
  "metadata": {},
  "properties": {
    "name": "My resource",
    "description": "Image/Snapshot of Ubuntu ",
    "secAuthProtection": true,
    "cpuHotPlug": true,
    "cpuHotUnplug": true,
    "ramHotPlug": true,
    "ramHotUnplug": true,
    "nicHotPlug": true,
    "nicHotUnplug": true,
    "discVirtioHotPlug": true,
    "discVirtioHotUnplug": true,
    "discScsiHotPlug": true,
    "exposeSerial": true,
    "requireLegacyBios": true,
    "discScsiHotUnplug": true,
    "licenceType": "LINUX",
    "applicationType": "MSSQL-2019-Standard"
  }
}
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "snapshot",
  "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": "Image/Snapshot of Ubuntu ",
    "location": "us/las",
    "size": 100,
    "secAuthProtection": true,
    "cpuHotPlug": true,
    "cpuHotUnplug": true,
    "ramHotPlug": true,
    "ramHotUnplug": true,
    "nicHotPlug": true,
    "nicHotUnplug": true,
    "discVirtioHotPlug": true,
    "discVirtioHotUnplug": true,
    "discScsiHotPlug": true,
    "exposeSerial": true,
    "requireLegacyBios": true,
    "discScsiHotUnplug": true,
    "licenceType": "LINUX",
    "applicationType": "MSSQL-2019-Standard"
  }
}

Delete snapshots

delete

Deletes the specified snapshot.

Authorizations
Path parameters
snapshotIdstringRequired

The unique ID of the snapshot.

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/snapshots/{snapshotId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Partially modify snapshots

patch

Update the properties of the specified snapshot.

Authorizations
Path parameters
snapshotIdstringRequired

The unique ID of the snapshot.

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 name of the resource.

Example: My resource
descriptionstringOptional

Human-readable description.

Example: Image/Snapshot of Ubuntu
locationstringRead-onlyOptional

Location of that image/snapshot.

Example: us/las
sizenumberRead-onlyOptional

The size of the image in GB.

Example: 100
secAuthProtectionbooleanOptional

Boolean value representing if the snapshot requires extra protection, such as two-step verification.

Example: true
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
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
discScsiHotUnplugbooleanOptional

Is capable of SCSI drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.

Example: true
licenceTypestringOptional

OS type of this snapshot

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
Responses
202
Successful operation
application/json
patch
PATCH /cloudapi/v6/snapshots/{snapshotId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "name": "My resource",
  "description": "Image/Snapshot of Ubuntu ",
  "secAuthProtection": true,
  "cpuHotPlug": true,
  "cpuHotUnplug": true,
  "ramHotPlug": true,
  "ramHotUnplug": true,
  "nicHotPlug": true,
  "nicHotUnplug": true,
  "discVirtioHotPlug": true,
  "discVirtioHotUnplug": true,
  "discScsiHotPlug": true,
  "exposeSerial": true,
  "requireLegacyBios": true,
  "discScsiHotUnplug": true,
  "licenceType": "LINUX",
  "applicationType": "MSSQL-2019-Standard"
}
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "snapshot",
  "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": "Image/Snapshot of Ubuntu ",
    "location": "us/las",
    "size": 100,
    "secAuthProtection": true,
    "cpuHotPlug": true,
    "cpuHotUnplug": true,
    "ramHotPlug": true,
    "ramHotUnplug": true,
    "nicHotPlug": true,
    "nicHotUnplug": true,
    "discVirtioHotPlug": true,
    "discVirtioHotUnplug": true,
    "discScsiHotPlug": true,
    "exposeSerial": true,
    "requireLegacyBios": true,
    "discScsiHotUnplug": true,
    "licenceType": "LINUX",
    "applicationType": "MSSQL-2019-Standard"
  }
}
PreviousVolumesNextIP blocks

Was this helpful?