Upstream
objectThe 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
Vault
objectVault 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
pagination-offset-response
stringOffset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
Error
objectstandard error
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
The error type.
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.
InvalidRules
stringinvalid parameters rules
Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype