Partially Modify a Target Group by ID

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

patch

Authorizations

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials.

Note:

• Basic Authentication is supported only when 2-Factor Authentication is not configured.
• Users with 2-Factor Authentication activated must generate new 2FA-secured tokens in the DCD using [Token Manager](https://docs.ionos.com/cloud/set-up-ionos-cloud/management/identity-access-management/token-manager). These tokens do not inherit the 2FA-secured property by default.
• Token deletion is only possible using the Token Manager.

Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication

Path parameters

targetGroupIdstringRequired

The unique ID of the target group.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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

Header parameters

X-Contract-Numberinteger · int32Optional

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

Body

namestringRequired

The target group name.

Example: My target group

algorithmstring · enumRequired

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.

Example: ROUND_ROBINPossible values:

protocolstring · enumRequired

The forwarding protocol. Only the value 'HTTP' is allowed.

Example: HTTPPossible values:

protocolVersionstring · enumOptional

The forwarding protocol version. Value is ignored when protocol is not 'HTTP'.

Example: HTTP1Possible values:

Responses

202

Successful operation

application/json

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).

application/json

patch/targetgroups/{targetGroupId}

PATCH /cloudapi/v6/targetgroups/{targetGroupId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: */*
Accept: */*
Content-Length: 423

{
  "name": "My target group",
  "algorithm": "ROUND_ROBIN",
  "protocol": "HTTP",
  "protocolVersion": "HTTP1",
  "targets": [
    {
      "ip": "22.231.2.2",
      "port": 8080,
      "weight": 123,
      "proxyProtocol": "v1",
      "healthCheckEnabled": true,
      "maintenanceEnabled": true
    }
  ],
  "healthCheck": {
    "checkTimeout": 2000,
    "checkInterval": 2000,
    "retries": 3
  },
  "httpHealthCheck": {
    "path": "/monitoring",
    "method": "GET",
    "matchType": "STATUS_CODE",
    "response": "200",
    "regex": false,
    "negate": false
  }
}

{
  "id": "15f67991-0f51-4efc-a8ad-ef1fb31a480c",
  "type": "target-group",
  "href": "<RESOURCE-URI>",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[e-mail]",
    "createdByUserId": "[e-mail]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[e-mail]",
    "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": true,
        "maintenanceEnabled": true
      }
    ],
    "healthCheck": {
      "checkTimeout": 2000,
      "checkInterval": 2000,
      "retries": 3
    },
    "httpHealthCheck": {
      "path": "/monitoring",
      "method": "GET",
      "matchType": "STATUS_CODE",
      "response": "200",
      "regex": false,
      "negate": false
    }
  }
}