TargetGroupsApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
DELETE /targetgroups/{targetGroupId} | Delete a Target Group by ID | |
GET /targetgroups/{targetGroupId} | Get a Target Group by ID | |
GET /targetgroups | Get Target Groups | |
PATCH /targetgroups/{targetGroupId} | Partially Modify a Target Group by ID | |
POST /targetgroups | Create a Target Group | |
PUT /targetgroups/{targetGroupId} | Modify a Target Group by ID |
targetGroupsDelete
targetGroupsDelete(targetGroupId, opts)
Delete a Target Group by ID
Deletes the target group specified by its ID.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
targetGroupId | string | The unique ID of the target group. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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 | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
nil (empty response body)
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
targetgroupsFindByTargetGroupId
targetgroupsFindByTargetGroupId(targetGroupId, opts)
Get a Target Group by ID
Retrieves the properties of the target group specified by its ID.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
targetGroupId | string | The unique ID of the target group. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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 | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
targetgroupsGet
targetgroupsGet(opts)
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.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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 | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
offset | number | 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 | number | 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] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
targetgroupsPatch
targetgroupsPatch(targetGroupId, targetGroupProperties, opts)
Partially Modify a Target Group by ID
Updates the properties of the target group specified by its ID.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
targetGroupId | string | The unique ID of the target group. | [default to undefined] |
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 | number | 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 | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
targetgroupsPost
targetgroupsPost(targetGroup, opts)
Create a Target Group
Creates a target group.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
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 | number | 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 | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
targetgroupsPut
targetgroupsPut(targetGroupId, targetGroup, opts)
Modify a Target Group by ID
Modifies the properties of the target group specified by its ID.
Examples
Parameters
Name | Type | Description | Notes |
---|---|---|---|
targetGroupId | string | The unique ID of the target group. | [default to undefined] |
targetGroup | The modified target group. | ||
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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 | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
Last updated