Modify a Target Group by ID

1 min

PUT

https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}

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

Path Parameters

targetGroupIdstringrequired
Description
The unique ID of the target group.

Query Parameters

prettyboolean
Description
Controls whether the response is pretty-printed (with indentations and new lines).
Default
true
depthinteger<int32>
Description
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
Default
0
Format
int32
Minimum
0
Maximum
10

Header Parameters

X-Contract-Numberinteger<int32>
Description
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
Format
int32

Body Parameters

bodyTargetGroupPutrequired
Description
The modified target group.
- typeobject
  - Type
- propertiesTargetGroupPropertiesrequired
  - namestringrequired
    Example
    My target group
    Description
    The target group name.
  - algorithmstring<ROUND_ROBIN | LEAST_CONNECTION | RANDOM | SOURCE_IP>required
    Example
    ROUND_ROBIN
    Description
    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.
    Allowed
    ROUND_ROBINLEAST_CONNECTIONRANDOMSOURCE_IP
  - protocolstring<HTTP>required
    Example
    HTTP
    Description
    The forwarding protocol. Only the value 'HTTP' is allowed.
    Allowed
    HTTP
  - protocolVersionstring<HTTP1 | HTTP2>
    Example
    HTTP1
    Description
    The forwarding protocol version. Value is ignored when protocol is not 'HTTP'.
    Allowed
    HTTP1HTTP2
  - targetsTargetGroupTarget[]
    Description
    Array of items in the collection.
    - ipstringrequired
      Example
      22.231.2.2
      Description
      The IP address of the balanced target.
    - portinteger<int32>required
      Example
      8080
      Description
      The port of the balanced target service; the valid range is 1 to 65535.
      Format
      int32
    - weightinteger<int32>required
      Example
      123
      Description
      The traffic is distributed proportionally to target weight, which is the ratio of the total weight of all targets. A target with higher weight receives a larger share of traffic. The valid range is from 0 to 256; the default value is '1'. Targets with a weight of '0' do not participate in load balancing but still accept persistent connections. We recommend using values in the middle range to leave room for later adjustments.
      Format
      int32
    - proxyProtocolstring<none | v1 | v2 | v2ssl>
      Example
      v1
      Description
      Proxy protocol version.
      Default
      none
      Allowed
      nonev1v2v2ssl
    - healthCheckEnabledboolean
      Description
      When the health check is enabled, the target is available only when it accepts regular TCP or HTTP connection attempts for state checking. The state check consists of one connection attempt with the target's address and port. The default value is 'TRUE'.
    - maintenanceEnabledboolean
      Description
      When the maintenance mode is enabled, the target is prevented from receiving traffic; the default value is 'FALSE'.
  - healthCheckTargetGroupHealthCheck
    - checkTimeoutinteger<int32>
      Example
      2000
      Description
      The maximum time in milliseconds is to wait for a target to respond to a check. For target VMs with a 'Check Interval' set, the smaller of the two values is used once the TCP connection is established.
      Format
      int32
    - checkIntervalinteger<int32>
      Example
      2000
      Description
      The interval in milliseconds between consecutive health checks; the default value is '2000'.
      Format
      int32
    - retriesinteger<int32>
      Example
      3
      Description
      The maximum number of attempts to reconnect to a target after a connection failure. The valid range is '0 to 65535'; the default value is '3'.
      Format
      int32
  - httpHealthCheckTargetGroupHttpHealthCheck
    - pathstring
      Example
      /monitoring
      Description
      The destination URL for HTTP the health check; the default is '/'.
    - methodstring<HEAD | PUT | POST | GET | TRACE | PATCH>
      Example
      GET
      Description
      The method used for the health check request.
      Allowed
      HEADPUTPOSTGETTRACEPATCH
    - matchTypestring<STATUS_CODE | RESPONSE_BODY>required
      Example
      STATUS_CODE
      Description
      Specify the target's response type to match ALB's request.
      Allowed
      STATUS_CODERESPONSE_BODY
    - responsestringrequired
      Example
      200
      Description
      The response returned by the request. It can be a status code or a response body depending on the definition of 'matchType'.
    - regexboolean
      Description
      Specifies whether to use a regular expression to parse the response body; the default value is 'FALSE'.
      
      By using regular expressions, you can flexibly customize the expected response from a healthy server.
    - negateboolean
      Description
      Specifies whether to negate an individual entry; the default value is 'FALSE'.

Responses

202Successful operation

TargetGroup
- idstring
  Example
  15f67991-0f51-4efc-a8ad-ef1fb31a480c
  Description
  The resource's unique identifier.
- typeobject
  - Type
- hrefstring<uri>
  Example
  <RESOURCE-URI>
  Description
  The URL to the object representation (absolute path).
  Format
  uri
