Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Application Load Balancer API, REST: TargetGroup.Update

Written by
Updated at November 26, 2025

Updates the specified target group.

HTTP request

PATCH https://alb.api.cloud.yandex.net/apploadbalancer/v1/targetGroups/{targetGroupId}

Path parameters

Field

Description

targetGroupId

string

Required field. ID of the target group to update.

To get the target group ID, make a TargetGroupService.List request.

Body parameters

{
  "updateMask": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "targets": [
    {
      // Includes only one of the fields `ipAddress`
      "ipAddress": "string",
      // end of the list of possible fields
      "subnetId": "string",
      "privateIpv4Address": "boolean"
    }
  ]
}

Field

Description

updateMask

string (field-mask)

A comma-separated names off ALL fields to be updated.
Only the specified fields will be changed. The others will be left untouched.
If the field is specified in updateMask and no value for that field was sent in the request,
the field's value will be reset to the default. The default value for most fields is null or 0.

If updateMask is not sent in the request, all fields' values will be updated.
Fields specified in the request will be updated to provided values.
The rest of the fields will be reset to the default.

name

string

New name for the target group.
The name must be unique within the folder.

Value must match the regular expression ([a-z]([-a-z0-9]{0,61}[a-z0-9])?)?.

description

string

New description of the target group.

The maximum string length in characters is 256.

labels

object (map<string, string>)

Target group labels as key:value pairs.
For details about the concept, see documentation.

Existing set of labels is completely replaced by the provided set, so if you just want
to add or remove a label:

  1. Get the current set of labels with a TargetGroupService.Get request.
  2. Add or remove a label in this set.
  3. Send the new set in this field.

No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_./\@0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*.

targets[]

Target

New list of targets in the target group.

Existing list of targets is completely replaced by the specified list, so if you just want to add or remove
a target, make a TargetGroupService.AddTargets request or a TargetGroupService.RemoveTargets request.

Target

A target resource.
For details about the concept, see documentation.

Field

Description

ipAddress

string

IP address of the target.

Includes only one of the fields ipAddress.

Reference to the target. As of now, targets must only be referred to by their IP addresses.

subnetId

string

ID of the subnet that the target is connected to.

privateIpv4Address

boolean

If set, will not require subnet_id to validate the target.
Instead, the address should belong to one of the following ranges:
10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16
Only one of subnet_id or private_ipv4_address should be set.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "targetGroupId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "name": "string",
    "description": "string",
    "folderId": "string",
    "labels": "object",
    "targets": [
      {
        // Includes only one of the fields `ipAddress`
        "ipAddress": "string",
        // end of the list of possible fields
        "subnetId": "string",
        "privateIpv4Address": "boolean"
      }
    ],
    "createdAt": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateTargetGroupMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

TargetGroup

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateTargetGroupMetadata

Field

Description

targetGroupId

string

ID of the target group that is being updated.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

TargetGroup

A target group resource.
For details about the concept, see documentation.

Field

Description

id

string

ID of the target group. Generated at creation time.

name

string

Name of the target group. The name is unique within the folder.

description

string

Description of the target group.

folderId

string

ID of the folder that the target group belongs to.

labels

object (map<string, string>)

Target group labels as key:value pairs.
For details about the concept, see documentation.

targets[]

Target

List of targets in the target group.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Target

A target resource.
For details about the concept, see documentation.

Field

Description

ipAddress

string

IP address of the target.

Includes only one of the fields ipAddress.

Reference to the target. As of now, targets must only be referred to by their IP addresses.

subnetId

string

ID of the subnet that the target is connected to.

privateIpv4Address

boolean

If set, will not require subnet_id to validate the target.
Instead, the address should belong to one of the following ranges:
10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16
Only one of subnet_id or private_ipv4_address should be set.
Previous
Create
Next
Delete
© 2025 Direct Cursus Technology L.L.C.