Skip to main content
POST
Attach a target to this group
Requires the IAM action loadbalancer:AttachTarget. See LOADBALANCER permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Headers

Idempotency-Key
string

Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.

Maximum string length: 255

Path Parameters

id
string
required

UUID, CRN or exact account-scoped name

Example:

"b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4"

Body

application/json

target is a literal IP for IP groups or an instance UUID, CRN or exact account-scoped name for instance groups.

target
string
required

Must match the group's target_type: an IP address for ip, a compute instance UUID, CRN or exact account-scoped name for instance. An ip ref has to be a routable unicast address — loopback, link-local (including the 169.254.169.254 metadata endpoint), multicast, and unspecified addresses are rejected.

Example:

"d0e1f2a3-b4c5-4678-d9e0-f1a2b3c4d5e6"

port
integer

Per-target backend port override. When omitted, the target inherits the target group port. Pool-derived targets always inherit the group port.

Required range: 1 <= x <= 65535
Example:

8080

Response

Created

target
object
required

A registered backend. Exactly one of instance or address is returned.