- metadataDatacenterElementMetadata
  - etagstring
    Example
    45480eb3fbfc31f1d916c1eaa4abdcc3
    Description
    Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.
  - createdDatestring<date-time>
    Example
    2015-12-04T14:34:09.809Z
    Description
    The last time the resource was created.
    Format
    date-time
  - createdBystring
    Example
    [email protected]
    Description
    The user who created the resource.
  - createdByUserIdstring
    Example
    [email protected]
    Description
    The unique ID of the user who created the resource.
  - lastModifiedDatestring<date-time>
    Example
    2015-12-04T14:34:09.809Z
    Description
    The last time the resource was modified.
    Format
    date-time
  - lastModifiedBystring
    Example
    [email protected]
    Description
    The user who last modified the resource.
  - lastModifiedByUserIdstring
    Example
    63cef532-26fe-4a64-a4e0-de7c8a506c90
    Description
    The unique ID of the user who last modified the resource.
  - statestring<AVAILABLE | INACTIVE | BUSY | DEPLOYING | ACTIVE | FAILED | SUSPENDED | FAILED_SUSPENDED | UPDATING | FAILED_UPDATING | DESTROYING | FAILED_DESTROYING | TERMINATED | HIBERNATING | FAILED_HIBERNATING | MAINTENANCE | FAILED_MAINTENANCE | UNKNOWN>
    Example
    AVAILABLE
    Description
    State of the resource. AVAILABLE There are no pending modification requests for this item; BUSY There is at least one modification request pending and all following requests will be queued; INACTIVE Resource has been de-provisioned; DEPLOYING Resource state DEPLOYING - relevant for Kubernetes cluster/nodepool; ACTIVE Resource state ACTIVE - relevant for Kubernetes cluster/nodepool; FAILED Resource state FAILED - relevant for Kubernetes cluster/nodepool; SUSPENDED Resource state SUSPENDED - relevant for Kubernetes cluster/nodepool; FAILED_SUSPENDED Resource state FAILED_SUSPENDED - relevant for Kubernetes cluster; UPDATING Resource state UPDATING - relevant for Kubernetes cluster/nodepool; FAILED_UPDATING Resource state FAILED_UPDATING - relevant for Kubernetes cluster/nodepool; DESTROYING Resource state DESTROYING - relevant for Kubernetes cluster; FAILED_DESTROYING Resource state FAILED_DESTROYING - relevant for Kubernetes cluster/nodepool; TERMINATED Resource state TERMINATED - relevant for Kubernetes cluster/nodepool; HIBERNATING Resource state HIBERNATING - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool; MAINTENANCE Resource state MAINTENANCE - relevant for Kubernetes cluster/nodepool; FAILED_HIBERNATING Resource state FAILED_HIBERNATING - relevant for Kubernetes cluster/nodepool.
    Allowed
    AVAILABLEINACTIVEBUSYDEPLOYINGACTIVEFAILEDSUSPENDEDFAILED_SUSPENDEDUPDATINGFAILED_UPDATINGDESTROYINGFAILED_DESTROYINGTERMINATEDHIBERNATINGFAILED_HIBERNATINGMAINTENANCEFAILED_MAINTENANCEUNKNOWN
- propertiesTargetGroupPropertiesrequired
  - namestringrequired
    Example
    My target group
    Description
    The target group name.
  - algorithmstring<ROUND_ROBIN | LEAST_CONNECTION | RANDOM | SOURCE_IP>required
    Example
    ROUND_ROBIN
    Description
    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.
    Allowed
    ROUND_ROBINLEAST_CONNECTIONRANDOMSOURCE_IP
  - protocolstring<HTTP>required
    Example
    HTTP
    Description
    The forwarding protocol. Only the value 'HTTP' is allowed.
    Allowed
    HTTP
  - protocolVersionstring<HTTP1 | HTTP2>
    Example
    HTTP1
    Description
    The forwarding protocol version. Value is ignored when protocol is not 'HTTP'.
    Allowed
    HTTP1HTTP2
  - targetsTargetGroupTarget[]
    Description
    Array of items in the collection.
    - ipstringrequired
      Example
      22.231.2.2
      Description
      The IP address of the balanced target.
    - portinteger<int32>required
      Example
      8080
      Description
      The port of the balanced target service; the valid range is 1 to 65535.
      Format
      int32
    - weightinteger<int32>required
      Example
      123
      Description
      The traffic is distributed proportionally to target weight, which is the ratio of the total weight of all targets. A target with higher weight receives a larger share of traffic. The valid range is from 0 to 256; the default value is '1'. Targets with a weight of '0' do not participate in load balancing but still accept persistent connections. We recommend using values in the middle range to leave room for later adjustments.
      Format
      int32
    - proxyProtocolstring<none | v1 | v2 | v2ssl>
      Example
      v1
      Description
      Proxy protocol version.
      Default
      none
      Allowed
      nonev1v2v2ssl
    - healthCheckEnabledboolean
      Description
      When the health check is enabled, the target is available only when it accepts regular TCP or HTTP connection attempts for state checking. The state check consists of one connection attempt with the target's address and port. The default value is 'TRUE'.
    - maintenanceEnabledboolean
      Description
      When the maintenance mode is enabled, the target is prevented from receiving traffic; the default value is 'FALSE'.
  - healthCheckTargetGroupHealthCheck
    - checkTimeoutinteger<int32>
      Example
      2000
      Description
      The maximum time in milliseconds is to wait for a target to respond to a check. For target VMs with a 'Check Interval' set, the smaller of the two values is used once the TCP connection is established.
      Format
      int32
    - checkIntervalinteger<int32>
      Example
      2000
      Description
      The interval in milliseconds between consecutive health checks; the default value is '2000'.
      Format
      int32
    - retriesinteger<int32>
      Example
      3
      Description
      The maximum number of attempts to reconnect to a target after a connection failure. The valid range is '0 to 65535'; the default value is '3'.
      Format
      int32
  - httpHealthCheckTargetGroupHttpHealthCheck
    - pathstring
      Example
      /monitoring
      Description
      The destination URL for HTTP the health check; the default is '/'.
    - methodstring<HEAD | PUT | POST | GET | TRACE | PATCH>
      Example
      GET
      Description
      The method used for the health check request.
      Allowed
      HEADPUTPOSTGETTRACEPATCH
    - matchTypestring<STATUS_CODE | RESPONSE_BODY>required
      Example
      STATUS_CODE
      Description
      Specify the target's response type to match ALB's request.
      Allowed
      STATUS_CODERESPONSE_BODY
    - responsestringrequired
      Example
      200
      Description
      The response returned by the request. It can be a status code or a response body depending on the definition of 'matchType'.
    - regexboolean
      Description
      Specifies whether to use a regular expression to parse the response body; the default value is 'FALSE'.
      
      By using regular expressions, you can flexibly customize the expected response from a healthy server.
    - negateboolean
      Description
      Specifies whether to negate an individual entry; the default value is 'FALSE'.

