Upsert a Target associated with an Upstream
Create or Update a Target associated with an Upstream using ID or target.
Path Parameters
ID or target of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
ID of the Target to lookup
Example:5a078780-5d4c-4aae-984a-bdc6f52113d8
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the Target
TargetWithoutParents
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.
Unix epoch when the resource was created.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
A string representing a tag.
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.
Unix epoch when the resource was last updated.
The unique identifier or the name of the upstream for which to update the target.
Show Child Parameters
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
Response
200 application/json
Response
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.
Unix epoch when the resource was created.
Whether to use this target only as backup or not.
Default:false
A string representing a UUID (universally unique identifier).
A string representing a tag.
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.
Unix epoch when the resource was last updated.
The unique identifier or the name of the upstream for which to update the target.
Show Child Parameters
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
Authentication
Path Parameters
Body
Upstreams
The upstream object represents a virtual hostname and can be used to load balance incoming requests over multiple services (targets).
An upstream also includes a health checker, which can enable and disable targets based on their ability or inability to serve requests.
The configuration for the health checker is stored in the upstream object, and applies to all of its targets.
List all Upstreams
List all Upstreams
Query Parameters
Number of resources to be returned.
Default:100
>= 1<= 1000
Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources
A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.
Example:tag1,tag2
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
A successful response listing Upstreams
The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named service.v1.xyz for a Service object whose host is service.v1.xyz. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.
Example:{"algorithm":"round-robin","hash_fallback":"none","hash_on":"none","hash_on_cookie_path":"/","healthchecks":{"active":{"concurrency":10,"healthy":{"http_statuses":[200,302],"interval":0,"successes":0},"http_path":"/","https_verify_certificate":true,"timeout":1,"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"interval":0,"tcp_failures":0,"timeouts":0}},"passive":{"healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,500,503],"tcp_failures":0,"timeouts":0}},"threshold":0},"id":"6eed5e9c-5398-4026-9a4c-d48f18a2431e","name":"api.example.internal","slots":10000}
Show Child Parameters
URI to the next page (may be null)
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Authentication
Path Parameters
Query Parameters
Create a new Upstream
Create a new Upstream
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
Description of the new Upstream for creation
Upstream
The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named service.v1.xyz for a Service object whose host is service.v1.xyz. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.
Which load balancing algorithm to use.
Allowed values:consistent-hashinglatencyleast-connectionsround-robinsticky-sessions
Default:round-robin
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
Show Child Parameters
Unix epoch when the resource was created.
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.
Allowed values:consumercookieheaderipnonepathquery_arguri_capture
Default:none
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
>= 1 characters
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
>= 1 characters
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing.
Allowed values:consumercookieheaderipnonepathquery_arguri_capture
Default:none
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
Default:/
The header name to take the value from as hash input. Only required when hash_on is set to header.
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
>= 1 characters
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
>= 1 characters
The array of healthchecks.
Default:{"active":{"concurrency":10,"healthy":{"http_statuses":[200,302],"interval":0,"successes":0},"http_path":"/","https_verify_certificate":true,"timeout":1,"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"interval":0,"tcp_failures":0,"timeouts":0}},"passive":{"healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,500,503],"tcp_failures":0,"timeouts":0}}}
Show Child Parameters
The hostname to be used as Host header when proxying requests through Kong.
A string representing a UUID (universally unique identifier).
This is a hostname, which must be equal to the host of a Service.
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
Default:10000
>= 10<= 65536
The cookie name to keep sticky sessions.
A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
Default:/
A string representing a tag.
Unix epoch when the resource was last updated.
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
Default:false
Response
application/json
Response
Successfully created Upstream
Upstream
The upstream object represents a virtual hostname and can be used to loadbalance incoming requests over multiple services (targets). So for example an upstream named service.v1.xyz for a Service object whose host is service.v1.xyz. Requests for this Service would be proxied to the targets defined within the upstream. An upstream also includes a [health checker][healthchecks], which is able to enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.
Which load balancing algorithm to use.
Allowed values:consistent-hashinglatencyleast-connectionsround-robinsticky-sessions
Default:round-robin
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
Show Child Parameters
Unix epoch when the resource was created.
What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.
Allowed values:consumercookieheaderipnonepathquery_arguri_capture
Default:none
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.
>= 1 characters
The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.
>= 1 characters
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing.
Allowed values:consumercookieheaderipnonepathquery_arguri_capture
Default:none
The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.
Default:/
The header name to take the value from as hash input. Only required when hash_on is set to header.
The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.
>= 1 characters
The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.
>= 1 characters
The array of healthchecks.
Default:{"active":{"concurrency":10,"healthy":{"http_statuses":[200,302],"interval":0,"successes":0},"http_path":"/","https_verify_certificate":true,"timeout":1,"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,404,500,501,502,503,504,505],"interval":0,"tcp_failures":0,"timeouts":0}},"passive":{"healthy":{"http_statuses":[200,201,202,203,204,205,206,207,208,226,300,301,302,303,304,305,306,307,308],"successes":0},"type":"http","unhealthy":{"http_failures":0,"http_statuses":[429,500,503],"tcp_failures":0,"timeouts":0}}}
Show Child Parameters
The hostname to be used as Host header when proxying requests through Kong.
A string representing a UUID (universally unique identifier).
This is a hostname, which must be equal to the host of a Service.
The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.
Default:10000
>= 10<= 65536
The cookie name to keep sticky sessions.
A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
Default:/
A string representing a tag.
Unix epoch when the resource was last updated.
If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.
Default:false
Authentication
Path Parameters
Body
Delete an Upstream
Delete an Upstream
Path Parameters
ID of the Upstream to lookup
Example:426d620c-7058-4ae6-aacc-f85a3204a2c5
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
Response
Successfully deleted Upstream or the resource didn’t exist