Skip to content

Create a target group.

POST
/v1/projects/{projectId}/lb/target-groups
Code sample: Shell / cURL
curl --request POST \
--url https://stratum.example.com/v1/projects/example/lb/target-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "displayName": "example", "protocol": "HTTP", "port": 1, "targetType": "instance", "vpcId": "example", "healthCheck": { "enabled": true, "protocol": "http", "path": "example", "interval_ms": 1, "timeout_ms": 1, "healthy_threshold": 1, "unhealthy_threshold": 1, "expect_status": "example" } }'
projectId
required
string
/^p-[a-z0-9-]+$/
Media typeapplication/json
object
name
required
string
/^[a-z][a-z0-9-]{1,38}[a-z0-9]$/
displayName
string
protocol
string
default: HTTP
port
required
integer
>= 1 <= 65535
targetType
required
string
Allowed values: instance network-interface ip auto-scaling-group
vpcId
required
string
healthCheck

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
enabled
boolean
protocol
string
Allowed values: http tcp
path

HTTP health-check path, e.g. /healthz

string
interval_ms
integer
timeout_ms
integer
healthy_threshold
integer
unhealthy_threshold
integer
expect_status

Accepted status codes, e.g. “200”, “200,302”, “200-299”

string

Created.

Media typeapplication/json
object
ownedBy

Set when a platform resource manages this row; absent on a tenant’s own.

object
kind
required
string
Allowed values: auto-scaling-group platform
id
required

The owner: the Auto Scaling group id, or for platform the component (front-door, pack:platform-health, default-network, operator-recipe).

string
id
required
string
/^tg-[a-z0-9]+$/
projectId
required
string
name
required
string
displayName
string
description
string
protocol
required
string
port
required
integer
>= 1 <= 65535
targetType
required

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.

string
Allowed values: instance network-interface ip auto-scaling-group
vpcId
required
string
balanceMode
string
healthCheck
object
key
additional properties
any
stickiness
object
key
additional properties
any
deregistrationDelaySeconds
integer
state
required
string
createdAt
string format: date-time
updatedAt
string format: date-time
createdBy
string
autoScalingGroupIds

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.

Array<string>

Example

{
"ownedBy": {
"kind": "auto-scaling-group"
},
"targetType": "instance"
}

Bad request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

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.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

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
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

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.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

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
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}

Quota exceeded.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

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.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

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
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}