Skip to content
StratumStratum Docs

List target groups in a project.

GET
/v1/projects/{projectId}/lb/target-groups
Code sample: Shell / cURL
curl --request GET \
  --url 'https://stratum.example.com/v1/projects/example/lb/target-groups?limit=100' \
  --header 'Authorization: Bearer <token>'

Cursor-paginated. Ordered name, id.

Ordering on name alone is not total, so id is the tiebreaker. Without a unique tiebreaker a cursor sitting on a tie repeats or skips a row.

When nextPageToken is present there are more rows; pass it back as page_token. A token that cannot be parsed is treated as no token, so a client gets the first page rather than a 400.

This endpoint returned every matching row with no limit of any kind until .

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 100 >= 1 <= 500
page_token
string

Opaque cursor from a previous response’s nextPageToken. Omit for the first page.

Responses

Section titled “Responses”

200

Section titled “200”

Target groups.

Media typeapplication/json
object
items
required
Array<object>
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>
nextPageToken
string

Example 

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