LabelsApi

LabelsApi

All URIs are relative to https://api.ionos.com/cloudapi/v6

MethodHTTP requestDescription

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

datacenters_labels_delete

datacenters_labels_delete(datacenter_id, key, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Delete data center labels

Delete the specified data center label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    key = 'key_example' # str | The label key
    try:
        # Delete data center labels
        api_instance.datacenters_labels_delete(datacenter_id, key)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_labels_delete: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

key

str

The label key

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_labels_find_by_key

LabelResource datacenters_labels_find_by_key(datacenter_id, key, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Retrieve data center labels

Retrieve the properties of the specified data center label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    key = 'key_example' # str | The label key
    try:
        # Retrieve data center labels
        api_response = api_instance.datacenters_labels_find_by_key(datacenter_id, key)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_labels_find_by_key: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

key

str

The label key

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_labels_get

LabelResources datacenters_labels_get(datacenter_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

List data center labels

List all the the labels for the specified data center.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    try:
        # List data center labels
        api_response = api_instance.datacenters_labels_get(datacenter_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_labels_get: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResources

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_labels_post

LabelResource datacenters_labels_post(datacenter_id, label, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Create a Data Center Label

Adds a new label to the specified data center.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    label = ionoscloud.LabelResource() # LabelResource | The label to create.
    try:
        # Create a Data Center Label
        api_response = api_instance.datacenters_labels_post(datacenter_id, label)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_labels_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

label

The label to create.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_labels_put

LabelResource datacenters_labels_put(datacenter_id, key, label, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Modify a Data Center Label by Key

Modifies the specified data center label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    key = 'key_example' # str | The label key
    label = ionoscloud.LabelResource() # LabelResource | The modified label
    try:
        # Modify a Data Center Label by Key
        api_response = api_instance.datacenters_labels_put(datacenter_id, key, label)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_labels_put: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

key

str

The label key

label

The modified label

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_servers_labels_delete

datacenters_servers_labels_delete(datacenter_id, server_id, key, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Delete server labels

Delete the specified server label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    key = 'key_example' # str | The label key
    try:
        # Delete server labels
        api_instance.datacenters_servers_labels_delete(datacenter_id, server_id, key)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_servers_labels_delete: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

key

str

The label key

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_labels_find_by_key

LabelResource datacenters_servers_labels_find_by_key(datacenter_id, server_id, key, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Retrieve server labels

Retrieve the properties of the specified server label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    key = 'key_example' # str | The label key
    try:
        # Retrieve server labels
        api_response = api_instance.datacenters_servers_labels_find_by_key(datacenter_id, server_id, key)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_servers_labels_find_by_key: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

key

str

The label key

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_labels_get

LabelResources datacenters_servers_labels_get(datacenter_id, server_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

List server labels

List all the the labels for the specified server.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    try:
        # List server labels
        api_response = api_instance.datacenters_servers_labels_get(datacenter_id, server_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_servers_labels_get: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResources

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_servers_labels_post

LabelResource datacenters_servers_labels_post(datacenter_id, server_id, label, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Create a Server Label

Adds a new label to the specified server.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    label = ionoscloud.LabelResource() # LabelResource | The label to create.
    try:
        # Create a Server Label
        api_response = api_instance.datacenters_servers_labels_post(datacenter_id, server_id, label)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_servers_labels_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

label

The label to create.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_servers_labels_put

LabelResource datacenters_servers_labels_put(datacenter_id, server_id, key, label, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Modify a Server Label

Modifies the specified server label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    server_id = 'server_id_example' # str | The unique ID of the server.
    key = 'key_example' # str | The label key
    label = ionoscloud.LabelResource() # LabelResource | The modified label
    try:
        # Modify a Server Label
        api_response = api_instance.datacenters_servers_labels_put(datacenter_id, server_id, key, label)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_servers_labels_put: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

server_id

str

The unique ID of the server.

key

str

The label key

label

The modified label

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_volumes_labels_delete

datacenters_volumes_labels_delete(datacenter_id, volume_id, key, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Delete volume labels

Delete the specified volume label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    volume_id = 'volume_id_example' # str | The unique ID of the volume.
    key = 'key_example' # str | The label key
    try:
        # Delete volume labels
        api_instance.datacenters_volumes_labels_delete(datacenter_id, volume_id, key)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_volumes_labels_delete: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

volume_id

str

The unique ID of the volume.

key

str

The label key

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_volumes_labels_find_by_key

LabelResource datacenters_volumes_labels_find_by_key(datacenter_id, volume_id, key, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Retrieve volume labels

Retrieve the properties of the specified volume label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    volume_id = 'volume_id_example' # str | The unique ID of the volume.
    key = 'key_example' # str | The label key
    try:
        # Retrieve volume labels
        api_response = api_instance.datacenters_volumes_labels_find_by_key(datacenter_id, volume_id, key)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_volumes_labels_find_by_key: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

volume_id

str

The unique ID of the volume.

key

str

The label key

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_volumes_labels_get

LabelResources datacenters_volumes_labels_get(datacenter_id, volume_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

List volume labels

List all the the labels for the specified volume.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    volume_id = 'volume_id_example' # str | The unique ID of the volume.
    try:
        # List volume labels
        api_response = api_instance.datacenters_volumes_labels_get(datacenter_id, volume_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_volumes_labels_get: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

volume_id

str

The unique ID of the volume.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResources

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

datacenters_volumes_labels_post

LabelResource datacenters_volumes_labels_post(datacenter_id, volume_id, label, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Create a Volume Label

Adds a new label to the specified volume.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    volume_id = 'volume_id_example' # str | The unique ID of the volume.
    label = ionoscloud.LabelResource() # LabelResource | The label to create.
    try:
        # Create a Volume Label
        api_response = api_instance.datacenters_volumes_labels_post(datacenter_id, volume_id, label)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_volumes_labels_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

volume_id

str

The unique ID of the volume.

label

The label to create.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

datacenters_volumes_labels_put

LabelResource datacenters_volumes_labels_put(datacenter_id, volume_id, key, label, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Modify a Volume Label

Modifies the specified volume label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    datacenter_id = 'datacenter_id_example' # str | The unique ID of the data center.
    volume_id = 'volume_id_example' # str | The unique ID of the volume.
    key = 'key_example' # str | The label key
    label = ionoscloud.LabelResource() # LabelResource | The modified label
    try:
        # Modify a Volume Label
        api_response = api_instance.datacenters_volumes_labels_put(datacenter_id, volume_id, key, label)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.datacenters_volumes_labels_put: %s\n' % e)

Parameters

NameTypeDescriptionNotes

datacenter_id

str

The unique ID of the data center.

volume_id

str

The unique ID of the volume.

key

str

The label key

label

The modified label

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

ipblocks_labels_delete

ipblocks_labels_delete(ipblock_id, key, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Delete IP block labels

Delete the specified IP block label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    ipblock_id = 'ipblock_id_example' # str | The unique ID of the IP block.
    key = 'key_example' # str | The label key
    try:
        # Delete IP block labels
        api_instance.ipblocks_labels_delete(ipblock_id, key)
    except ApiException as e:
        print('Exception when calling LabelsApi.ipblocks_labels_delete: %s\n' % e)

Parameters

NameTypeDescriptionNotes

ipblock_id

str

The unique ID of the IP block.

key

str

The label key

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

void (empty response body)

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

ipblocks_labels_find_by_key

LabelResource ipblocks_labels_find_by_key(ipblock_id, key, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Retrieve IP block labels

Retrieve the properties of the specified IP block label.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    ipblock_id = 'ipblock_id_example' # str | The unique ID of the IP block.
    key = 'key_example' # str | The label key
    try:
        # Retrieve IP block labels
        api_response = api_instance.ipblocks_labels_find_by_key(ipblock_id, key)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.ipblocks_labels_find_by_key: %s\n' % e)

Parameters

NameTypeDescriptionNotes

ipblock_id

str

The unique ID of the IP block.

key

str

The label key

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

ipblocks_labels_get

LabelResources ipblocks_labels_get(ipblock_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

List IP block labels

List all the the labels for the specified IP block.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    ipblock_id = 'ipblock_id_example' # str | The unique ID of the IP block.
    try:
        # List IP block labels
        api_response = api_instance.ipblocks_labels_get(ipblock_id)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.ipblocks_labels_get: %s\n' % e)

Parameters

NameTypeDescriptionNotes

ipblock_id

str

The unique ID of the IP block.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResources

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

ipblocks_labels_post

LabelResource ipblocks_labels_post(ipblock_id, label, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Create IP block labels

Add a new label to the specified IP block.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException

# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
    host = 'https://api.ionos.com/cloudapi/v6',
)

# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

with ionoscloud.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud.LabelsApi(api_client)
    ipblock_id = 'ipblock_id_example' # str | The unique ID of the IP block.
    label = ionoscloud.LabelResource() # LabelResource | The label to create.
    try:
        # Create IP block labels
        api_response = api_instance.ipblocks_labels_post(ipblock_id, label)
        print(api_response)
    except ApiException as e:
        print('Exception when calling LabelsApi.ipblocks_labels_post: %s\n' % e)

Parameters

NameTypeDescriptionNotes

ipblock_id

str

The unique ID of the IP block.

label

The label to create.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[optional] [default to True]

depth

int

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]

x_contract_number

int

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

[optional]

Return type

LabelResource

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

ipblocks_labels_put

LabelResource ipblocks_labels_put(ipblock_id, key, label, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Modify a IP Block Label by ID

Modifies the specified IP block label.

Example

from __future__ import print_function