SnapshotsApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
DELETE /snapshots/{snapshotId} | Delete snapshots | |
GET /snapshots/{snapshotId} | Retrieve snapshots by ID | |
GET /snapshots | List snapshots | |
PATCH /snapshots/{snapshotId} | Partially modify snapshots | |
PUT /snapshots/{snapshotId} | Modify a Snapshot by ID |
snapshotsDelete
snapshotsDelete(snapshotId, opts)
Delete snapshots
Deletes the specified snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the snapshot. | [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] |
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
snapshotsFindById
snapshotsFindById(snapshotId, opts)
Retrieve snapshots by ID
Retrieve the properties of the specified snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the snapshot. | [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] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
snapshotsGet
snapshotsGet(opts)
List snapshots
List all available snapshots.
Examples
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'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
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
snapshotsPatch
snapshotsPatch(snapshotId, snapshot, opts)
Partially modify snapshots
Update the properties of the specified snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the snapshot. | [default to undefined] |
snapshot | The properties of the snapshot 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] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
snapshotsPut
snapshotsPut(snapshotId, snapshot, opts)
Modify a Snapshot by ID
Modifies the properties of the specified snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the snapshot. | [default to undefined] |
snapshot | The modified snapshot | ||
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] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated