VolumesApi
Last updated
Last updated
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
Create volume snapshots
Other parameters are passed through a pointer to a apiDatacentersVolumesCreateSnapshotPostRequest struct via the builder pattern
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Delete volumes
Other parameters are passed through a pointer to a apiDatacentersVolumesDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Retrieve volumes
Other parameters are passed through a pointer to a apiDatacentersVolumesFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List volumes
Other parameters are passed through a pointer to a apiDatacentersVolumesGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Partially modify volumes
Other parameters are passed through a pointer to a apiDatacentersVolumesPatchRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Create a Volume
Other parameters are passed through a pointer to a apiDatacentersVolumesPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Modify a Volume by ID
Other parameters are passed through a pointer to a apiDatacentersVolumesPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Restore volume snapshots
Other parameters are passed through a pointer to a apiDatacentersVolumesRestoreSnapshotPostRequest struct via the builder pattern
(empty response body)
Content-Type: application/x-www-form-urlencoded
Accept: application/json
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Post /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot
Create volume snapshots
Delete /datacenters/{datacenterId}/volumes/{volumeId}
Delete volumes
Get /datacenters/{datacenterId}/volumes/{volumeId}
Retrieve volumes
Get /datacenters/{datacenterId}/volumes
List volumes
Patch /datacenters/{datacenterId}/volumes/{volumeId}
Partially modify volumes
Post /datacenters/{datacenterId}/volumes
Create a Volume
Put /datacenters/{datacenterId}/volumes/{volumeId}
Modify a Volume by ID
Post /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot
Restore volume snapshots
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
volumeId
string
The unique ID of the volume.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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 to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
name
string
Snapshot name
description
string
Snapshot description
secAuthProtection
bool
Flag for enabling extra protection for this snapshot, such as two-step verification.
licenceType
string
The OS type for this snapshot.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
volumeId
string
The unique ID of the volume.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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 to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
volumeId
string
The unique ID of the volume.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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 to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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 to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
offset
int32
The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
[default to 0]
limit
int32
The maximum number of elements to return (use together with offset for pagination).
[default to 1000]
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
volumeId
string
The unique ID of the volume.
volume
The properties of the volume to be updated.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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 to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
volume
The volume to create.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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 to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
volumeId
string
The unique ID of the volume.
volume
The modified volume
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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 to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
datacenterId
string
The unique ID of the data center.
volumeId
string
The unique ID of the volume.
pretty
bool
Controls whether the response is pretty-printed (with indentations and new lines).
[default to true]
depth
int32
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 to 0]
xContractNumber
int32
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
snapshotId
string
The unique ID of the snapshot.