Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersLabelsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersLabelsDelete instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {apiInstance.datacentersLabelsDeleteWithHttpInfo(datacenterId, key, pretty, depth, xContractNumber); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsDelete");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
Retrieve the properties of the specified data center label.
Parameters
Name
Type
Description
Notes
datacenterId
String
The unique ID of the data center.
key
String
The label key
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersLabelsFindByKeyWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersLabelsFindByKey instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersLabelsFindByKeyWithHttpInfo(datacenterId, key, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.datacentersLabelsFindByKey(datacenterId, key).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
List all the the labels for the specified data center.
Parameters
Name
Type
Description
Notes
datacenterId
String
The unique ID of the data center.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
⚠️ Note: the example bellow uses the datacentersLabelsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersLabelsGet instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.String orderBy ="orderBy_example"; // String | Order by fieldInteger maxResults ="maxResults_example"; // Integer | Maximum number of results to returnMap<String,String> filters =newHashMap<String,String>(); // Map<String, String> | Filter results by fieldtry {ApiResponse<LabelResources> result =apiInstance.datacentersLabelsGetWithHttpInfo(datacenterId, pretty, depth, xContractNumber, orderBy, maxResults, filters);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResources result =apiInstance.datacentersLabelsGet(datacenterId).pretty(true).depth(0).xContractNumber(56).orderBy("orderBy_example").maxResults(5).filters(filters).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersLabelsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersLabelsPost instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center. properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The label to create.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersLabelsPostWithHttpInfo(datacenterId, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.datacentersLabelsPost(datacenterId, label).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersLabelsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersLabelsPut instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String key ="key_example"; // String | The label key properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The modified labelBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersLabelsPutWithHttpInfo(datacenterId, key, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsPut");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.datacentersLabelsPut(datacenterId, key, label).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersLabelsPut");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersServersLabelsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersServersLabelsDelete instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String serverId ="serverId_example"; // String | The unique ID of the server.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {apiInstance.datacentersServersLabelsDeleteWithHttpInfo(datacenterId, serverId, key, pretty, depth, xContractNumber); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersServersLabelsDelete");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
Retrieve the properties of the specified server label.
Parameters
Name
Type
Description
Notes
datacenterId
String
The unique ID of the data center.
serverId
String
The unique ID of the server.
key
String
The label key
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersServersLabelsFindByKeyWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersServersLabelsFindByKey instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String serverId ="serverId_example"; // String | The unique ID of the server.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersServersLabelsFindByKeyWithHttpInfo(datacenterId, serverId, key, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersServersLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.datacentersServersLabelsFindByKey(datacenterId, serverId, key).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersServersLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
⚠️ Note: the example bellow uses the datacentersServersLabelsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersServersLabelsGet instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String serverId ="serverId_example"; // String | The unique ID of the server.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.String orderBy ="orderBy_example"; // String | Order by fieldInteger maxResults ="maxResults_example"; // Integer | Maximum number of results to returnMap<String,String> filters =newHashMap<String,String>(); // Map<String, String> | Filter results by fieldtry {ApiResponse<LabelResources> result =apiInstance.datacentersServersLabelsGetWithHttpInfo(datacenterId, serverId, pretty, depth, xContractNumber, orderBy, maxResults, filters);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersServersLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResources result =apiInstance.datacentersServersLabelsGet(datacenterId, serverId).pretty(true).depth(0).xContractNumber(56).orderBy("orderBy_example").maxResults(5).filters(filters).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersServersLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersServersLabelsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersServersLabelsPost instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String serverId ="serverId_example"; // String | The unique ID of the server. properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The label to create.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersServersLabelsPostWithHttpInfo(datacenterId, serverId, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersServersLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.datacentersServersLabelsPost(datacenterId, serverId, label).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersServersLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersServersLabelsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersServersLabelsPut instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String serverId ="serverId_example"; // String | The unique ID of the server.String key ="key_example"; // String | The label key properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The modified labelBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersServersLabelsPutWithHttpInfo(datacenterId, serverId, key, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersServersLabelsPut");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the datacentersVolumesLabelsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersVolumesLabelsDelete instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String volumeId ="volumeId_example"; // String | The unique ID of the volume.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {apiInstance.datacentersVolumesLabelsDeleteWithHttpInfo(datacenterId, volumeId, key, pretty, depth, xContractNumber); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersVolumesLabelsDelete");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
Retrieve the properties of the specified volume label.
Parameters
Name
Type
Description
Notes
datacenterId
String
The unique ID of the data center.
volumeId
String
The unique ID of the volume.
key
String
The label key
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersVolumesLabelsFindByKeyWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersVolumesLabelsFindByKey instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String volumeId ="volumeId_example"; // String | The unique ID of the volume.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersVolumesLabelsFindByKeyWithHttpInfo(datacenterId, volumeId, key, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersVolumesLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.datacentersVolumesLabelsFindByKey(datacenterId, volumeId, key).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersVolumesLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
⚠️ Note: the example bellow uses the datacentersVolumesLabelsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersVolumesLabelsGet instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String volumeId ="volumeId_example"; // String | The unique ID of the volume.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.String orderBy ="orderBy_example"; // String | Order by fieldInteger maxResults ="maxResults_example"; // Integer | Maximum number of results to returnMap<String,String> filters =newHashMap<String,String>(); // Map<String, String> | Filter results by fieldtry {ApiResponse<LabelResources> result =apiInstance.datacentersVolumesLabelsGetWithHttpInfo(datacenterId, volumeId, pretty, depth, xContractNumber, orderBy, maxResults, filters);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersVolumesLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResources result =apiInstance.datacentersVolumesLabelsGet(datacenterId, volumeId).pretty(true).depth(0).xContractNumber(56).orderBy("orderBy_example").maxResults(5).filters(filters).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersVolumesLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersVolumesLabelsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersVolumesLabelsPost instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String volumeId ="volumeId_example"; // String | The unique ID of the volume. properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The label to create.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersVolumesLabelsPostWithHttpInfo(datacenterId, volumeId, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersVolumesLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.datacentersVolumesLabelsPost(datacenterId, volumeId, label).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersVolumesLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the datacentersVolumesLabelsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use datacentersVolumesLabelsPut instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String datacenterId ="datacenterId_example"; // String | The unique ID of the data center.String volumeId ="volumeId_example"; // String | The unique ID of the volume.String key ="key_example"; // String | The label key properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The modified labelBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.datacentersVolumesLabelsPutWithHttpInfo(datacenterId, volumeId, key, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#datacentersVolumesLabelsPut");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the ipblocksLabelsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use ipblocksLabelsDelete instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String ipblockId ="ipblockId_example"; // String | The unique ID of the IP block.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {apiInstance.ipblocksLabelsDeleteWithHttpInfo(ipblockId, key, pretty, depth, xContractNumber); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsDelete");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
Retrieve the properties of the specified IP block label.
Parameters
Name
Type
Description
Notes
ipblockId
String
The unique ID of the IP block.
key
String
The label key
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the ipblocksLabelsFindByKeyWithHttpInfo which also returns the status code and the headers, if you don't need them you may use ipblocksLabelsFindByKey instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String ipblockId ="ipblockId_example"; // String | The unique ID of the IP block.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.ipblocksLabelsFindByKeyWithHttpInfo(ipblockId, key, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.ipblocksLabelsFindByKey(ipblockId, key).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
List all the the labels for the specified IP block.
Parameters
Name
Type
Description
Notes
ipblockId
String
The unique ID of the IP block.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
⚠️ Note: the example bellow uses the ipblocksLabelsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use ipblocksLabelsGet instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String ipblockId ="ipblockId_example"; // String | The unique ID of the IP block.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.String orderBy ="orderBy_example"; // String | Order by fieldInteger maxResults ="maxResults_example"; // Integer | Maximum number of results to returnMap<String,String> filters =newHashMap<String,String>(); // Map<String, String> | Filter results by fieldtry {ApiResponse<LabelResources> result =apiInstance.ipblocksLabelsGetWithHttpInfo(ipblockId, pretty, depth, xContractNumber, orderBy, maxResults, filters);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResources result =apiInstance.ipblocksLabelsGet(ipblockId).pretty(true).depth(0).xContractNumber(56).orderBy("orderBy_example").maxResults(5).filters(filters).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the ipblocksLabelsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use ipblocksLabelsPost instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String ipblockId ="ipblockId_example"; // String | The unique ID of the IP block. properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The label to create.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.ipblocksLabelsPostWithHttpInfo(ipblockId, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.ipblocksLabelsPost(ipblockId, label).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the ipblocksLabelsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use ipblocksLabelsPut instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String ipblockId ="ipblockId_example"; // String | The unique ID of the IP block.String key ="key_example"; // String | The label key properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The modified labelBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.ipblocksLabelsPutWithHttpInfo(ipblockId, key, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsPut");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.ipblocksLabelsPut(ipblockId, key, label).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#ipblocksLabelsPut");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Retrieve a label by label URN. The URN is unique for each label, and consists of: urn🏷️<resource_type>:<resource_uuid>:<key>
Parameters
Name
Type
Description
Notes
labelurn
String
The label URN; URN is unique for each label, and consists of: urn🏷️<resource_type>:<resource_uuid>:<key><key>
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the labelsFindByUrnWithHttpInfo which also returns the status code and the headers, if you don't need them you may use labelsFindByUrn instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String labelurn ="labelurn_example"; // String | The label URN; URN is unique for each label, and consists of: urn:label:<resource_type>:<resource_uuid>:<key><key>Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<Label> result =apiInstance.labelsFindByUrnWithHttpInfo(labelurn, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#labelsFindByUrn");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {Label result =apiInstance.labelsFindByUrn(labelurn).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#labelsFindByUrn");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
labelsGet
Labels labelsGet(pretty, depth, xContractNumber)
List labels
List all available labels.
Parameters
Name
Type
Description
Notes
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
⚠️ Note: the example bellow uses the labelsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use labelsGet instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.String orderBy ="orderBy_example"; // String | Order by fieldInteger maxResults ="maxResults_example"; // Integer | Maximum number of results to returnMap<String,String> filters =newHashMap<String,String>(); // Map<String, String> | Filter results by fieldtry {ApiResponse<Labels> result =apiInstance.labelsGetWithHttpInfo(pretty, depth, xContractNumber, orderBy, maxResults, filters);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#labelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {Labels result =apiInstance.labelsGet().pretty(true).depth(0).xContractNumber(56).orderBy("orderBy_example").maxResults(5).filters(filters).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#labelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
Return type
null (empty response body)
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the snapshotsLabelsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsLabelsDelete instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String snapshotId ="snapshotId_example"; // String | The unique ID of the snapshot.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {apiInstance.snapshotsLabelsDeleteWithHttpInfo(snapshotId, key, pretty, depth, xContractNumber); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsDelete");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
Retrieve the properties of the specified snapshot label.
Parameters
Name
Type
Description
Notes
snapshotId
String
The unique ID of the snapshot.
key
String
The label key
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the snapshotsLabelsFindByKeyWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsLabelsFindByKey instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String snapshotId ="snapshotId_example"; // String | The unique ID of the snapshot.String key ="key_example"; // String | The label keyBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.snapshotsLabelsFindByKeyWithHttpInfo(snapshotId, key, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.snapshotsLabelsFindByKey(snapshotId, key).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsFindByKey");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
List all the the labels for the specified snapshot.
Parameters
Name
Type
Description
Notes
snapshotId
String
The unique ID of the snapshot.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
⚠️ Note: the example bellow uses the snapshotsLabelsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsLabelsGet instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String snapshotId ="snapshotId_example"; // String | The unique ID of the snapshot.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.String orderBy ="orderBy_example"; // String | Order by fieldInteger maxResults ="maxResults_example"; // Integer | Maximum number of results to returnMap<String,String> filters =newHashMap<String,String>(); // Map<String, String> | Filter results by fieldtry {ApiResponse<LabelResources> result =apiInstance.snapshotsLabelsGetWithHttpInfo(snapshotId, pretty, depth, xContractNumber, orderBy, maxResults, filters);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResources result =apiInstance.snapshotsLabelsGet(snapshotId).pretty(true).depth(0).xContractNumber(56).orderBy("orderBy_example").maxResults(5).filters(filters).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsGet");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the snapshotsLabelsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsLabelsPost instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String snapshotId ="snapshotId_example"; // String | The unique ID of the snapshot. properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The label to create.Boolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.snapshotsLabelsPostWithHttpInfo(snapshotId, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.snapshotsLabelsPost(snapshotId, label).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsPost");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
⚠️ Note: the example bellow uses the snapshotsLabelsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use snapshotsLabelsPut instead
Example
// Import classes:importcom.ionoscloud.ApiClient;importcom.ionoscloud.ApiException;importcom.ionoscloud.ApiResponse;importcom.ionoscloud.Configuration;importcom.ionoscloud.auth.*;importcom.ionoscloud.model.*;importcom.ionoscloud.api.LabelsApi;publicclassExample {publicstaticvoidmain(String[] args) {ApiClient defaultClient =Configuration.getDefaultApiClient();// Configure HTTP basic authorization: Basic AuthenticationHttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");basicAuthentication.setUsername("YOUR USERNAME");basicAuthentication.setPassword("YOUR PASSWORD");// Configure Api Key authorization: Token AuthenticationdefaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");LabelsApi apiInstance =newLabelsApi(defaultClient);String snapshotId ="snapshotId_example"; // String | The unique ID of the snapshot.String key ="key_example"; // String | The label key properties =newLabelResourceProperties(); // LabelResourceProperties | label =newLabelResource(LabelResourceProperties); // LabelResource | The modified labelBoolean pretty =true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines). Integer depth = 0; // Integer | 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
Integer xContractNumber =56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.try {ApiResponse<LabelResource> result =apiInstance.snapshotsLabelsPutWithHttpInfo(snapshotId, key, label, pretty, depth, xContractNumber);System.out.println("Response: "+result.getData());System.out.println("Status Code: "+result.getStatusCode());System.out.println("Headers: "+result.getHeaders()); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsPut");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); } }}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {LabelResource result =apiInstance.snapshotsLabelsPut(snapshotId, key, label).pretty(true).depth(0).xContractNumber(56).execute();System.out.println(result); } catch (ApiException e) {System.err.println("Exception when calling LabelsApi#snapshotsLabelsPut");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace(); }