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 |
datacenters_labels_delete
Object datacenters_labels_delete(datacenter_id, key, opts)
Delete a Label from Data Center
This will remove a label from the data center.
Examples
Using the datacenters_labels_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> datacenters_labels_delete_with_http_info(datacenter_id, key, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Data Center | |
key | String | The key of the Label | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_labels_find_by_key
datacenters_labels_find_by_key(datacenter_id, key, opts)
Retrieve a Label of Data Center
This will retrieve the properties of a associated label to a data center.
Examples
Using the datacenters_labels_find_by_key_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_labels_find_by_key_with_http_info(datacenter_id, key, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Data Center | |
key | String | The key of the Label | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_labels_get
datacenters_labels_get(datacenter_id, opts)
List all Data Center Labels
You can retrieve a list of all labels associated with a data center
Examples
Using the datacenters_labels_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_labels_get_with_http_info(datacenter_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Data Center | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
offset | Integer | 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 | Integer | 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
datacenters_labels_post
datacenters_labels_post(datacenter_id, label, opts)
Add a Label to Data Center
This will add a label to the data center.
Examples
Using the datacenters_labels_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_labels_post_with_http_info(datacenter_id, label, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Data Center | |
label | Label to be added | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_labels_put
datacenters_labels_put(datacenter_id, key, label, opts)
Modify a Label of Data Center
This will modify the value of the label on a data center.
Examples
Using the datacenters_labels_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_labels_put_with_http_info(datacenter_id, key, label, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Data Center | |
key | String | The key of the Label | |
label | Modified Label | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_servers_labels_delete
Object datacenters_servers_labels_delete(datacenter_id, server_id, key, opts)
Delete a Label from Server
This will remove a label from the server.
Examples
Using the datacenters_servers_labels_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> datacenters_servers_labels_delete_with_http_info(datacenter_id, server_id, key, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
server_id | String | The unique ID of the Server | |
key | String | The key of the Label | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_servers_labels_find_by_key
datacenters_servers_labels_find_by_key(datacenter_id, server_id, key, opts)
Retrieve a Label of Server
This will retrieve the properties of a associated label to a server.
Examples
Using the datacenters_servers_labels_find_by_key_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_labels_find_by_key_with_http_info(datacenter_id, server_id, key, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
server_id | String | The unique ID of the Server | |
key | String | The key of the Label | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_servers_labels_get
datacenters_servers_labels_get(datacenter_id, server_id, opts)
List all Server Labels
You can retrieve a list of all labels associated with a server
Examples
Using the datacenters_servers_labels_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_labels_get_with_http_info(datacenter_id, server_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
server_id | String | The unique ID of the Server | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
offset | Integer | 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 | Integer | 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
datacenters_servers_labels_post
datacenters_servers_labels_post(datacenter_id, server_id, label, opts)
Add a Label to Server
This will add a label to the server.
Examples
Using the datacenters_servers_labels_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_labels_post_with_http_info(datacenter_id, server_id, label, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
server_id | String | The unique ID of the Server | |
label | Label to be added | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_servers_labels_put
datacenters_servers_labels_put(datacenter_id, server_id, key, label, opts)
Modify a Label of Server
This will modify the value of the label on a server.
Examples
Using the datacenters_servers_labels_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_servers_labels_put_with_http_info(datacenter_id, server_id, key, label, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
server_id | String | The unique ID of the Server | |
key | String | The key of the Label | |
label | Modified Label | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_volumes_labels_delete
Object datacenters_volumes_labels_delete(datacenter_id, volume_id, key, opts)
Delete a Label from Volume
This will remove a label from the volume.
Examples
Using the datacenters_volumes_labels_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> datacenters_volumes_labels_delete_with_http_info(datacenter_id, volume_id, key, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
volume_id | String | The unique ID of the Volume | |
key | String | The key of the Label | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_volumes_labels_find_by_key
datacenters_volumes_labels_find_by_key(datacenter_id, volume_id, key, opts)
Retrieve a Label of Volume
This will retrieve the properties of a associated label to a volume.
Examples
Using the datacenters_volumes_labels_find_by_key_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_volumes_labels_find_by_key_with_http_info(datacenter_id, volume_id, key, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
volume_id | String | The unique ID of the Volume | |
key | String | The key of the Label | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
datacenters_volumes_labels_get
datacenters_volumes_labels_get(datacenter_id, volume_id, opts)
List all Volume Labels
You can retrieve a list of all labels associated with a volume
Examples
Using the datacenters_volumes_labels_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_volumes_labels_get_with_http_info(datacenter_id, volume_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
volume_id | String | The unique ID of the Volume | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
offset | Integer | 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 | Integer | 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
datacenters_volumes_labels_post
datacenters_volumes_labels_post(datacenter_id, volume_id, label, opts)
Add a Label to Volume
This will add a label to the volume.
Examples
Using the datacenters_volumes_labels_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> datacenters_volumes_labels_post_with_http_info(datacenter_id, volume_id, label, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
datacenter_id | String | The unique ID of the Datacenter | |
volume_id | String | The unique ID of the Volume | |
label | Label to be added | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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] |
x_contract_number | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
datacenters_volumes_labels_put
datacenters_volumes_labels_put(datacenter_id, volume_id, key, label, opts)
Modify a Label of Volume
This will modify the value of the label on a volume.