LabelApi
All URIs are relative to https://api.ionos.com/cloudapi/v5
Method | HTTP request | Description |
---|---|---|
DELETE /datacenters/{datacenterId}/labels/{key} | Delete a Label from Data Center | |
GET /datacenters/{datacenterId}/labels/{key} | Retrieve a Label of Data Center | |
GET /datacenters/{datacenterId}/labels | List all Data Center Labels | |
POST /datacenters/{datacenterId}/labels | Add a Label to Data Center | |
PUT /datacenters/{datacenterId}/labels/{key} | Modify a Label of Data Center | |
DELETE /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Delete a Label from Server | |
GET /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Retrieve a Label of Server | |
GET /datacenters/{datacenterId}/servers/{serverId}/labels | List all Server Labels | |
POST /datacenters/{datacenterId}/servers/{serverId}/labels | Add a Label to Server | |
PUT /datacenters/{datacenterId}/servers/{serverId}/labels/{key} | Modify a Label of Server | |
DELETE /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Delete a Label from Volume | |
GET /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Retrieve a Label of Volume | |
GET /datacenters/{datacenterId}/volumes/{volumeId}/labels | List all Volume Labels | |
POST /datacenters/{datacenterId}/volumes/{volumeId}/labels | Add a Label to Volume | |
PUT /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key} | Modify a Label of Volume | |
DELETE /ipblocks/{ipblockId}/labels/{key} | Delete a Label from IP Block | |
GET /ipblocks/{ipblockId}/labels/{key} | Retrieve a Label of IP Block | |
GET /ipblocks/{ipblockId}/labels | List all Ip Block Labels | |
POST /ipblocks/{ipblockId}/labels | Add a Label to IP Block | |
PUT /ipblocks/{ipblockId}/labels/{key} | Modify a Label of IP Block | |
GET /labels/{labelurn} | Returns the label by its URN. | |
GET /labels | List Labels | |
DELETE /snapshots/{snapshotId}/labels/{key} | Delete a Label from Snapshot | |
GET /snapshots/{snapshotId}/labels/{key} | Retrieve a Label of Snapshot | |
GET /snapshots/{snapshotId}/labels | List all Snapshot Labels | |
POST /snapshots/{snapshotId}/labels | Add a Label to Snapshot | |
PUT /snapshots/{snapshotId}/labels/{key} | Modify a Label of Snapshot |
datacentersLabelsDelete
object datacentersLabelsDelete(datacenterId, key, opts)
Delete a Label from Data Center
This will remove a label from the data center.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Data Center | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersLabelsFindByKey
datacentersLabelsFindByKey(datacenterId, key, opts)
Retrieve a Label of Data Center
This will retrieve the properties of a associated label to a data center.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Data Center | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 all Data Center Labels
You can retrieve a list of all labels associated with a data center
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Data Center | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
offset | number | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) | [optional][default to 0] |
limit | number | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersLabelsPost
datacentersLabelsPost(datacenterId, label, opts)
Add a Label to Data Center
This will add a label to the data center.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Data Center | [default to undefined] |
label | Label to be added | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 Label of Data Center
This will modify the value of the label on a data center.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Data Center | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
label | Modified Label | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersServersLabelsDelete
object datacentersServersLabelsDelete(datacenterId, serverId, key, opts)
Delete a Label from Server
This will remove a label from the server.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
serverId | string | The unique ID of the Server | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersServersLabelsFindByKey
datacentersServersLabelsFindByKey(datacenterId, serverId, key, opts)
Retrieve a Label of Server
This will retrieve the properties of a associated label to a server.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
serverId | string | The unique ID of the Server | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 all Server Labels
You can retrieve a list of all labels associated with a server
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
serverId | string | The unique ID of the Server | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
offset | number | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) | [optional][default to 0] |
limit | number | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersServersLabelsPost
datacentersServersLabelsPost(datacenterId, serverId, label, opts)
Add a Label to Server
This will add a label to the server.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
serverId | string | The unique ID of the Server | [default to undefined] |
label | Label to be added | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 Label of Server
This will modify the value of the label on a server.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
serverId | string | The unique ID of the Server | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
label | Modified Label | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacentersVolumesLabelsDelete
object datacentersVolumesLabelsDelete(datacenterId, volumeId, key, opts)
Delete a Label from Volume
This will remove a label from the volume.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
volumeId | string | The unique ID of the Volume | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersVolumesLabelsFindByKey
datacentersVolumesLabelsFindByKey(datacenterId, volumeId, key, opts)
Retrieve a Label of Volume
This will retrieve the properties of a associated label to a volume.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
volumeId | string | The unique ID of the Volume | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 all Volume Labels
You can retrieve a list of all labels associated with a volume
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
volumeId | string | The unique ID of the Volume | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
offset | number | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) | [optional][default to 0] |
limit | number | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacentersVolumesLabelsPost
datacentersVolumesLabelsPost(datacenterId, volumeId, label, opts)
Add a Label to Volume
This will add a label to the volume.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
volumeId | string | The unique ID of the Volume | [default to undefined] |
label | Label to be added | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 Label of Volume
This will modify the value of the label on a volume.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenterId | string | The unique ID of the Datacenter | [default to undefined] |
volumeId | string | The unique ID of the Volume | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
label | Modified Label | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
ipblocksLabelsDelete
object ipblocksLabelsDelete(ipblockId, key, opts)
Delete a Label from IP Block
This will remove a label from the Ip Block.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the Ip Block | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
ipblocksLabelsFindByKey
ipblocksLabelsFindByKey(ipblockId, key, opts)
Retrieve a Label of IP Block
This will retrieve the properties of a associated label to a Ip Block.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the Ip Block | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 all Ip Block Labels
You can retrieve a list of all labels associated with a IP Block
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the Ip Block | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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)
Add a Label to IP Block
This will add a label to the Ip Block.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the Ip Block | [default to undefined] |
label | Label to be added | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 Label of IP Block
This will modify the value of the label on a Ip Block.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ipblockId | string | The unique ID of the Ip Block | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
label | Modified Label | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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)
Returns the label by its URN.
You can retrieve the details of a specific label using its URN. A URN is for uniqueness of a Label and composed using urn🏷️::
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
labelurn | string | The URN representing the unique ID of the label. A URN is for uniqueness of a Label and composed using urn🏷️<resource_type>:<resource_uuid>:<key> | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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
You can retrieve a complete list of labels that you have access to.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
snapshotsLabelsDelete
object snapshotsLabelsDelete(snapshotId, key, opts)
Delete a Label from Snapshot
This will remove a label from the snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the Snapshot | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional][default to undefined] |
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
snapshotsLabelsFindByKey
snapshotsLabelsFindByKey(snapshotId, key, opts)
Retrieve a Label of Snapshot
This will retrieve the properties of a associated label to a snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the Snapshot | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 all Snapshot Labels
You can retrieve a list of all labels associated with a snapshot
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the Snapshot | [default to undefined] |
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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)
Add a Label to Snapshot
This will add a label to the snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the Snapshot | [default to undefined] |
label | Label to be added | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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 Label of Snapshot
This will modify the value of the label on a snapshot.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
snapshotId | string | The unique ID of the Snapshot | [default to undefined] |
key | string | The key of the Label | [default to undefined] |
label | Modified Label | ||
pretty | boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | number | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) 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 having more than 1 contract need to provide contract number, against which all API requests should 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