LabelsApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
DELETE /datacenters/{datacenterId}/labels/{key} | Delete data center labels | |
GET /datacenters/{datacenterId}/labels/{key} | Retrieve data center labels | |
GET /datacenters/{datacenterId}/labels | List data center labels | |
POST /datacenters/{datacenterId}/labels | Create a Data Center Label | |
PUT /datacenters/{datacenterId}/labels/{key} | Modify a Data Center Label by Key | |
DELETE /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Delete server labels | |
GET /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Retrieve server labels | |
GET /datacenters/{datacenterId}/servers/{serverId}/labels | List server labels | |
POST /datacenters/{datacenterId}/servers/{serverId}/labels | Create a Server Label | |
PUT /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Modify a Server Label | |
DELETE /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Delete volume labels | |
GET /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Retrieve volume labels | |
GET /datacenters/{datacenterId}/volumes/{volumeId}/labels | List volume labels | |
POST /datacenters/{datacenterId}/volumes/{volumeId}/labels | Create a Volume Label | |
PUT /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Modify a Volume Label | |
DELETE /ipblocks/{ipblockId}/labels/{key} | Delete IP block labels | |
GET /ipblocks/{ipblockId}/labels/{key} | Retrieve IP block labels | |
GET /ipblocks/{ipblockId}/labels | List IP block labels | |
POST /ipblocks/{ipblockId}/labels | Create IP block labels | |
PUT /ipblocks/{ipblockId}/labels/{key} | Modify a IP Block Label by ID | |
GET /labels/{labelurn} | Retrieve labels by URN | |
GET /labels | List labels | |
DELETE /snapshots/{snapshotId}/labels/{key} | Delete snapshot labels | |
GET /snapshots/{snapshotId}/labels/{key} | Retrieve snapshot labels | |
GET /snapshots/{snapshotId}/labels | List snapshot labels | |
POST /snapshots/{snapshotId}/labels | Create a Snapshot Label | |
PUT /snapshots/{snapshotId}/labels/{key} | Modify a Snapshot Label by ID |
datacentersLabelsDelete
datacentersLabelsDelete(datacenterId, key, opts)
Delete data center labels
Delete the specified data center label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
key | string | The label key | [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
datacentersLabelsFindByKey
datacentersLabelsFindByKey(datacenterId, key, opts)
Retrieve data center labels
Retrieve the properties of the specified data center label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
key | string | The label key | [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
datacentersLabelsGet
datacentersLabelsGet(datacenterId, opts)
List data center labels
List all the the labels for the specified data center.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [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
datacentersLabelsPost
datacentersLabelsPost(datacenterId, label, opts)
Create a Data Center Label
Adds a new label to the specified data center.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
label | The label to create. | ||
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
datacentersLabelsPut
datacentersLabelsPut(datacenterId, key, label, opts)
Modify a Data Center Label by Key
Modifies the specified data center label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
key | string | The label key | [default to undefined] |
label | The modified label | ||
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
datacentersServersLabelsDelete
datacentersServersLabelsDelete(datacenterId, serverId, key, opts)
Delete server labels
Delete the specified server label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
serverId | string | The unique ID of the server. | [default to undefined] |
key | string | The label key | [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
datacentersServersLabelsFindByKey
datacentersServersLabelsFindByKey(datacenterId, serverId, key, opts)
Retrieve server labels
Retrieve the properties of the specified server label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
serverId | string | The unique ID of the server. | [default to undefined] |
key | string | The label key | [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
datacentersServersLabelsGet
datacentersServersLabelsGet(datacenterId, serverId, opts)
List server labels
List all the the labels for the specified server.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
serverId | string | The unique ID of the server. | [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
datacentersServersLabelsPost
datacentersServersLabelsPost(datacenterId, serverId, label, opts)
Create a Server Label
Adds a new label to the specified server.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
serverId | string | The unique ID of the server. | [default to undefined] |
label | The label to create. | ||
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
datacentersServersLabelsPut
datacentersServersLabelsPut(datacenterId, serverId, key, label, opts)
Modify a Server Label
Modifies the specified server label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
serverId | string | The unique ID of the server. | [default to undefined] |
key | string | The label key | [default to undefined] |
label | The modified label | ||
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
datacentersVolumesLabelsDelete
datacentersVolumesLabelsDelete(datacenterId, volumeId, key, opts)
Delete volume labels
Delete the specified volume label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
volumeId | string | The unique ID of the volume. | [default to undefined] |
key | string | The label key | [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
datacentersVolumesLabelsFindByKey
datacentersVolumesLabelsFindByKey(datacenterId, volumeId, key, opts)
Retrieve volume labels
Retrieve the properties of the specified volume label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
volumeId | string | The unique ID of the volume. | [default to undefined] |
key | string | The label key | [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
datacentersVolumesLabelsGet
datacentersVolumesLabelsGet(datacenterId, volumeId, opts)
List volume labels
List all the the labels for the specified volume.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
volumeId | string | The unique ID of the volume. | [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
datacentersVolumesLabelsPost
datacentersVolumesLabelsPost(datacenterId, volumeId, label, opts)
Create a Volume Label
Adds a new label to the specified volume.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
volumeId | string | The unique ID of the volume. | [default to undefined] |
label | The label to create. | ||
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
datacentersVolumesLabelsPut
datacentersVolumesLabelsPut(datacenterId, volumeId, key, label, opts)
Modify a Volume Label
Modifies the specified volume label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the data center. | [default to undefined] |
volumeId | string | The unique ID of the volume. | [default to undefined] |
key | string | The label key | [default to undefined] |
label | The modified label | ||
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
ipblocksLabelsDelete
ipblocksLabelsDelete(ipblockId, key, opts)
Delete IP block labels
Delete the specified IP block label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the IP block. | [default to undefined] |
key | string | The label key | [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
ipblocksLabelsFindByKey
ipblocksLabelsFindByKey(ipblockId, key, opts)
Retrieve IP block labels
Retrieve the properties of the specified IP block label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the IP block. | [default to undefined] |
key | string | The label key | [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
ipblocksLabelsGet
ipblocksLabelsGet(ipblockId, opts)
List IP block labels
List all the the labels for the specified IP block.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the IP block. | [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
ipblocksLabelsPost
ipblocksLabelsPost(ipblockId, label, opts)
Create IP block labels
Add a new label to the specified IP block.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the IP block. | [default to undefined] |
label | The label to create. | ||
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
ipblocksLabelsPut
ipblocksLabelsPut(ipblockId, key, label, opts)
Modify a IP Block Label by ID
Modifies the specified IP block label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the IP block. | [default to undefined] |
key | string | The label key | [default to undefined] |
label | The modified label | ||
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
labelsFindByUrn
labelsFindByUrn(labelurn, opts)
Retrieve labels by URN
Retrieve a label by label URN. The URN is unique for each label, and consists of: urn🏷️<resource_type>:<resource_uuid>:
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
labelurn | string | The label URN; URN is unique for each label, and consists of: urn🏷️<resource_type>:<resource_uuid>:<key><key> | [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
labelsGet
labelsGet(opts)
List labels
List all available labels.
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
snapshotsLabelsDelete
snapshotsLabelsDelete(snapshotId, key, opts)
Delete snapshot labels
Delete the specified snapshot label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the snapshot. | [default to undefined] |
key | string | The label key | [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
snapshotsLabelsFindByKey
snapshotsLabelsFindByKey(snapshotId, key, opts)
Retrieve snapshot labels
Retrieve the properties of the specified snapshot label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the snapshot. | [default to undefined] |
key | string | The label key | [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
snapshotsLabelsGet
snapshotsLabelsGet(snapshotId, opts)
List snapshot labels
List all the the labels for 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
snapshotsLabelsPost
snapshotsLabelsPost(snapshotId, label, opts)
Create a Snapshot Label
Adds a new label to the specified snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the snapshot. | [default to undefined] |
label | The label to create. | ||
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
snapshotsLabelsPut
snapshotsLabelsPut(snapshotId, key, label, opts)
Modify a Snapshot Label by ID
Modifies the specified snapshot label.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the snapshot. | [default to undefined] |
key | string | The label key | [default to undefined] |
label | The modified label | ||
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