AIManagerModel
objectShow Child Parameters
Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its protocol, host, port and path individually. Services are associated to Routes (a Service can have many Routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a Route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.
Example:{"host":"example.internal","id":"49fd316e-c457-481c-9fc7-8079153e4f3c","name":"example-service","path":"/","port":80,"protocol":"http"}
Show Child Parameters
A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
Example:{"config":{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":["apikey"],"run_on_preflight":true},"enabled":true,"id":"3fd1eea1-885a-4011-b986-289943ff8177","name":"key-auth","partials":[{"id":"cff1230a-00f7-4ae8-b376-c370f0eb4dae","name":"foo-partial","path":"config.redis"},{"id":"129ee345-cba8-4e55-9d6d-93c223ff91ae","name":"bar-partial","path":"config.redis"}],"protocols":["grpc","grpcs","http","https"]}
Show Child Parameters
Service
objectService entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its protocol, host, port and path individually. Services are associated to Routes (a Service can have many Routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a Route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.
Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server’s TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
Certificate to be used as client certificate while TLS handshaking to the upstream server.
Show Child Parameters
The timeout in milliseconds for establishing a connection to the upstream server.
Default:60000
>= 1<= 2147483646
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.
Default:true
The host of the upstream server. Note that the host value is case sensitive.
A string representing a UUID (universally unique identifier).
>= 1 characters
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The Service name.
The path to be used in requests to the upstream server.
The upstream server port.
Default:80
>= 0<= 65535
The protocol used to communicate with the upstream.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
Default:http
The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
Default:60000
>= 1<= 2147483646
The number of retries to execute upon failure to proxy.
Default:5
>= 0<= 32767
A string representing a tag.
Additional Subject Alternative Names that can be matched on Upstream server’s TLS certificate (in addition to host).
Show Child Parameters
Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected.
>= 0<= 64
Unix epoch when the resource was last updated.
Helper field to set protocol, host, port and path using a URL. This field is write-only and is not returned in responses.
The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
Default:60000
>= 1<= 2147483646
Plugin
objectA Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the Kong Hub. When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the service and consumer fields.
Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.
An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
<= 1024 characters
The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.
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.
Show Child Parameters
If set, the plugin will activate only for requests where the specified group has been authenticated
Show Child Parameters
Unix epoch when the resource was created.
User-defined entity description. Konnect only field, not synced to the Gateway.
Whether the plugin is applied.
Default:true
A string representing a UUID (universally unique identifier).
>= 1 characters
A unique string representing a UTF-8 encoded name.
Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.
The name of the Plugin that’s going to be added. Currently, the Plugin must be installed in every Kong instance separately.
>= 1 characters
Show Child Parameters
A list of partials to be used by the plugin.
Show Child Parameters
A string representing a protocol, such as HTTP or HTTPS.
Allowed values:grpcgrpcshttphttpstcptlstls_passthroughudpwswss
Default:grpc, grpcs, http, https
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.
Show Child Parameters
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.
Show Child Parameters
A string representing a tag.
Unix epoch when the resource was last updated.
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.
UnauthorizedError
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.
Example:401
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.
Example:Unauthorized
The error type.
Example:https://httpstatuses.com/401
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.
Example:kong:trace:1234567890
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.
Example:Invalid credentials