Update a target group (health check + tunables).
curl --request PATCH \ --url https://stratum.example.com/v1/projects/example/lb/target-groups/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "healthCheck": { "enabled": true, "protocol": "http", "path": "example", "interval_ms": 1, "timeout_ms": 1, "healthy_threshold": 1, "unhealthy_threshold": 1, "expect_status": "example" }, "displayName": "example" }'Partial update. The primary use is arming or tuning the health check that drives the data-plane prober; absent fields are left unchanged.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”partial update of a target group; absent fields are left unchanged. healthCheck is the only way to arm the data-plane prober — a DB trigger reloads the data plane so an enabled check begins probing.
object
Prober config, passed through to the axlbd data plane. Property names are the data-plane JSONB contract (snake_case). The prober only runs when enabled; disabled or empty means every target is treated healthy and no probing happens.
object
HTTP health-check path, e.g. /healthz
Accepted status codes, e.g. “200”, “200,302”, “200-299”
Responses
Section titled “Responses”The updated target group.
object
Set when a platform resource manages this row; absent on a tenant’s own.
object
The owner: the Auto Scaling group id, or for platform the component (front-door, pack:platform-health, default-network, operator-recipe).
What a registration’s targetId names by default. instance and network-interface targets are resolved to their private IP on this VPC at registration and re-resolved by the control plane; auto-scaling-group (and ip) target groups accept an auto scaling group as a target, which binds the group’s membership to the target group.
object
object
Auto scaling groups whose membership this target group follows — read from the groups’ own target-group lists on describe. Register a group id as a target to add one; deregister it to remove it.
Example
{ "ownedBy": { "kind": "auto-scaling-group" }, "targetType": "instance"}Bad request.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Resource not found.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}