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
Authentication
Path Parameters
Get an Upstream
Get an Upstream using ID or name.
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
application/json
Response
Successfully fetched 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
Upsert a Upstream
Create or Update Upstream using ID or name.
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
Body
application/json
Body
Description of the 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
Response
application/json
Response
Successfully upserted 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
Vaults
Vault objects are used to configure different vault connectors for managing secrets.
Configuring a vault lets you reference secrets from other entities.
This allows for a proper separation of secrets and configuration and prevents secret sprawl.
For example, you could store a certificate and a key in a vault, then reference them from a certificate entity. This way, the certificate and key are not stored in the entity directly and are more secure.
Secrets rotation can be managed using TTLs.