--- title: Modifier partiellement un groupe cible par ID slug: modifier-partiellement-un-groupe-cible-par-id docTags: createdAt: 2026-06-04T15:50:56.155Z --- { "id": "K4VrI9zBbSTFa0r-4eEqD", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}", "servers": [ { "url": "https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}" } ], "name": "Partially Modify a Target Group by ID", "description": "Updates the properties of the target group specified by its ID.", "contentType": "*/*", "request": { "pathParameters": [ { "kind": "required", "name": "targetGroupId", "type": "string", "description": "The unique ID of the target group." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "optional", "name": "X-Contract-Number", "type": "integer", "description": "

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

", "format": "int32" } ], "queryParameters": [ { "kind": "optional", "name": "pretty", "type": "boolean", "description": "

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

", "default": true }, { "kind": "optional", "name": "depth", "type": "integer", "description": "

Controls the detail depth of the response objects.\nGET /datacenters/[ID]\n- depth=0: Only direct properties are included; children (servers and other elements) are not included.\n- depth=1: Direct properties and children references are included.\n- depth=2: Direct properties and children properties are included.\n- depth=3: Direct properties and children properties and children's children are included.\n- depth=... and so on

", "default": 0, "format": "int32", "minimum": 0, "maximum": 10 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BasicAuthentication", "name": "BasicAuthentication", "kind": "optional", "type": "http", "description": "

You will need to base64 encode the string containing your credentials. \nNote:\n\n

", "scheme": "basic" }, { "id": "TokenAuthentication", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "

Please provide header value as 'Bearer ' and don't forget to add 'Bearer' HTTP Authorization Scheme before the token.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "202", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "X-RateLimit-Remaining", "type": "integer", "description": "The number of requests that can still be made without triggering a failure response.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Limit", "type": "integer", "description": "The average number of requests per minute allowed.", "format": "int32" }, { "kind": "optional", "name": "X-RateLimit-Burst", "type": "integer", "description": "The maximum number of concurrent API requests allowed.", "format": "int32" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "TargetGroup", "schema": [ { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The resource's unique identifier.", "example": "15f67991-0f51-4efc-a8ad-ef1fb31a480c" }, { "name": "type", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "Type", "description": "", "modelRef": "#/components/schemas/Type", "schema": [] } ], "schema": [] }, { "name": "href", "kind": "optional", "type": "string", "readOnly": true, "description": "

The URL to the object representation (absolute path).

", "example": "", "format": "uri" }, { "name": "metadata", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/DatacenterElementMetadata", "customType": "DatacenterElementMetadata", "schema": [ { "name": "etag", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "45480eb3fbfc31f1d916c1eaa4abdcc3" }, { "name": "createdDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was created.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who created the resource.", "example": "user@example.com" }, { "name": "createdByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who created the resource.", "example": "user@example.com" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the resource was modified.", "example": "2015-12-04T14:34:09.809Z", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The user who last modified the resource.", "example": "user@example.com" }, { "name": "lastModifiedByUserId", "kind": "optional", "type": "string", "readOnly": true, "description": "The unique ID of the user who last modified the resource.", "example": "63cef532-26fe-4a64-a4e0-de7c8a506c90" }, { "name": "state", "kind": "optional", "type": "string", "readOnly": true, "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.

", "example": "AVAILABLE", "enum": [ "AVAILABLE", "INACTIVE", "BUSY", "DEPLOYING", "ACTIVE", "FAILED", "SUSPENDED", "FAILED_SUSPENDED", "UPDATING", "FAILED_UPDATING", "DESTROYING", "FAILED_DESTROYING", "TERMINATED", "HIBERNATING", "FAILED_HIBERNATING", "MAINTENANCE", "FAILED_MAINTENANCE", "UNKNOWN" ] } ] }, { "name": "properties", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/TargetGroupProperties", "customType": "TargetGroupProperties", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The target group name.", "example": "My target group" }, { "name": "algorithm", "kind": "required", "type": "string", "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.

\n
    \n
  • \n

    Round Robin: Targets are served alternately according to their weighting.

    \n
    • \n
  • \n

    Least Connection: The target with the least active connection is served.

    \n
    • \n
  • \n

    Random: The targets are served based on a consistent pseudorandom algorithm.

    \n
    • \n
  • \n

    Source IP: It is ensured that the same client IP address reaches the same target.

    \n
    • \n
", "example": "ROUND_ROBIN", "enum": [ "ROUND_ROBIN", "LEAST_CONNECTION", "RANDOM", "SOURCE_IP" ] }, { "name": "protocol", "kind": "required", "type": "string", "description": "The forwarding protocol. Only the value 'HTTP' is allowed.", "example": "HTTP", "enum": [ "HTTP" ] }, { "name": "protocolVersion", "kind": "optional", "type": "string", "description": "The forwarding protocol version. Value is ignored when protocol is not 'HTTP'.", "example": "HTTP1", "enum": [ "HTTP1", "HTTP2" ] }, { "name": "targets", "kind": "optional", "type": "array", "description": "Array of items in the collection.", "modelRef": "#/components/schemas/TargetGroupTarget", "customType": "TargetGroupTarget[]", "schema": [ { "name": "ip", "kind": "required", "type": "string", "description": "The IP address of the balanced target.", "example": "22.231.2.2" }, { "name": "port", "kind": "required", "type": "integer", "description": "

The port of the balanced target service; the valid range is 1 to 65535.

", "example": 8080, "format": "int32" }, { "name": "weight", "kind": "required", "type": "integer", "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.

", "example": 123, "format": "int32" }, { "name": "proxyProtocol", "kind": "optional", "type": "string", "description": "Proxy protocol version.", "example": "v1", "default": "none", "enum": [ "none", "v1", "v2", "v2ssl" ] }, { "name": "healthCheckEnabled", "kind": "optional", "type": "boolean", "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'.

" }, { "name": "maintenanceEnabled", "kind": "optional", "type": "boolean", "description": "

When the maintenance mode is enabled, the target is prevented from receiving traffic; the default value is 'FALSE'.

" } ] }, { "name": "healthCheck", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TargetGroupHealthCheck", "customType": "TargetGroupHealthCheck", "schema": [ { "name": "checkTimeout", "kind": "optional", "type": "integer", "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.

", "example": 2000, "format": "int32" }, { "name": "checkInterval", "kind": "optional", "type": "integer", "description": "

The interval in milliseconds between consecutive health checks; the default value is '2000'.

", "example": 2000, "format": "int32" }, { "name": "retries", "kind": "optional", "type": "integer", "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'.

", "example": 3, "format": "int32" } ] }, { "name": "httpHealthCheck", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/TargetGroupHttpHealthCheck", "customType": "TargetGroupHttpHealthCheck", "schema": [ { "name": "path", "kind": "optional", "type": "string", "description": "

The destination URL for HTTP the health check; the default is '/'.

", "example": "/monitoring" }, { "name": "method", "kind": "optional", "type": "string", "description": "The method used for the health check request.", "example": "GET", "enum": [ "HEAD", "PUT", "POST", "GET", "TRACE", "PATCH" ] }, { "name": "matchType", "kind": "required", "type": "string", "description": "Specify the target's response type to match ALB's request.", "example": "STATUS_CODE", "enum": [ "STATUS_CODE", "RESPONSE_BODY" ] }, { "name": "response", "kind": "required", "type": "string", "description": "The response returned by the request. It can be a status code or a response body depending on the definition of 'matchType'.", "example": "200" }, { "name": "regex", "kind": "optional", "type": "boolean", "description": "

Specifies whether to use a regular expression to parse the response body; the default value is 'FALSE'.

\n

By using regular expressions, you can flexibly customize the expected response from a healthy server.

", "example": false }, { "name": "negate", "kind": "optional", "type": "boolean", "description": "

Specifies whether to negate an individual entry; the default value is 'FALSE'.

", "example": false } ] } ] } ], "modelRef": "#/components/schemas/TargetGroup", "isExpanded": true } ] }, { "statusCode": "default", "description": "

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

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "httpStatus", "kind": "optional", "type": "integer", "readOnly": true, "description": "HTTP status code of the operation.", "example": 400, "format": "int32" }, { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ErrorMessage", "customType": "ErrorMessage[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "readOnly": true, "description": "Application internal error code.", "example": "123" }, { "name": "message", "kind": "optional", "type": "string", "readOnly": true, "description": "

A human-readable message.

", "example": "Error message example." } ] } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "RO3pOzXn-r8mOrYpMbvVx", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url 'https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}?pretty=true&depth=integer%3Cint32%3E' \\\n --header 'accept: application/json'" }, { "id": "Or_XlTnsBS0zkgSVPqpIB", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"*/*\");\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}?pretty=true&depth=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "Kc7TyEg0L0iBtA0W4bWYV", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}?pretty=true&depth=integer\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"*/*\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "ZZVemoZp5PkxuZjD1W0GN", "language": "python", "label": "Python", "code": "import requests\n\nurl = \"https://api.ionos.com/cloudapi/v6/targetgroups/{targetGroupId}?pretty=true&depth=integer\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': '*/*'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "RO3pOzXn-r8mOrYpMbvVx" }, "results": { "languages": [ { "id": "liPuAYqLPYLgoKdDZ7F7S", "language": "202", "code": "// Successful operation\n{\n \"id\": \"15f67991-0f51-4efc-a8ad-ef1fb31a480c\",\n \"type\": {},\n \"href\": \"\",\n \"metadata\": {\n \"etag\": \"45480eb3fbfc31f1d916c1eaa4abdcc3\",\n \"createdDate\": \"2015-12-04T14:34:09.809Z\",\n \"createdBy\": \"user@example.com\",\n \"createdByUserId\": \"user@example.com\",\n \"lastModifiedDate\": \"2015-12-04T14:34:09.809Z\",\n \"lastModifiedBy\": \"user@example.com\",\n \"lastModifiedByUserId\": \"63cef532-26fe-4a64-a4e0-de7c8a506c90\",\n \"state\": \"AVAILABLE\"\n },\n \"properties\": {\n \"name\": \"My target group\",\n \"algorithm\": \"ROUND_ROBIN\",\n \"protocol\": \"HTTP\",\n \"protocolVersion\": \"HTTP1\",\n \"targets\": [\n {\n \"ip\": \"22.231.2.2\",\n \"port\": 8080,\n \"weight\": 123,\n \"proxyProtocol\": \"v1\",\n \"healthCheckEnabled\": false,\n \"maintenanceEnabled\": false\n }\n ],\n \"healthCheck\": {\n \"checkTimeout\": 2000,\n \"checkInterval\": 2000,\n \"retries\": 3\n },\n \"httpHealthCheck\": {\n \"path\": \"/monitoring\",\n \"method\": \"GET\",\n \"matchType\": \"STATUS_CODE\",\n \"response\": \"200\",\n \"regex\": false,\n \"negate\": false\n }\n }\n}" }, { "id": "EYgnSSs_OefhoTjzzMVr1", "language": "default", "code": "// 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).\n{\n \"httpStatus\": 400,\n \"messages\": [\n {\n \"errorCode\": \"123\",\n \"message\": \"Error message example.\"\n }\n ]\n}" } ], "selectedLanguageId": "liPuAYqLPYLgoKdDZ7F7S" } }, "children": [ { "text": "", "id": "ubL7Mr3leFkwYy7K67tAN" } ] }