Kong · Schema
RequestCalloutPluginConfig
API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source
Properties
| Name | Type | Description |
|---|---|---|
| config | object | |
| consumer | object | 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 acti |
| consumer_group | object | If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset |
| name | object | |
| protocols | array | A set of strings representing HTTP protocols. |
| route | object | 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. |
| service | object | 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. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/RequestCalloutPluginConfig",
"title": "RequestCalloutPluginConfig",
"x-speakeasy-entity": "PluginRequestCallout",
"properties": {
"config": {
"type": "object",
"properties": {
"cache": {
"description": "Plugin global caching configuration.",
"type": "object",
"properties": {
"cache_ttl": {
"description": "TTL in seconds of cache entities.",
"type": "integer",
"default": 300
},
"memory": {
"type": "object",
"properties": {
"dictionary_name": {
"description": "The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.",
"type": "string",
"default": "kong_db_cache"
}
}
},
"redis": {
"type": "object",
"properties": {
"cloud_authentication": {
"description": "Cloud auth related configs for connecting to a Cloud Provider's Redis instance.",
"type": "object",
"properties": {
"auth_provider": {
"description": "Auth providers to be used to authenticate to a Cloud Provider's Redis instance.",
"type": "string",
"enum": [
"aws",
"azure",
"gcp"
],
"x-referenceable": true
},
"aws_access_key_id": {
"description": "AWS Access Key ID to be used for authentication when `auth_provider` is set to `aws`.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"aws_assume_role_arn": {
"description": "The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"aws_cache_name": {
"description": "The name of the AWS Elasticache cluster when `auth_provider` is set to `aws`.",
"type": "string",
"x-referenceable": true
},
"aws_is_serverless": {
"description": "This flag specifies whether the cluster is serverless when auth_provider is set to `aws`.",
"type": "boolean",
"default": true
},
"aws_region": {
"description": "The region of the AWS ElastiCache cluster when `auth_provider` is set to `aws`.",
"type": "string",
"x-referenceable": true
},
"aws_role_session_name": {
"description": "The session name for the temporary credentials when assuming the IAM role.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"aws_secret_access_key": {
"description": "AWS Secret Access Key to be used for authentication when `auth_provider` is set to `aws`.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"azure_client_id": {
"description": "Azure Client ID to be used for authentication when `auth_provider` is set to `azure`.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"azure_client_secret": {
"description": "Azure Client Secret to be used for authentication when `auth_provider` is set to `azure`.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"azure_tenant_id": {
"description": "Azure Tenant ID to be used for authentication when `auth_provider` is set to `azure`.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"gcp_service_account_json": {
"description": "GCP Service Account JSON to be used for authentication when `auth_provider` is set to `gcp`.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
}
}
},
"cluster_max_redirections": {
"description": "Maximum retry attempts for redirection.",
"type": "integer",
"default": 5
},
"cluster_nodes": {
"description": "Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.",
"type": "array",
"items": {
"properties": {
"ip": {
"description": "A string representing a host name, such as example.com.",
"type": "string",
"default": "127.0.0.1"
},
"port": {
"description": "An integer representing a port number between 0 and 65535, inclusive.",
"type": "integer",
"default": 6379,
"maximum": 65535,
"minimum": 0
}
},
"type": "object"
},
"minLength": 1
},
"connect_timeout": {
"description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.",
"type": "integer",
"default": 2000,
"maximum": 2147483646,
"minimum": 0
},
"connection_is_proxied": {
"description": "If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.",
"type": "boolean",
"default": false
},
"database": {
"description": "Database to use for the Redis connection when using the `redis` strategy",
"type": "integer",
"default": 0
},
"host": {
"description": "A string representing a host name, such as example.com.",
"type": "string",
"default": "127.0.0.1",
"x-referenceable": true
},
"keepalive_backlog": {
"description": "Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `keepalive_pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `keepalive_pool_size`.",
"type": "integer",
"maximum": 2147483646,
"minimum": 0
},
"keepalive_pool_size": {
"description": "The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `keepalive_pool_size` nor `keepalive_backlog` is specified, no pool is created. If `keepalive_pool_size` isn't specified but `keepalive_backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.",
"type": "integer",
"default": 256,
"maximum": 2147483646,
"minimum": 1
},
"password": {
"description": "Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"port": {
"description": "An integer representing a port number between 0 and 65535, inclusive.",
"type": "integer",
"default": 6379,
"maximum": 65535,
"minimum": 0,
"x-referenceable": true
},
"read_timeout": {
"description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.",
"type": "integer",
"default": 2000,
"maximum": 2147483646,
"minimum": 0
},
"send_timeout": {
"description": "An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.",
"type": "integer",
"default": 2000,
"maximum": 2147483646,
"minimum": 0
},
"sentinel_master": {
"description": "Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.",
"type": "string"
},
"sentinel_nodes": {
"description": "Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.",
"type": "array",
"items": {
"properties": {
"host": {
"description": "A string representing a host name, such as example.com.",
"type": "string",
"default": "127.0.0.1"
},
"port": {
"description": "An integer representing a port number between 0 and 65535, inclusive.",
"type": "integer",
"default": 6379,
"maximum": 65535,
"minimum": 0
}
},
"type": "object"
},
"minLength": 1
},
"sentinel_password": {
"description": "Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"sentinel_role": {
"description": "Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel.",
"type": "string",
"enum": [
"any",
"master",
"slave"
]
},
"sentinel_username": {
"description": "Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.",
"type": "string",
"x-referenceable": true
},
"server_name": {
"description": "A string representing an SNI (server name indication) value for TLS.",
"type": "string",
"x-referenceable": true
},
"ssl": {
"description": "If set to true, uses SSL to connect to Redis.",
"type": "boolean",
"default": false
},
"ssl_verify": {
"description": "If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.",
"type": "boolean",
"default": true
},
"username": {
"description": "Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`.",
"type": "string",
"x-referenceable": true
}
}
},
"strategy": {
"description": "The backing data store in which to hold cache entities. Accepted values are: `off`, `memory`, and `redis`.",
"type": "string",
"default": "off",
"enum": [
"memory",
"off",
"redis"
]
}
}
},
"callouts": {
"description": "A collection of callout objects, where each object represents an HTTP request made in the context of a proxy request.",
"type": "array",
"items": {
"properties": {
"cache": {
"description": "Callout caching configuration.",
"type": "object",
"properties": {
"bypass": {
"description": "If `true`, skips caching the callout response.",
"type": "boolean",
"default": false
}
}
},
"depends_on": {
"description": "An array of callout names the current callout depends on. This dependency list determines the callout execution order via a topological sorting algorithm.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"name": {
"description": "A string identifier for a callout. A callout object is referenceable via its name in the `kong.ctx.shared.callouts.<name>`",
"type": "string"
},
"request": {
"description": "The customizations for the callout request.",
"type": "object",
"properties": {
"body": {
"description": "Callout request body customizations.",
"type": "object",
"properties": {
"custom": {
"description": "The custom body fields to be added to the callout HTTP request. Values can contain Lua expressions in the form $(some_lua_expression). The syntax is based on `request-transformer-advanced` templates.",
"type": "object",
"additionalProperties": {
"type": "string",
"x-referenceable": true
}
},
"decode": {
"description": "If `true`, decodes the request's body and make it available for customizations. Only JSON content type is supported.",
"type": "boolean",
"default": false
},
"forward": {
"description": "If `true`, forwards the incoming request's body to the callout request.",
"type": "boolean",
"default": false
}
}
},
"by_lua": {
"description": "Lua code that executes before the callout request is made. **Warning** can impact system behavior. Standard Lua sandboxing restrictions apply.",
"type": "string"
},
"error": {
"description": "The error handling policy the plugin will apply to TCP and HTTP errors.",
"type": "object",
"properties": {
"error_response_code": {
"description": "The error code to respond with if `on_error` is `fail` or if `retries` is achieved.",
"type": "integer",
"default": 400
},
"error_response_msg": {
"description": "The error mesasge to respond with if `on_error` is set to `fail` or if `retries` is achieved. Templating with Lua expressions is supported.",
"type": "string",
"default": "service callout error"
},
"http_statuses": {
"description": "The list of HTTP status codes considered errors under the error handling policy.",
"type": "array",
"items": {
"maximum": 999,
"minimum": 100,
"type": "integer"
}
},
"on_error": {
"type": "string",
"default": "fail",
"enum": [
"continue",
"fail",
"retry"
]
},
"retries": {
"description": "The number of retries the plugin will attempt on TCP and HTTP errors if `on_error` is set to `retry`.",
"type": "integer",
"default": 2
}
}
},
"headers": {
"description": "Callout request header customizations.",
"type": "object",
"properties": {
"custom": {
"description": "The custom headers to be added in the callout HTTP request. Values can contain Lua expressions in the form `$(some_lua_expression)`. The syntax is based on `request-transformer-advanced` templates.",
"type": "object",
"additionalProperties": {
"type": "string",
"x-referenceable": true
}
},
"forward": {
"description": "If `true`, forwards the incoming request's headers to the callout request. ",
"type": "boolean",
"default": false
}
}
},
"http_opts": {
"description": "HTTP connection parameters.",
"type": "object",
"properties": {
"proxy": {
"description": "Proxy settings.",
"type": "object",
"properties": {
"auth_password": {
"description": "The password to authenticate with, if the forward proxy is protected by basic authentication.",
"type": "string",
"x-encrypted": true,
"x-referenceable": true
},
"auth_username": {
"description": "The username to authenticate with, if the forward proxy is protected by basic authentication.",
"type": "string",
"x-referenceable": true
},
"http_proxy": {
"description": "The HTTP proxy URL. This proxy server will be used for HTTP requests.",
"type": "string"
},
"https_proxy": {
"description": "The HTTPS proxy URL. This proxy server will be used for HTTPS requests.",
"type": "string"
}
}
},
"ssl_server_name": {
"description": "The SNI used in the callout request. Defaults to host if omitted.",
"type": "string"
},
"ssl_verify": {
"description": "If set to `true`, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your callout API. You may also need to configure `lua_ssl_verify_depth` accordingly.",
"type": "boolean",
"default": true
},
"timeouts": {
"description": "Socket timeouts in milliseconds. All or none must be set.",
"type": "object",
"properties": {
"connect": {
"description": "The socket connect timeout.",
"type": "integer",
"maximum": 2147483646,
"minimum": 0
},
"read": {
"description": "The socket read timeout. ",
"type": "integer",
"maximum": 2147483646,
"minimum": 0
},
"write": {
"description": "The socket write timeout.",
"type": "integer",
"maximum": 2147483646,
"minimum": 0
}
}
}
}
},
"method": {
"description": "The HTTP method that will be requested.",
"type": "string",
"default": "GET"
},
"query": {
"description": "Callout request query param customizations.",
"type": "object",
"properties": {
"custom": {
"description": "The custom query params to be added in the callout HTTP request. Values can contain Lua expressions in the form `$(some_lua_expression)`. The syntax is based on `request-transformer-advanced` templates.",
"type": "object",
"additionalProperties": {
"type": "string",
"x-referenceable": true
}
},
"forward": {
"description": "If `true`, forwards the incoming request's query params to the callout request. ",
"type": "boolean",
"default": false
}
}
},
"url": {
"description": "The URL that will be requested. Values can contain Lua expressions in the form `$(some_lua_expression)`. The syntax is based on `request-transformer-advanced` templates.",
"type": "string",
"x-referenceable": true
}
},
"required": [
"url"
]
},
"response": {
"description": "Configurations of callout response handling.",
"type": "object",
"properties": {
"body": {
"type": "object",
"properties": {
"decode": {
"description": "If `true`, decodes the response body before storing into the context. Only JSON is supported.",
"type": "boolean",
"default": false
},
"store": {
"description": "If `false`, skips storing the callout response body into kong.ctx.shared.callouts.<name>.response.body.",
"type": "boolean",
"default": true
}
}
},
"by_lua": {
"description": "Lua code that executes after the callout response is received, before caching takes place. Can produce side effects. Standard Lua sandboxing restrictions apply.",
"type": "string"
},
"headers": {
"description": "Callout response header customizations.",
"type": "object",
"properties": {
"store": {
"description": "If `false`, skips storing the callout response headers into kong.ctx.shared.callouts.<name>.response.headers.",
"type": "boolean",
"default": true
}
}
}
}
}
},
"required": [
"name",
"request"
],
"type": "object"
}
},
"upstream": {
"description": "Customizations to the upstream request.",
"type": "object",
"properties": {
"body": {
"description": "Callout request body customizations.",
"type": "object",
"properties": {
"custom": {
"description": "The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(some_lua_expression). The syntax is based on `request-transformer-advanced` templates.",
"type": "object",
"additionalProperties": {
"type": "string",
"x-referenceable": true
}
},
"decode": {
"description": "If `true`, decodes the request's body to make it available for upstream by_lua customizations. Only JSON content type is supported.",
"type": "boolean",
"default": true
},
"forward": {
"description": "If `false`, skips forwarding the incoming request's body to the upstream request.",
"type": "boolean",
"default": true
}
}
},
"by_lua": {
"description": "Lua code that executes before the upstream request is made. Can produce side effects. Standard Lua sandboxing restrictions apply.",
"type": "string"
},
"headers": {
"description": "Callout request header customizations.",
"type": "object",
"properties": {
"custom": {
"description": "The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_expression). The syntax is based on `request-transformer-advanced` templates.",
"type": "object",
"additionalProperties": {
"type": "string",
"x-referenceable": true
}
},
"forward": {
"description": "If `false`, does not forward request headers to upstream request.",
"type": "boolean",
"default": true
}
}
},
"query": {
"description": "Upstream request query param customizations.",
"type": "object",
"properties": {
"custom": {
"description": "The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form `$(some_lua_expression)`. The syntax is based on `request-transformer-advanced` templates.",
"type": "object",
"additionalProperties": {
"type": "string",
"x-referenceable": true
}
},
"forward": {
"description": "If `false`, does not forward request query params to upstream request.",
"type": "boolean",
"default": true
}
}
}
}
}
},
"required": [
"callouts"
]
},
"consumer": {
"description": "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.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
},
"consumer_group": {
"description": "If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
},
"name": {
"const": "request-callout"
},
"protocols": {
"description": "A set of strings representing HTTP protocols.",
"type": "array",
"items": {
"enum": [
"grpc",
"grpcs",
"http",
"https"
],
"type": "string"
},
"format": "set",
"default": [
"grpc",
"grpcs",
"http",
"https"
]
},
"route": {
"description": "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.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
},
"service": {
"description": "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.",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
}
}
},
"required": [
"config"
]
}