Update an Upstream
Create or Update Upstream using ID or name.
Path Parameters
The unique identifier of the Upstream associated to the Certificate to be retrieved.
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
This is a hostname, which must be equal to the host of a service.
Example:my-upstream
Which load balancing algorithm to use. Accepted values are: consistent-hashing, least-connections, round-robin. Default: round-robin.
Allowed values:consistent-hashingleast-connectionsround-robin
Default:round-robin
Example:round-robin
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing
Allowed values:noneconsumeripcookieuri_capturepathquery_arg
Default:none
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:noneconsumeripcookieuri_capturepathquery_arg
Default:none
Example:none
The header name to take the value from as hash input. Only required when hash_on is set to header.
Example:none
The header name to take the value from as hash input. Only required when hash_fallback is set to header.
Default:none
Example: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.
Example:none
The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie. Default: /.
Default:/
Example:/
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.
Example:hash_value
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.
Example:hash_value
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.
Example:hash_value
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.
Example:hash_value
The number of slots in the load balancer algorithm. If the algorithm is set to round-robin, this setting determines the maximum number of slots. If the 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
Example:5000
Show Child Parameters
An optional set of strings associated with the Upstream for grouping and filtering.
Example:["user-level","low-priority"]
The hostname to be used as Host header when proxying requests through Kong.
If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.
Show Child Parameters
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.
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.
Example:1422386534
Unix epoch when the resouce was updated.
Example:1422386534
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.
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.
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.
What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing.
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.
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.
Show Child Parameters
The hostname to be used as Host header when proxying requests through Kong.
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
An optional set of strings associated with the Upstream for grouping and filtering.
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
Vaults
List all Vaults
List all Vaults
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 ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
200 application/json
Response
A successful response listing Vaults
Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, Hashicorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.
Example:{"config":{"prefix":"ENV_PREFIX"},"description":"environment variable based vault","id":"2747d1e5-8246-4f65-a939-b392f1ee17f8","name":"env","tags":["foo","bar"]}
Show Child Parameters
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 Vault
Create a new Vault
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
Example:pre
The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.
Example:env
The description of the Vault object.
Example:This vault is used to retrieve redis database access credentials
The configuration properties for the Vault which can be found on the vaults’ documentation page.
Show Child Parameters
An optional set of strings associated with the Vault for grouping and filtering.
Response
application/json
Response
Successfully created Vault
Vault
Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, Hashicorp Vault and AWS Secrets Manager. Configuring a Vault allows referencing the secrets with other entities. For example a certificate entity can store a reference to a certificate and key, stored in a vault, instead of storing the certificate and key within the entity. This allows a proper separation of secrets and configuration and prevents secret sprawl.
The configuration properties for the Vault which can be found on the vaults’ documentation page.
Unix epoch when the resource was created.
Example:1422386534
The description of the Vault entity.
Example:This vault is used to retrieve redis database access credentials
Example:B2A30E8F-C542-49CF-8015-FB674987D1A5
The name of the Vault that’s going to be added. Currently, the Vault implementation must be installed in every Kong instance.
Example:env
The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
Example:env
An optional set of strings associated with the Vault for grouping and filtering.
Example:database-credentials
Unix epoch when the resource was last updated.
Example:1422386534
Authentication
Path Parameters
Body
Delete a Vault
Delete a Vault
Path Parameters
ID or prefix of the Vault to delete
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted Vault or the resource didn’t exist