Response Headers

X-RateLimit-Remaininginteger<int32>
Description
The number of requests that can still be made without triggering a failure response.
Format
int32
X-RateLimit-Limitinteger<int32>
Description
The average number of requests per minute allowed.
Format
int32
X-RateLimit-Burstinteger<int32>
Description
The maximum number of concurrent API requests allowed.
Format
int32

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

Error
- httpStatusinteger<int32>
  Example
  400
  Description
  HTTP status code of the operation.
  Format
  int32
- messagesErrorMessage[]
  - errorCodestring
    Example
    123
    Description
    Application internal error code.
  - messagestring
    Example
    Error message example.
    Description
    A human-readable message.

curl

curl --request PUT \
     --url 'https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}?pretty=true&depth=integer%3Cint32%3E' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "type": {},
     "properties": {
     "name": "My target group",
     "algorithm": "ROUND_ROBIN",
     "protocol": "HTTP",
     "targets": [
     {
     "ip": "22.231.2.2",
     "port": 8080,
     "weight": 123,
     "proxyProtocol": "none"
     }
     ],
     "httpHealthCheck": {
     "matchType": "STATUS_CODE",
     "response": "200"
     }
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "type": {},
   "properties": {
      "name": "My target group",
      "algorithm": "ROUND_ROBIN",
      "protocol": "HTTP",
      "targets": [
         {
            "ip": "22.231.2.2",
            "port": 8080,
            "weight": 123,
            "proxyProtocol": "none"
         }
      ],
      "httpHealthCheck": {
         "matchType": "STATUS_CODE",
         "response": "200"
      }
   }
});

var requestOptions = {
   method: 'PUT',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}?pretty=true&depth=integer<int32>", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}?pretty=true&depth=integer<int32>")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "type": {},
   "properties": {
      "name": "My target group",
      "algorithm": "ROUND_ROBIN",
      "protocol": "HTTP",
      "targets": [
         {
            "ip": "22.231.2.2",
            "port": 8080,
            "weight": 123,
            "proxyProtocol": "none"
         }
      ],
      "httpHealthCheck": {
         "matchType": "STATUS_CODE",
         "response": "200"
      }
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}?pretty=true&depth=integer<int32>"

payload = json.dumps({
   "type": {},
   "properties": {
      "name": "My target group",
      "algorithm": "ROUND_ROBIN",
      "protocol": "HTTP",
      "targets": [
         {
            "ip": "22.231.2.2",
            "port": 8080,
            "weight": 123,
            "proxyProtocol": "none"
         }
      ],
      "httpHealthCheck": {
         "matchType": "STATUS_CODE",
         "response": "200"
      }
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

202

// Successful operation
{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": {},
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "My target group",
    "algorithm": "ROUND_ROBIN",
    "protocol": "HTTP",
    "protocolVersion": "HTTP1",
    "targets": [
      {
        "ip": "22.231.2.2",
        "port": 8080,
        "weight": 123,
        "proxyProtocol": "v1",
        "healthCheckEnabled": false,
        "maintenanceEnabled": false
      }
    ],
    "healthCheck": {
      "checkTimeout": 2000,
      "checkInterval": 2000,
      "retries": 3
    },
    "httpHealthCheck": {
      "path": "/monitoring",
      "method": "GET",
      "matchType": "STATUS_CODE",
      "response": "200",
      "regex": false,
      "negate": false
    }
  }
}

default

// Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).
{
  "httpStatus": 400,
  "messages": [
    {
      "errorCode": "123",
      "message": "Error message example."
    }
  ]
}

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.