SnapshotsApi
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 |
snapshots_delete
snapshots_delete(snapshot_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete snapshots
Deletes the specified snapshot.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshot_id | str | The unique ID of the snapshot. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
x_contract_number | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
void (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
snapshots_find_by_id
Snapshot snapshots_find_by_id(snapshot_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve snapshots by ID
Retrieve the properties of the specified snapshot.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshot_id | str | The unique ID of the snapshot. | |
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
x_contract_number | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
snapshots_get
Snapshots snapshots_get(pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List snapshots
List all available snapshots.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
x_contract_number | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
snapshots_patch
Snapshot snapshots_patch(snapshot_id, snapshot, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Partially modify snapshots
Update the properties of the specified snapshot.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshot_id | str | The unique ID of the snapshot. | |
snapshot | The properties of the snapshot to be updated. | ||
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
x_contract_number | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
snapshots_put
Snapshot snapshots_put(snapshot_id, snapshot, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Modify a Snapshot by ID
Modifies the properties of the specified snapshot.
Example
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshot_id | str | The unique ID of the snapshot. | |
snapshot | The modified snapshot | ||
pretty | bool | Controls whether the response is pretty-printed (with indentations and new lines). | [optional] [default to True] |
depth | int | 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] |
x_contract_number | int | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated