Upsert a Target associated with an Upstream

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

put

Path Parameters

upstream_idstringrequired

The unique identifier of the Upstream associated to the Certificate to be retrieved.

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

target_idstringrequired

The id of an existing target entry.

Example:e94215b0-9198-42ce-bf0b-98afff31b2a7

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json
upstreamobject

The unique identifier or the name of the upstream for which to update the target.

Show Child Parameters
weightinteger

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.

Default:100

>= 0<= 65535

tagsarray[string]

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

targetstring

The target IP address

Example:192.158.1.38

Response

application/json

Successfully upserted Target

Target

A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly. To disable a target, post a new one with weight=0; alternatively, use the DELETE convenience method to accomplish the same. The current target object definition is the one with the latest created_at.

created_atnumber

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resource was last updated.

Example:1422386534

idstring

The unique identifier or the name of the upstream for which to update the target.

Example:173a6cee-90d1-40a7-89cf-0329eca780a6

tagsarray[string]

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

targetstring

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.

upstreamobject

The unique identifier or the name of the upstream for which to update the target.

* Additional properties are NOT allowed.
Show Child Parameters
weightinteger

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.

Default:100

Example:100

put/runtime-groups/{runtimeGroupId}/core-entities/upstreams/{upstream_id}/targets/{target_id}

Body

{ "upstream": { "id": "fe335516-b679-44e5-8bf0-f9af0524e230" }, "target": "192.158.1.38", "weight": 100, "tags": [ "string" ] }
 
application/json

DP Nodes

DP Nodes

Get an Expected Config Hash

Retrieve the expected config hash for this runtime group. The expected config hash can be used to verify if the config hash of a runtime instance is up to date with the runtime group. The config hash will be the same if they are in sync.

get

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

Response body for retrieving the expected config hash of the runtime group.

expected_hashstring

The expected configuration hash.

created_atinteger

Date the runtime group configuration was created.

updated_atinteger

Date the runtime group configuration was last updated.

get/runtime-groups/{runtimeGroupId}/expected-config-hash
 
200 application/json

List Runtime Instance Records

Returns a list of runtime instance records that are associated to this runtime group. A runtime instance record contains all the metadata information of the Kong Gateway dataplane.

get

Query Parameters

page_sizeinteger

The number of items to include in a page.

page_numberinteger

The specific page number in the collection results.

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

Example response

itemsarray[object]
Show Child Parameters
pageobject
Show Child Parameters
get/runtime-groups/{runtimeGroupId}/nodes
 
200 application/json

List Runtime Instance End-of-Life Records

Returns a list of records of runtime instances, whose versions are approaching End of Full Support/End of Life, that are associated to this runtime group. Each record contains a runtime’s id, version, and corresponding resolution message to upgrade to the closest Long Term Support version.

get

Query Parameters

page_sizeinteger

The number of items to include in a page.

page_numberinteger

The specific page number in the collection results.

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

Example response

itemsarray[object]
Show Child Parameters
pageobject
Show Child Parameters
get/runtime-groups/{runtimeGroupId}/nodes/eol
 
200 application/json