ServersApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
Delete /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Detach a CD-ROM by ID | |
Get /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId} | Get Attached CD-ROM by ID | |
Get /datacenters/{datacenterId}/servers/{serverId}/cdroms | Get Attached CD-ROMs | |
Post /datacenters/{datacenterId}/servers/{serverId}/cdroms | Attach a CD-ROM | |
Delete /datacenters/{datacenterId}/servers/{serverId} | Delete servers | |
Get /datacenters/{datacenterId}/servers/{serverId} | Retrieve servers by ID | |
Get /datacenters/{datacenterId}/servers | List servers | |
Patch /datacenters/{datacenterId}/servers/{serverId} | Partially modify servers | |
Post /datacenters/{datacenterId}/servers | Create a Server | |
Put /datacenters/{datacenterId}/servers/{serverId} | Modify a Server by ID | |
Post /datacenters/{datacenterId}/servers/{serverId}/reboot | Reboot servers | |
Get /datacenters/{datacenterId}/servers/{serverId}/remoteconsole | Get Remote Console link | |
Post /datacenters/{datacenterId}/servers/{serverId}/resume | Resume a Cube Server by ID | |
Post /datacenters/{datacenterId}/servers/{serverId}/start | Start an Enterprise Server by ID | |
Post /datacenters/{datacenterId}/servers/{serverId}/stop | Stop an Enterprise Server by ID | |
Post /datacenters/{datacenterId}/servers/{serverId}/suspend | Suspend a Cube Server by ID | |
Get /datacenters/{datacenterId}/servers/{serverId}/token | Get JASON Web Token | |
Post /datacenters/{datacenterId}/servers/{serverId}/upgrade | Upgrade a Server by ID | |
Delete /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Detach a Volume by ID | |
Get /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId} | Get Attached Volume by ID | |
Get /datacenters/{datacenterId}/servers/{serverId}/volumes | Get Attached Volumes | |
Post /datacenters/{datacenterId}/servers/{serverId}/volumes | Attach a Volume to a Server |
DatacentersServersCdromsDelete
Detach a CD-ROM by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. | |
cdromId | string | The unique ID of the CD-ROM. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersCdromsDeleteRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersCdromsFindById
Get Attached CD-ROM by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. | |
cdromId | string | The unique ID of the CD-ROM. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersCdromsFindByIdRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersCdromsGet
Get Attached CD-ROMs
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersCdromsGetRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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] |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersCdromsPost
Attach a CD-ROM
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersCdromsPostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
cdrom | The CD-ROM to be attached. | ||
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. |
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersServersDelete
Delete servers
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersDeleteRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. | |
deleteVolumes | bool | If true, all attached storage volumes will also be deleted. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersFindById
Retrieve servers by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersFindByIdRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersGet
List servers
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersGetRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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] |
upgradeNeeded | bool | Filter servers that can or that cannot be upgraded. | |
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] |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersPatch
Partially modify servers
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersPatchRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
server | The properties of the server 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. |
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersServersPost
Create a Server
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersPostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
server | The server 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. |
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersServersPut
Modify a Server by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersPutRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
server | The modified server | ||
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. |
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
DatacentersServersRebootPost
Reboot servers
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersRebootPostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersRemoteConsoleGet
Get Remote Console link
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersRemoteConsoleGetRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersResumePost
Resume a Cube Server by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersResumePostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersStartPost
Start an Enterprise Server by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersStartPostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersStopPost
Stop an Enterprise Server by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersStopPostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersSuspendPost
Suspend a Cube Server by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersSuspendPostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersTokenGet
Get JASON Web Token
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersTokenGetRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersUpgradePost
Upgrade a Server by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersUpgradePostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersVolumesDelete
Detach a Volume by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. | |
volumeId | string | The unique ID of the volume. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersVolumesDeleteRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
(empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersVolumesFindById
Get Attached Volume by ID
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. | |
volumeId | string | The unique ID of the volume. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersVolumesFindByIdRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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. |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersVolumesGet
Get Attached Volumes
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersVolumesGetRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
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] |
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
DatacentersServersVolumesPost
Attach a Volume to a Server
Example
Path Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
datacenterId | string | The unique ID of the data center. | |
serverId | string | The unique ID of the server. |
Other Parameters
Other parameters are passed through a pointer to a apiDatacentersServersVolumesPostRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
volume | The volume to be attached (or created and attached). | ||
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. |
Return type
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated