Sign in

v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Targets

Upsert a Target associated with an Upstream

Create or Update a Target associated with an Upstream using ID or target.

put/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamIdForTarget}/targets/{TargetId}

Path parameters

UpstreamIdForTargetstring required

ID or target of the Target to lookup

TargetIdstring required

ID of the Target to lookup

Request body

created_atnumber nullable

Unix epoch when the resource was created.

failoverboolean nullable

Whether to use this target only as backup or not.

idstring nullable

A string representing a UUID (universally unique identifier).

tagsstring[] nullable

An optional set of strings associated with the Target for grouping and filtering.

targetstring nullable required

The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.

updated_atnumber nullable

Unix epoch when the resource was last updated.

weightinteger nullable

The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.

Example request

{
  "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  "target": "203.0.113.42",
  "weight": 100
}

Response

Successfully upserted Target

created_atnumber nullable

Unix epoch when the resource was created.

failoverboolean nullable

Whether to use this target only as backup or not.

idstring nullable

A string representing a UUID (universally unique identifier).

tagsstring[] nullable

An optional set of strings associated with the Target for grouping and filtering.

targetstring nullable required

The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.

updated_atnumber nullable

Unix epoch when the resource was last updated.

weightinteger nullable

The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.

Example response

{
  "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  "target": "203.0.113.42",
  "upstream": {
    "id": "5f1d7e76-2fed-4806-a6af-869984f025cb"
  },
  "weight": 100
}