TargetGroupsApi

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

Method	HTTP request	Description
targetGroupsDelete	DELETE /targetgroups/{targetGroupId}	Delete a Target Group by ID
targetgroupsFindByTargetGroupId	GET /targetgroups/{targetGroupId}	Get a Target Group by ID
targetgroupsGet	GET /targetgroups	Get Target Groups
targetgroupsPatch	PATCH /targetgroups/{targetGroupId}	Partially Modify a Target Group by ID
targetgroupsPost	POST /targetgroups	Create a Target Group
targetgroupsPut	PUT /targetgroups/{targetGroupId}	Modify a Target Group by ID

Method

HTTP request

Description

targetGroupsDelete

DELETE /targetgroups/{targetGroupId}

Delete a Target Group by ID

targetgroupsFindByTargetGroupId

GET /targetgroups/{targetGroupId}

Get a Target Group by ID

targetgroupsGet

GET /targetgroups

Get Target Groups

targetgroupsPatch

PATCH /targetgroups/{targetGroupId}

Partially Modify a Target Group by ID

targetgroupsPost

POST /targetgroups

Create a Target Group

targetgroupsPut

PUT /targetgroups/{targetGroupId}

Modify a Target Group by ID

targetGroupsDelete

targetGroupsDelete(targetGroupId, pretty, depth, xContractNumber)

Delete a Target Group by ID

Deletes the target group specified by its ID.

Parameters

Name	Type	Description	Notes
targetGroupId	String	The unique ID of the target group.
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]

Name

Type

Description

Notes

targetGroupId

String

The unique ID of the target group.

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]

Return type

null (empty response body)

HTTP request headers

Content-Type: Not defined
Accept: application/json

⚠️ Note: the example bellow uses the targetGroupsDeleteWithHttpInfo which also returns the status code and the headers, if you don't need them you may use targetGroupsDelete instead

Example

// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.TargetGroupsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    
    // Configure HTTP basic authorization: Basic Authentication
    HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
    basicAuthentication.setUsername("YOUR USERNAME");
    basicAuthentication.setPassword("YOUR PASSWORD");

    // Configure Api Key authorization: Token Authentication
    defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");

    TargetGroupsApi apiInstance = new TargetGroupsApi(defaultClient);
    String targetGroupId = "targetGroupId_example"; // String | The unique ID of the target group.
    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 {
      apiInstance.targetGroupsDeleteWithHttpInfo(targetGroupId, pretty, depth, xContractNumber);
    } catch (ApiException e) {
      System.err.println("Exception when calling TargetGroupsApi#targetGroupsDelete");
      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 {
        apiInstance.targetGroupsDelete(targetGroupId)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling TargetGroupsApi#targetGroupsDelete");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

targetgroupsFindByTargetGroupId

TargetGroup targetgroupsFindByTargetGroupId(targetGroupId, pretty, depth, xContractNumber)

Get a Target Group by ID

Retrieves the properties of the target group specified by its ID.

Parameters

Name	Type	Description	Notes
targetGroupId	String	The unique ID of the target group.
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]

Name

Type

Description

Notes

targetGroupId

String

The unique ID of the target group.

pretty

Boolean

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

[optional] [default to true]

depth

Integer

[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

TargetGroup

HTTP request headers

Content-Type: Not defined
Accept: application/json

⚠️ Note: the example bellow uses the targetgroupsFindByTargetGroupIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use targetgroupsFindByTargetGroupId instead

Example

// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.TargetGroupsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    
    // Configure HTTP basic authorization: Basic Authentication
    HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
    basicAuthentication.setUsername("YOUR USERNAME");
    basicAuthentication.setPassword("YOUR PASSWORD");

    // Configure Api Key authorization: Token Authentication
    defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");

    TargetGroupsApi apiInstance = new TargetGroupsApi(defaultClient);
    String targetGroupId = "targetGroupId_example"; // String | The unique ID of the target group.
    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<TargetGroup> result = apiInstance.targetgroupsFindByTargetGroupIdWithHttpInfo(targetGroupId, 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 TargetGroupsApi#targetgroupsFindByTargetGroupId");
      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 {
        TargetGroup result = apiInstance.targetgroupsFindByTargetGroupId(targetGroupId)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling TargetGroupsApi#targetgroupsFindByTargetGroupId");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

targetgroupsGet

TargetGroups targetgroupsGet(pretty, depth, xContractNumber, offset, limit)

Get Target Groups

Lists target groups. A target group is a set of one or more registered targets. You must specify an IP address, a port number, and a weight for each target. Any object with an IP address in your VDC can be a target, for example, a VM, another load balancer, etc. You can register a target with multiple target groups.

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]
offset	Integer	The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).	[optional] [default to 0]
limit	Integer	The maximum number of elements to return (used together with <b><i>offset</i></b> for pagination). It must not exceed <b><i>200</i></b>.	[optional] [default to 100]
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.	[optional]

Name

Type

Description

Notes

pretty

Boolean

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

[optional] [default to true]

depth

Integer

[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]

offset

Integer

The first element (from the complete list of the elements) to include in the response (used together with limit for pagination).

[optional] [default to 0]

limit

Integer

The maximum number of elements to return (used together with offset for pagination). It must not exceed 200.

[optional] [default to 100]

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.

[optional]

Return type

TargetGroups

HTTP request headers

Content-Type: Not defined
Accept: application/json

⚠️ Note: the example bellow uses the targetgroupsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use targetgroupsGet instead

Example

// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.TargetGroupsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    
    // Configure HTTP basic authorization: Basic Authentication
    HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
    basicAuthentication.setUsername("YOUR USERNAME");
    basicAuthentication.setPassword("YOUR PASSWORD");

    // Configure Api Key authorization: Token Authentication
    defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");

    TargetGroupsApi apiInstance = new TargetGroupsApi(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.
    Integer offset = 0; // Integer | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
    Integer limit = 100; // Integer | The maximum number of elements to return (used together with <b><i>offset</i></b> for pagination). It must not exceed <b><i>200</i></b>.
    String orderBy = "orderBy_example"; // String | Order by field
    Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
    Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
    try {
      ApiResponse<TargetGroups> result = apiInstance.targetgroupsGetWithHttpInfo(pretty, depth, xContractNumber, offset, limit, 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 TargetGroupsApi#targetgroupsGet");
      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 {
        TargetGroups result = apiInstance.targetgroupsGet()
                .pretty(true)
                .depth(0)
                .offset(0)
                .limit(100)
                .xContractNumber(56)
                .orderBy("orderBy_example")
                .maxResults(5)
                .filters(filters)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling TargetGroupsApi#targetgroupsGet");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

targetgroupsPatch

TargetGroup targetgroupsPatch(targetGroupId, targetGroupProperties, pretty, depth, xContractNumber)

Partially Modify a Target Group by ID

Updates the properties of the target group specified by its ID.

Parameters

Name	Type	Description	Notes
targetGroupId	String	The unique ID of the target group.
targetGroupProperties	TargetGroupProperties	The target group properties to be updated.
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]

Name

Type

Description

Notes

targetGroupId

String

The unique ID of the target group.

targetGroupProperties

TargetGroupProperties

The target group properties to be updated.

pretty

Boolean

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

[optional] [default to true]

depth

Integer

[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

TargetGroup

HTTP request headers

Content-Type: Not defined
Accept: application/json

⚠️ Note: the example bellow uses the targetgroupsPatchWithHttpInfo which also returns the status code and the headers, if you don't need them you may use targetgroupsPatch instead

Example

// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.TargetGroupsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    
    // Configure HTTP basic authorization: Basic Authentication
    HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
    basicAuthentication.setUsername("YOUR USERNAME");
    basicAuthentication.setPassword("YOUR PASSWORD");

    // Configure Api Key authorization: Token Authentication
    defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");

    TargetGroupsApi apiInstance = new TargetGroupsApi(defaultClient);
    String targetGroupId = "targetGroupId_example"; // String | The unique ID of the target group.
    algorithm = new String(); // String | The balancing algorithm. A balancing algorithm consists of predefined rules with the logic that a load balancer uses to distribute network traffic between servers.  - **Round Robin**: Targets are served alternately according to their weighting.  - **Least Connection**: The target with the least active connection is served.  - **Random**: The targets are served based on a consistent pseudorandom algorithm.  - **Source IP**: It is ensured that the same client IP address reaches the same target.
    name = new String(); // String | The target group name.
    protocol = new String(); // String | The forwarding protocol. Only the value &#39;HTTP&#39; is allowed.
    targetGroupProperties = new TargetGroupProperties(String, String, String); // TargetGroupProperties | The target group properties to be updated.
    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<TargetGroup> result = apiInstance.targetgroupsPatchWithHttpInfo(targetGroupId, targetGroupProperties, 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 TargetGroupsApi#targetgroupsPatch");
      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 {
        TargetGroup result = apiInstance.targetgroupsPatch(targetGroupId, targetGroupProperties)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling TargetGroupsApi#targetgroupsPatch");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

targetgroupsPost

TargetGroup targetgroupsPost(targetGroup, pretty, depth, xContractNumber)

Create a Target Group

Creates a target group.

Parameters

Name	Type	Description	Notes
targetGroup	TargetGroup	The target group to create.
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]

Name

Type

Description

Notes

targetGroup

TargetGroup

The target group to create.

pretty

Boolean

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

[optional] [default to true]

depth

Integer

[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

TargetGroup

HTTP request headers

Content-Type: application/json
Accept: application/json

⚠️ Note: the example bellow uses the targetgroupsPostWithHttpInfo which also returns the status code and the headers, if you don't need them you may use targetgroupsPost instead

Example

// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.TargetGroupsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    
    // Configure HTTP basic authorization: Basic Authentication
    HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
    basicAuthentication.setUsername("YOUR USERNAME");
    basicAuthentication.setPassword("YOUR PASSWORD");

    // Configure Api Key authorization: Token Authentication
    defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");

    TargetGroupsApi apiInstance = new TargetGroupsApi(defaultClient);
    properties = new TargetGroupProperties(); // TargetGroupProperties | 
    targetGroup = new TargetGroup(TargetGroupProperties); // TargetGroup | The target group 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<TargetGroup> result = apiInstance.targetgroupsPostWithHttpInfo(targetGroup, 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 TargetGroupsApi#targetgroupsPost");
      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 {
        TargetGroup result = apiInstance.targetgroupsPost(targetGroup)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling TargetGroupsApi#targetgroupsPost");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

targetgroupsPut

TargetGroup targetgroupsPut(targetGroupId, targetGroup, pretty, depth, xContractNumber)

Modify a Target Group by ID

Modifies the properties of the target group specified by its ID.

Parameters

Name	Type	Description	Notes
targetGroupId	String	The unique ID of the target group.
targetGroup	TargetGroupPut	The modified target group.
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]

Name

Type

Description

Notes

targetGroupId

String

The unique ID of the target group.

targetGroup

TargetGroupPut

The modified target group.

pretty

Boolean

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

[optional] [default to true]

depth

Integer

[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

TargetGroup

HTTP request headers

Content-Type: application/json
Accept: application/json

⚠️ Note: the example bellow uses the targetgroupsPutWithHttpInfo which also returns the status code and the headers, if you don't need them you may use targetgroupsPut instead

Example

// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.auth.*;
import com.ionoscloud.model.*;
import com.ionoscloud.api.TargetGroupsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    
    // Configure HTTP basic authorization: Basic Authentication
    HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication");
    basicAuthentication.setUsername("YOUR USERNAME");
    basicAuthentication.setPassword("YOUR PASSWORD");

    // Configure Api Key authorization: Token Authentication
    defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN");

    TargetGroupsApi apiInstance = new TargetGroupsApi(defaultClient);
    String targetGroupId = "targetGroupId_example"; // String | The unique ID of the target group.
    properties = new TargetGroupProperties(); // TargetGroupProperties | 
    targetGroup = new TargetGroupPut(TargetGroupProperties); // TargetGroupPut | The modified target group.
    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<TargetGroup> result = apiInstance.targetgroupsPutWithHttpInfo(targetGroupId, targetGroup, 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 TargetGroupsApi#targetgroupsPut");
      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 {
        TargetGroup result = apiInstance.targetgroupsPut(targetGroupId, targetGroup)
                .pretty(true)
                .depth(0)
                .xContractNumber(56)
                .execute();
        System.out.println(result);
    } catch (ApiException e) {
        System.err.println("Exception when calling TargetGroupsApi#targetgroupsPut");
        System.err.println("Status code: " + e.getCode());
        System.err.println("Reason: " + e.getResponseBody());
        System.err.println("Response headers: " + e.getResponseHeaders());
        e.printStackTrace();
    }

PreviousSnapshotsApi NextTemplatesApi

Last updated 7 months ago