Certificate

object

A certificate object represents a public certificate. These fields are referenceable, and can be stored as secrets in a vault. References must follow a specific format.

certstring

PEM-encoded public certificate chain of the SSL key This field is referenceable and can be stored in a vault. References must follow a specific format.

Example:-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----

cert_altstring

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs.

Example:-----BEGIN CERTIFICATE-----...

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

idstring(uuid)

The UUID representation of the certificate object.

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

keystring

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Example: -----BEGIN RSA PRIVATE KEY-----...

key_altstring

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Example:-----BEGIN EC PRIVATE KEY-----...

tagsarray[string]

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

Example:user-level

Example

Key

object

A Key object holds a representation of asymmetric keys in various formats. When Kong or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.

created_atinteger

Unix epoch when the resource was created.

Example:1422386534

idstring

The unique identifier or the prefix of the Vault to delete.

Example:24D0DBDA-671C-11ED-BA0B-EF1DCCD3725F

jwkstring

A JSON Web Key represented as a string.

Example:{\alg\:\RSA\, \kid\: \42\, ...}

kidstring

A unique identifier for a key.

Example:42

updated_atinteger

Unix epoch when the resouce was updated.

Example:1422386534

pemobject

A keypair in PEM format.

Show Child Parameters
setobject

The id (an UUID) of the key-set with which to associate the key.

* Additional properties are NOT allowed.
Show Child Parameters
tagsarray[string]

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

Example

Plugin

object

A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle.

configobject

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

enabledboolean

Whether the plugin is applied.

Default:true

idstring
instance_namestring
namestring

The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.

orderingobject
protocolsarray[string]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.
Show Child Parameters
serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified service. Leave unset for the plugin to activate regardless of the service being matched.

* Additional properties are NOT allowed.
Show Child Parameters
tagsarray[string]

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

Example

Route

object

Route entities define rules to match client requests. Every request matching a given route will be proxied to its associated service.

created_atinteger

Unix epoch when the resource was created.

destinationsarray[object]

A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields ip (optionally in CIDR range notation) and/or port.

headersobject

One or more lists of values indexed by header name that will cause this route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.

hostsarray[string]

A list of domain names that match this route. Note that the hosts value is case sensitive.

Example:foo.example.com

https_redirect_status_codeinteger

The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the route is configured to only accept the https protocol.

Default:426

idstring

Example:56c4566c-14cc-4132-9011-4139fcbbe50a

methodsarray[string]

A list of HTTP methods that match this route.

namestring

The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named test and Test.

path_handlingstring

Controls how the service path, route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.

Default:v0

pathsarray[string]

A list of paths that match this route.

preserve_hostboolean

When matching a route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the service’s host.

Default:false

protocolsarray[string]

An array of the protocols this route should allow. See the route Object section for a list of accepted protocols. When set to only https, HTTP requests are answered with an upgrade error. When set to only http, HTTPS requests are answered with an error.

Default:http, https

regex_priorityinteger

A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).

Default:0

request_bufferingboolean

Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.

Default:true

response_bufferingboolean

Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.

Default:true

serviceobject

The service this route is associated to. This is where the route proxies traffic to.

* Additional properties are NOT allowed.
Show Child Parameters
snisarray[string]

A list of SNIs that match this route when using stream routing.

sourcesarray[object]

A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields ip (optionally in CIDR range notation) and/or port.

strip_pathboolean

When matching a route via one of the paths, strip the matching prefix from the upstream request URL.

Default:true

tagsarray[string]

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

updated_atinteger

Unix epoch when the resource was last updated.

Example

SNI

object

An SNI object represents a many-to-one mapping of hostnames to a certificate. That is, a certificate object can have many hostnames associated with it; when Kong receives an SSL request, it uses the SNI field in the Client Hello to lookup the certificate object based on the SNI associated with the certificate.

certificateobject

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

* Additional properties are NOT allowed.
Show Child Parameters
created_atinteger

Unix epoch when the resource was created.

Example:1422386534

idstring

Example:b87eb55d-69a1-41d2-8653-8d706eecefc0

namestring

The SNI name to associate with the given certificate.

Example:my-sni

tagsarray[string]

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

Example:user-level, enterprise

Example