{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://catalog.lintel.tools/schemas/schemastore/krakend/_shared/latest--krakend.json",
"title": "Schema validation for KrakenD",
"x-lintel": {
"source": "https://www.krakend.io/schema/v2.13/krakend.json",
"sourceSha256": "10e4e3da09654b235d4f77cf0e47d27e578a6ea6b51fe79a62a9d925cec73778"
},
"type": "object",
"properties": {
"async_agent": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1async_agent.json"
},
"cache_ttl": {
"title": "Cache TTL",
"description": "Sets a default `Cache-Control: public, max-age=%d` header to all endpoints where `%d` is the conversion to seconds of any duration you write, indicating for how long the client (or CDN) can cache the content of the request. You can override this value per endpoint, but setting an endpoint to 0 will use the default value instead. Notice that KrakenD does not cache the content with this parameter, but tells the client how to do it. Defaults to `0s` (no cache). **For KrakenD cache, see [backend caching](https://www.krakend.io/docs/backends/caching/)**.",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"client_tls": {
"title": "TLS Client settings",
"description": "Allows to set specific transport settings when using TLS in your upstream services. See [TLS Client](https://www.krakend.io/docs/service-settings/tls/) for more settings",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1client_tls.json"
},
"debug_endpoint": {
"title": "Debug endpoint",
"description": "Enables the `/__debug/` endpoint for this configuration. You can safely enable it in production.",
"default": false,
"type": "boolean"
},
"dialer_fallback_delay": {
"title": "Dialer fallback delay",
"description": "Specifies the length of time to wait before spawning a RFC 6555 Fast Fallback connection. If zero, a default delay of 300ms is used.\n\nSee: ",
"default": "300ms",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"dialer_keep_alive": {
"title": "Dialer keep alive",
"description": "The interval between keep-alive probes for an active network connection. If zero, keep-alive probes are sent with a default value (currently 15 seconds), if supported by the protocol and operating system. Network protocols or operating systems that do not support keep-alives ignore this field. If negative, keep-alive probes are disabled.\n\nSee: ",
"default": "15s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"dialer_timeout": {
"title": "Dialer Timeout",
"description": "The timeout of the dial function for creating connections.The default is no timeout. With or without a timeout, the operating system may impose its own earlier timeout.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"disable_compression": {
"title": "Disable compression",
"description": "When true prevents requesting compression with an `Accept-Encoding: gzip` request header when the Request contains no existing Accept-Encoding value. If the Transport requests gzip on its own and gets a gzipped response, it's transparently decoded. However, if the user explicitly requested gzip it is not automatically uncompressed.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_keep_alives": {
"title": "Disable keep alives",
"description": "When true it disables HTTP keep-alives and will only use the connection to the server for a single HTTP request.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_rest": {
"title": "Disable RESTful URLs",
"description": "Endpoints require in its `endpoint` definition the usage of a RESTful pattern. If you require unrestful patterns, like `/file.{ext}` (instead of its RESTful counterpart `/file/{ext}`), then you must set this parameter to `true`.\nYou can use multiple variables if needed, but only one can be in an unrestful position, and when you do, it must be in the last position of the definition. E.g.: you can declare an endpoint `/file/{name}/base.{ext}` but you cannot do `/file.{ext}.json` because the variable `{ext}` is not in the last position of the definitino, and therefore the remaining path after `{ext}` is ignored by the router.",
"default": false,
"type": "boolean"
},
"dns_cache_ttl": {
"title": "DNS Cache TTL",
"description": "Sets the maximum time KrakenD can store the results of a query to the configured Service Discovery returning the available hosts list. For values under `1s` this setting is ignored.\n\nSee: ",
"default": "30s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"echo_endpoint": {
"title": "Echo endpoint",
"description": "Enables the `/__echo/` endpoint for this configuration, that returns information about the incoming request. When using /__echo as a backend you can check the actual headers and content a backend receives after all the zero-trust filtering.",
"default": false,
"type": "boolean"
},
"endpoints": {
"title": "Endpoints",
"description": "Your API contract, or the list of all paths recognized by this gateway. The paths `/__health/`, `/__debug/`, `/__echo/`, `/__catchall`, and `/__stats/` are reserved by the system and you cannot declare them. Their existence depends on their respective settings.\n\nSee: ",
"type": "array",
"items": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1endpoint.json",
"type": "object"
}
},
"expect_continue_timeout": {
"title": "Expect_continue_timeout",
"description": "If non-zero, specifies the amount of time to wait for a server's first response headers after fully writing the request headers if the request has an `Expect: 100-continue` header. Zero means no timeout and causes the body to be sent immediately, without waiting for the server to approve. This time does not include the time to send the request header.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"extra_config": {
"title": "Extra configuration",
"description": "The optional configuration that extends the core functionality of the gateway is specified here. The `extra_config` at this level enables service components, meaning that they apply globally to all endpoints or activity.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1service_extra_config.json",
"type": "object"
},
"host": {
"title": "Default host",
"description": "The default host list for all backends if they specify none.",
"type": "array",
"items": {
"type": "string"
}
},
"idle_connection_timeout": {
"title": "HTTP Idle timeout",
"description": "The maximum number of idle (keep-alive) connections across all hosts. Zero means no limit.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"idle_timeout": {
"title": "HTTP Idle timeout",
"description": "The maximum amount of time to wait for the next request when keep-alives are enabled. If `idle_timeout` is zero, the value of `read_timeout` is used. If both are zero, there is no timeout.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"listen_ip": {
"title": "Listen IP",
"description": "The IP address that KrakenD listens to in IPv4 or IPv6. An empty string, or no declaration at all means listening on all interfaces. The inclusion of `::` is meant for IPv6 format only (**this is not the port**). Examples of valid addresses are `192.0.2.1` (IPv4), `2001:db8::68` (IPv6). The values `::` and `0.0.0.0` listen to all addresses and both are valid for IPv4 and IPv6 simultaneously.",
"examples": [
"172.12.1.1",
"::1"
],
"default": "0.0.0.0",
"type": "string"
},
"max_header_bytes": {
"title": "Max header bytes",
"description": "Allows overriding the maximum size of headers sent in bytes. It does not limit the request body. When the value is zero, the default is used instead (1MB)\n\nSee: ",
"default": 1000000,
"type": "integer"
},
"max_idle_connections": {
"title": "Max idle connections",
"description": "The maximum number of idle (keep-alive) connections across all hosts. Zero means no limit.\n\nSee: ",
"default": 0,
"type": "integer"
},
"max_idle_connections_per_host": {
"title": "Max idle connections per host",
"description": "If non-zero, controls the maximum idle (keep-alive) connections to keep per-host. If zero, `250` is used instead.\n\nSee: ",
"default": 250,
"type": "integer"
},
"max_shutdown_wait_time": {
"title": "Max shutdown wait time",
"description": "The gateway gracefully shuts down, waiting for all active connections to drain. Nevertheless, persistent connections or long timeouts may leave the shutdown process running for an extended period. Set the maximum time to wait for all the remaining requests to finish when shutting down the service. After this time, the service will force a shutdown. Defaults to `0s` (wait indefinitely). \n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"name": {
"title": "Name",
"description": "Used in telemetry. A friendly name, title, date, version or any other short description that helps you recognize the configuration.",
"default": "KrakenD configuration at MyCompany",
"type": "string"
},
"output_encoding": {
"title": "Output Encoding",
"description": "The encoding used to display the content to the end-user. This setting is the default for all endpoints, unless they have another `output_encoding` overrinding this value.\n\nSee: ",
"default": "json",
"enum": [
"json",
"fast-json",
"json-collection",
"xml",
"negotiate",
"string",
"no-op"
]
},
"plugin": {
"title": "Plugin",
"description": "Enables external plugins that are copied in a specific folder",
"type": "object",
"required": [
"pattern",
"folder"
],
"properties": {
"pattern": {
"title": "Pattern",
"description": "The pattern narrows down the contents of the folder. It represents the substring that must be present in the plugin name to load.",
"examples": [
".so",
"-production.so"
],
"default": ".so",
"type": "string"
},
"folder": {
"title": "Folder",
"description": "The path in the filesystem where all the plugins you want to load are. MUST END IN SLASH. The folder can be a relative or absolute path. KrakenD Enterprise uses /opt/krakend/plugins/ for all plugins.",
"examples": [
"/opt/krakend/plugins/",
"./plugins/"
],
"default": "/opt/krakend/plugins/",
"type": "string"
}
}
},
"port": {
"title": "Port",
"description": "The TCP port where KrakenD is listening to. Recommended value is in the range 1024-65535 to run as an unpriviliged user",
"default": 8080,
"type": "integer",
"maximum": 65535,
"minimum": 0
},
"read_header_timeout": {
"title": "HTTP Idle timeout",
"description": "The amount of time allowed to read request headers. The connection's read deadline is reset after reading the headers and the Handler can decide what is considered too slow for the body.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"read_timeout": {
"title": "HTTP read timeout",
"description": "Is the maximum duration for reading the entire request, including the body. Because `read_timeout` does not let Handlers make per-request decisions on each request body's acceptable deadline or upload rate, most users will prefer to use `read_header_timeout`. It is valid to use them both.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"response_header_timeout": {
"title": "Response header timeout",
"description": "If non-zero, specifies the amount of time to wait for a server's response headers after fully writing the request (including its body, if any). This time does not include the time to read the response body.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"sequential_start": {
"title": "Sequential start",
"description": "A sequential start registers all async agents in order, allowing you to have the starting logs in sequential order. A non-sequential start is much faster, but logs are harder to follow.\n\nSee: ",
"default": false,
"type": "boolean"
},
"timeout": {
"title": "Global timeout",
"description": "Defines a default timeout for all endpoints. Can be overriden per endpoint.\n\nSee: ",
"default": "2s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"tls": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1tls.json"
},
"use_h2c": {
"title": "Enable h2c",
"description": "Enable the support for HTTP/2 with no TLS. This option is only advised when you have a load balancer in front of KrakenD doing SSL termination, and you have no option to enable SSL communication between the balancer and KrakenD (no internal certificates available either). Otherwise, enabling this flag is less secure and less performant.\n\nSee: ",
"default": false,
"type": "boolean"
},
"version": {
"title": "Version of this syntax",
"description": "The syntax version tells KrakenD how to read this configuration. This is not the KrakenD version. Each KrakenD version is linked to a syntax version, and since KrakenD v2.0 the version must be `3`",
"const": 3
},
"write_timeout": {
"title": "HTTP write timeout",
"description": "Maximum duration before timing out writes of the response.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
}
},
"patternProperties": {
"^[@$_#]": true
},
"$defs": {
"https://www.krakend.io/schema/v2.13/ai/anthropic.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Anthropic integration",
"description": "Connect to Anthropic models easily by providing your API key and optional parameters.\n\nSee: ",
"type": "object",
"maxProperties": 1,
"minProperties": 1,
"properties": {
"v1": {
"title": "Version v1",
"description": "All settings depend on a specific version, as the vendor might change the API over time.\n\nSee: ",
"type": "object",
"required": [
"credentials",
"variables"
],
"properties": {
"credentials": {
"title": "API Key",
"description": "Your Anthropic API key. You can set it as an environment variable for better security.\n\nSee: ",
"type": "string"
},
"debug": {
"title": "Debug Mode",
"description": "Enables the debug mode to log activity for troubleshooting. Do not set this value to true in production as it may log sensitive data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"input_template": {
"title": "Input Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets the payload format sent to Anthropic. You don't need to set this value unless you want to override the default template making use of all the `variables` listed in this configuration.\n\nSee: ",
"type": "string"
},
"output_template": {
"title": "Output Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets how the response from Anthropic is transformed before being sent to the client. The default template extracts the text from the first choice returned by Anthropic so in most cases you don't need to set a custom output template.\n\nSee: ",
"type": "string"
},
"variables": {
"title": "Model Variables",
"description": "The variables specific to the Anthropic usage that are used to construct the payload.\n\nSee: ",
"type": "object",
"required": [
"model"
],
"properties": {
"extra_payload": {
"title": "Extra Payload",
"description": "A map of additional payload attributes you want to use in your custom `input_template` (this payload is not used in the default template). The attributes set here are accessible in your custom template as `{{ .variables.extra_payload.yourchosenkey }}`. This option helps adding rare customization and future attributes.\n\nSee: ",
"type": "object"
},
"max_tokens": {
"title": "Max Tokens",
"description": "Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words.\n\nSee: ",
"default": 1024,
"type": "integer"
},
"model": {
"title": "Model Name",
"description": "The name of the Anthropic model you want to use.\n\nSee: ",
"examples": [
"claude-opus-4-1-20250805",
"claude-sonnet-4-20250514",
"claude-3-7-sonnet-latest",
"claude-3-5-haiku-latest"
],
"type": "string"
},
"stop_sequences": {
"title": "Stop Sequences",
"description": "An array of sequences where the model will stop generating further tokens if found. This can be useful to control the length and content of the output.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"temperature": {
"title": "Temperature",
"description": "The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results.\n\nSee: ",
"type": "number",
"maximum": 2,
"minimum": 0
},
"top_k": {
"title": "Top K",
"description": "Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature.\n\nSee: ",
"type": "integer"
},
"top_p": {
"title": "Top P",
"description": "Top-P changes how the model selects tokens for output. Tokens are selected from the most probable to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate.\n\nSee: ",
"type": "number"
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/ai/bedrock.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Bedrock integration",
"description": "Connect to Bedrock models easily by providing your API key and optional parameters.\n\nSee: ",
"type": "object",
"maxProperties": 1,
"minProperties": 1,
"properties": {
"v1": {
"title": "Version v1",
"description": "All settings depend on a specific version, as the vendor might change the API over time.\n\nSee: ",
"required": [
"credentials",
"variables"
],
"properties": {
"credentials": {
"title": "API Key",
"description": "Your Bedrock API key. You can set it as an environment variable for better security.\n\nSee: ",
"type": "string"
},
"debug": {
"title": "Debug Mode",
"description": "Enables the debug mode to log activity for troubleshooting. Do not set this value to true in production as it may log sensitive data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"input_template": {
"title": "Input Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets the payload format sent to Bedrock. You don't need to set this value unless you want to override the default template making use of all the `variables` listed in this configuration.\n\nSee: ",
"type": "string"
},
"output_template": {
"title": "Output Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets how the response from Bedrock is transformed before being sent to the client. The default template extracts the text from the first choice returned by Bedrock so in most cases you don't need to set a custom output template.\n\nSee: ",
"type": "string"
},
"variables": {
"title": "Model Variables",
"description": "The variables specific to the Bedrock usage that are used to construct the payload.\n\nSee: ",
"type": "object",
"properties": {
"extra_payload": {
"title": "Extra Payload",
"description": "A map of additional payload attributes you want to use in your custom `input_template` (this payload is not used in the default template). The attributes set here are accessible in your custom template as `{{ .variables.extra_payload.yourchosenkey }}`. This option helps adding rare customization and future attributes.\n\nSee: ",
"type": "object"
},
"max_tokens": {
"title": "Max Tokens",
"description": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.\n\nSee: ",
"type": "integer"
},
"stop_sequences": {
"title": "Stop Sequences",
"description": "An array of sequences where the model will stop generating further tokens if found. This can be useful to control the length and content of the output.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"temperature": {
"title": "Temperature",
"description": "What sampling temperature to use, recommended between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Change this or top_p but not both.\n\nSee: ",
"type": "number",
"maximum": 2,
"minimum": 0
},
"top_k": {
"title": "Top K",
"description": "Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature.\n\nSee: ",
"type": "integer"
},
"top_p": {
"title": "Top P",
"description": "A float value between 0 and 1 that controls the nucleus sampling for text generation. It represents the cumulative probability threshold for token selection, where only the most probable tokens that add up to this threshold are considered. A higher value (closer to 1) allows for more diverse outputs, while a lower value (closer to 0) makes the output more focused and deterministic. Change this or temperature but not both.\n\nSee: ",
"type": "number"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/ai/gemini.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Google Gemini integration",
"description": "Connect to Google Gemini models easily by providing your API key and optional parameters.\n\nSee: ",
"type": "object",
"maxProperties": 1,
"minProperties": 1,
"properties": {
"v1beta": {
"title": "Version v1",
"description": "All settings depend on a specific version, as the vendor might change the API over time.\n\nSee: ",
"type": "object",
"required": [
"credentials"
],
"properties": {
"credentials": {
"title": "API Key",
"description": "Your Google Gemini API key. You can set it as an environment variable for better security.\n\nSee: ",
"type": "string"
},
"debug": {
"title": "Debug Mode",
"description": "Enables the debug mode to log activity for troubleshooting. Do not set this value to true in production as it may log sensitive data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"input_template": {
"title": "Input Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets the payload format sent to Google Gemini. You don't need to set this value unless you want to override the default template making use of all the `variables` listed in this configuration.\n\nSee: ",
"type": "string"
},
"output_template": {
"title": "Output Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets how the response from Google Gemini is transformed before being sent to the client. The default template extracts the text from the first choice returned by Google Gemini so in most cases you don't need to set a custom output template.\n\nSee: ",
"type": "string"
},
"variables": {
"title": "Model Variables",
"description": "The variables specific to the Google Gemini usage that are used to construct the payload.\n\nSee: ",
"type": "object",
"properties": {
"candidate_count": {
"title": "Candidate Count",
"description": "An integer value that specifies how many different completions (responses) the model should generate for a single input prompt. This can be useful for exploring multiple variations of the output.\n\nSee: ",
"default": 1,
"type": "integer"
},
"extra_payload": {
"title": "Extra Payload",
"description": "A map of additional payload attributes you want to use in your custom `input_template` (this payload is not used in the default template). The attributes set here are accessible in your custom template as `{{ .variables.extra_payload.yourchosenkey }}`. This option helps adding rare customization and future attributes.\n\nSee: ",
"type": "object"
},
"max_output_tokens": {
"title": "Max Tokens",
"description": "Maximum number of tokens that can be generated in the response. A token is approximately four characters. 100 tokens correspond to roughly 60-80 words.\n\nSee: ",
"type": "integer"
},
"stop_sequences": {
"title": "Stop Sequences",
"description": "An array of sequences where the model will stop generating further tokens if found. This can be useful to control the length and content of the output.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"temperature": {
"title": "Temperature",
"description": "The temperature is used for sampling during response generation, which occurs when topP and topK are applied. Temperature controls the degree of randomness in token selection. Lower temperatures are good for prompts that require a less open-ended or creative response, while higher temperatures can lead to more diverse or creative results.\n\nSee: ",
"type": "number",
"maximum": 2,
"minimum": 0
},
"top_k": {
"title": "Top K",
"description": "Top-K changes how the model selects tokens for output. A top-K of 1 means the next selected token is the most probable among all tokens in the model's vocabulary (also called greedy decoding), while a top-K of 3 means that the next token is selected from among the three most probable tokens by using temperature.\n\nSee: ",
"type": "integer"
},
"top_p": {
"title": "Top P",
"description": "Top-P changes how the model selects tokens for output. Tokens are selected from the most probable to least probable until the sum of their probabilities equals the top-P value. For example, if tokens A, B, and C have a probability of 0.3, 0.2, and 0.1 and the top-P value is 0.5, then the model will select either A or B as the next token by using temperature and excludes C as a candidate.\n\nSee: ",
"type": "number"
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/ai/mistral.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Mistral integration",
"description": "Connect to Mistral models easily by providing your API key and optional parameters.\n\nSee: ",
"type": "object",
"maxProperties": 1,
"minProperties": 1,
"properties": {
"v1": {
"title": "Version v1",
"description": "All settings depend on a specific version, as the vendor might change the API over time.\n\nSee: ",
"required": [
"credentials",
"variables"
],
"properties": {
"credentials": {
"title": "API Key",
"description": "Your Mistral API key. You can set it as an environment variable for better security.\n\nSee: ",
"type": "string"
},
"debug": {
"title": "Debug Mode",
"description": "Enables the debug mode to log activity for troubleshooting. Do not set this value to true in production as it may log sensitive data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"input_template": {
"title": "Input Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets the payload format sent to Mistral. You don't need to set this value unless you want to override the default template making use of all the `variables` listed in this configuration.\n\nSee: ",
"type": "string"
},
"output_template": {
"title": "Output Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets how the response from Mistral is transformed before being sent to the client. The default template extracts the text from the first choice returned by Mistral so in most cases you don't need to set a custom output template.\n\nSee: ",
"type": "string"
},
"variables": {
"title": "Model Variables",
"description": "The variables specific to the Mistral usage that are used to construct the payload.\n\nSee: ",
"type": "object",
"required": [
"model"
],
"properties": {
"extra_payload": {
"title": "Extra Payload",
"description": "A map of additional payload attributes you want to use in your custom `input_template` (this payload is not used in the default template). The attributes set here are accessible in your custom template as `{{ .variables.extra_payload.yourchosenkey }}`. This option helps adding rare customization and future attributes.\n\nSee: ",
"type": "object"
},
"max_tokens": {
"title": "Max Tokens",
"description": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens.\n\nSee: ",
"type": "integer"
},
"model": {
"title": "Model Name",
"description": "The name of the Mistral model you want to use. The value you provide is passed as is to Mistral and KrakenD does not prove if the model is currently accepted by the vendor. Check the available models on Mistral documentation.\n\nSee: ",
"examples": [
"mistral-small-latest",
"codestral-latest"
],
"type": "string"
},
"n": {
"title": "Number of Completions",
"description": "An integer value that specifies how many different completions (responses) the model should generate for a single input prompt. This can be useful for exploring multiple variations of the output.\n\nSee: ",
"default": 1,
"type": "integer"
},
"random_seed": {
"title": "Random Seed",
"description": "An integer value to seed the random number generator used by the model. Setting a specific seed can help produce reproducible results across different requests.\n\nSee: ",
"type": "integer"
},
"safe_prompt": {
"title": "Safe Prompt",
"description": "A boolean flag to enable or disable Mistral's safe prompt feature, which helps filter out inappropriate or harmful content from the model's responses. By default, this feature is enabled to ensure safer interactions.\n\nSee: ",
"default": false,
"type": "boolean"
},
"stop": {
"title": "Stop Sequences",
"description": "An array of sequences where the model will stop generating further tokens if found. This can be useful to control the length and content of the output.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"temperature": {
"title": "Temperature",
"description": "What sampling temperature to use, recommended between 0.0 and 0.7. Higher values like 0.7 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Change this or top_p but not both.\n\nSee: ",
"type": "number",
"maximum": 2,
"minimum": 0
},
"top_p": {
"title": "Top P",
"description": "A float value between 0 and 1 that controls the nucleus sampling for text generation. It represents the cumulative probability threshold for token selection, where only the most probable tokens that add up to this threshold are considered. A higher value (closer to 1) allows for more diverse outputs, while a lower value (closer to 0) makes the output more focused and deterministic. Change this or temperature but not both.\n\nSee: ",
"type": "number"
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/ai/openai.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "OpenAI integration",
"description": "Connect to OpenAI's GPT models easily by providing your API key and optional parameters.\n\nSee: ",
"type": "object",
"maxProperties": 1,
"minProperties": 1,
"properties": {
"v1": {
"title": "Version v1",
"description": "All settings depend on a specific version, as the vendor might change the API over time.\n\nSee: ",
"required": [
"credentials",
"variables"
],
"properties": {
"credentials": {
"title": "API Key",
"description": "Your OpenAI API key. You can set it as an environment variable for better security.\n\nSee: ",
"examples": [
"sk-xxxx"
],
"type": "string"
},
"debug": {
"title": "Debug Mode",
"description": "Enables the debug mode to log activity for troubleshooting. Do not set this value to true in production as it may log sensitive data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"input_template": {
"title": "Input Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets the payload format sent to OpenAI. You don't need to set this value unless you want to override the default template making use of all the `variables` listed in this configuration.\n\nSee: ",
"type": "string"
},
"output_template": {
"title": "Output Template",
"description": "A path to a custom [Go template](https://pkg.go.dev/text/template) that sets how the response from OpenAI is transformed before being sent to the client. The default template extracts the text from the first choice returned by OpenAI so in most cases you don't need to set a custom output template.\n\nSee: ",
"type": "string"
},
"variables": {
"title": "Template Variables",
"description": "The variables specific to the OpenAI usage that are used to construct the payload.\n\nSee: ",
"type": "object",
"required": [
"model"
],
"properties": {
"extra_payload": {
"title": "Extra Payload",
"description": "A map of additional payload attributes you want to use in your custom `input_template` (this payload is not used in the default template). The attributes set here are accessible in your custom template as `{{ .variables.extra_payload.yourchosenkey }}`. This option helps adding rare customization and future attributes.\n\nSee: ",
"type": "object"
},
"max_output_tokens": {
"title": "Max Output Tokens",
"description": "An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens. Setting this value to `0` does not set any limit.\n\nSee: ",
"type": "integer"
},
"model": {
"title": "Model Name",
"description": "The name of the OpenAI model you want to use. The value you provide is passed as is to OpenAI and KrakenD does not prove if the model is currently accepted by the vendor. Check the available models on OpenAI documentation.\n\nSee: ",
"examples": [
"gpt-5-nano",
"gpt-4"
],
"type": "string"
},
"temperature": {
"title": "Temperature",
"description": "What sampling temperature to use, between `0` and `2`. Higher values like `0.8` will make the output more random, while lower values like `0.2` will make it more focused and deterministic.\n\nSee: ",
"type": "number",
"maximum": 2,
"minimum": 0
},
"top_p": {
"title": "Top P",
"description": "The nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nSee: ",
"type": "number",
"maximum": 1,
"minimum": 0
},
"truncation": {
"title": "Truncation Strategy",
"description": "The strategy to use when truncating messages to fit within the model's context length (, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation.\n\nSee: ",
"default": "disabled",
"enum": [
"auto",
"disabled"
]
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/ai/llm.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "AI LLM Connectors",
"description": "Ready-to-use LLM connectors available for major AI vendors.\n\nSee: ",
"type": "object",
"maxProperties": 1,
"properties": {
"anthropic": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1ai~1anthropic.json"
},
"gemini": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1ai~1gemini.json"
},
"mistral": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1ai~1mistral.json"
},
"openai": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1ai~1openai.json"
},
"bedrock": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1ai~1bedrock.json"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/aws-sigv4.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "aws-sigv4 Authentication",
"description": "Enterprise only. Enables AWS Sigv4 authentication between KrakenD and Google Cloud service account.\n\nSee: ",
"type": "object",
"required": [
"region",
"service"
],
"properties": {
"assume_role_arn": {
"title": "Assume Role ARN",
"description": "The Amazon Resource Name (ARN) of the role to assume.\n\nSee: ",
"examples": [
"arn:aws:sts::{account ID}:assumed-role/{resource}"
],
"type": "string"
},
"debug": {
"title": "Debug",
"description": "Enables debug logging for AWS Sigv4 signing process.\n\nSee: ",
"default": false,
"type": "boolean"
},
"region": {
"title": "Region",
"description": "The AWS region where the service is deployed.\n\nSee: ",
"examples": [
"us-east-1"
],
"type": "string"
},
"service": {
"title": "Service",
"description": "The name of the service in AWS you'd like to sign the request.\n\nSee: ",
"examples": [
"dynamodb"
],
"type": "string"
},
"sts_region": {
"title": "STS Region",
"description": "The AWS region where the STS service is deployed.\n\nSee: ",
"examples": [
"us-west-1"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/client-credentials.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "OAuth2 client-credentials",
"description": "2-legged OAuth2 flow: Request to your authorization server an access token to reach protected resources.\n\nSee: ",
"type": "object",
"required": [
"client_id",
"client_secret",
"token_url"
],
"properties": {
"client_id": {
"title": "Client ID",
"description": "The Client ID provided to the Auth server\n\nSee: ",
"type": "string"
},
"client_secret": {
"title": "Client secret",
"description": "The secret string provided to the Auth server.\n\nSee: ",
"examples": [
"mys3cr3t"
],
"type": "string"
},
"endpoint_params": {
"title": "Endpoint parameters",
"description": "Any additional parameters you want to include **in the payload** when requesting the token. For instance, adding the `audience` request parameter may denote the target API for which the token should be issued.\n\nSee: ",
"examples": [
{
"audience": [
"YOUR-AUDIENCE"
]
}
],
"type": "object"
},
"scopes": {
"title": "Scopes",
"description": "A comma-separated list of scopes needed, e.g.: `scopeA,scopeB`\n\nSee: ",
"examples": [
"scopeA,scopeB"
],
"type": "string"
},
"token_url": {
"title": "Token URL",
"description": "The endpoint URL where the negotiation of the token happens\n\nSee: ",
"examples": [
"https://your.custom.identity.service.tld/token_endpoint"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/gcp.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "GCP Authentication",
"description": "Enterprise only. Enables GCP authentication between KrakenD and Google Cloud service account.\n\nSee: ",
"type": "object",
"anyOf": [
{
"required": [
"audience"
]
},
{
"required": [
"audience",
"credentials_file"
]
},
{
"required": [
"audience",
"credentials_json"
]
}
],
"properties": {
"audience": {
"title": "Audience",
"description": "The audience in GCP looks like an URL, and contains the destination service you will ask a token for. Most of the times this URL will match exactly with the `host` entry.\n\nSee: ",
"examples": [
"https://gcptest-76fewi6rca-uc.a.run.app"
],
"type": "string"
},
"credentials_file": {
"title": "Path to credentials file",
"description": "The relative or absolute path to a credentials file in JSON format that contains all the credentials to authenticate API calls to the given service account.\n\nSee: ",
"examples": [
"/etc/krakend/gcp.json"
],
"type": "string"
},
"credentials_json": {
"title": "JSON credentials file",
"description": "An inline JSON object containing all the credentials fields to authenticate to GCP.\n\nSee: ",
"examples": [
{
"type": "service_account",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"client_email": "xyz@developer.gserviceaccount.com",
"client_id": "123",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/xyz%40developer.gserviceaccount.com",
"private_key": "-----BEGIN PRIVATE KEY-----\nSOME_KEY\n-----END PRIVATE KEY-----\n",
"private_key_id": "private_key_id",
"project_id": "project_id",
"token_uri": "https://accounts.google.com/o/oauth2/token"
}
],
"type": "object"
},
"custom_claims": {
"title": "Custom claims",
"description": "Custom private claims that you can optionally add to an ID token.\n\nSee: ",
"type": "object"
},
"s2s_auth_header": {
"title": "Service-to-service authentication header",
"description": "The header name to use in service-to-service authentication. This is useful to honor the original Authorization header in case it's needed by the backend (for example, CloudRun).\n\nSee: ",
"examples": [
"X-Serverless-Authorization"
],
"default": "",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/ntlm.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "NTLM Authentication",
"description": "Enterprise only. Enables NTLM authentication between KrakenD and a Microsoft server such as Dynamics.\n\nSee: ",
"type": "object",
"required": [
"user",
"password"
],
"properties": {
"password": {
"title": "Password",
"description": "The password you will use, in clear text.\n\nSee: ",
"examples": [
"myp4ssw0rd"
],
"type": "string"
},
"user": {
"title": "User",
"description": "The username you will send as NTLM authentication user.\n\nSee: ",
"examples": [
"krakendclient"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/amqp/consumer.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "AMQP Consumer",
"description": "The AMQP component allows to send and receive messages to and from a queue through the API Gateway.\n\nSee: ",
"type": "object",
"required": [
"name",
"exchange",
"routing_key"
],
"properties": {
"auto_ack": {
"title": "Auto ACK",
"description": "When KrakenD retrieves the messages, regardless of the success or failure of the operation, it marks them as `ACK`nowledge.\n\nSee: ",
"default": false,
"type": "boolean"
},
"backoff_strategy": {
"title": "Backoff strategy",
"description": "When the connection to your event source gets interrupted for whatever reason, KrakenD keeps trying to reconnect until it succeeds or until it reaches the `max_retries`. The backoff strategy defines the delay in seconds in between consecutive failed retries. [Check the meaning of each strategy](https://www.krakend.io/docs/async/#backoff-strategies).\n\nSee: ",
"default": "fallback",
"enum": [
"linear",
"linear-jitter",
"exponential",
"exponential-jitter",
"fallback"
]
},
"delete": {
"title": "Delete",
"description": "When `true`, AMQP deletes the queue when there are no remaining connections. This option is **not recommended** in most of the scenarios. If for instance, the connectivity between KrakenD and AMQP is lost for whatever reason and it's the only client, AMQP will delete the queue no matter the number of messages there are inside, and when KrakenD gets the connection again the queue won't exist and future connections will recreate it again.\n\nSee: ",
"default": false,
"type": "boolean"
},
"durable": {
"title": "Durable",
"description": "Durable queues will survive server restarts and remain when there are no remaining consumers or bindings. `true` is recommended, but depends on the use case. \n\nSee: ",
"default": false,
"type": "boolean"
},
"exchange": {
"title": "Exchange",
"description": "The exchange name (must have a **topic** type if already exists).\n\nSee: ",
"examples": [
"some-exchange"
],
"type": "string"
},
"exclusive": {
"title": "Exclusive",
"description": "When `true`, AMQP will allow **a single KrakenD instance** to access the queue. This option is **not recommended** in environments where the gateway needs high availability and you have several instances running.\n\nSee: ",
"default": false,
"type": "boolean"
},
"max_retries": {
"title": "Max retries",
"description": "The maximum number of times you will allow KrakenD to retry reconnecting to a broken messaging system. During startup KrakenD will wait for a maximum of 3 retries before starting to use this policy. Use 0 for unlimited retries.\n\nSee: ",
"default": 0,
"type": "integer"
},
"nack_discard": {
"title": "NACK Discard",
"description": "When `true`, messages that cannot be processed are discarded instead of being sent back to the queue. This is useful for scenarios where you want to avoid reprocessing failed messages.\n\nSee: ",
"default": false,
"type": "boolean"
},
"name": {
"title": "Name",
"description": "Queue name.\n\nSee: ",
"type": "string"
},
"no_local": {
"title": "No local",
"description": "The no_local flag is not supported by RabbitMQ.\n\nSee: ",
"type": "boolean"
},
"no_wait": {
"title": "No wait",
"description": "When true, do not wait for the server to confirm the request and immediately begin deliveries. If it is not possible to consume, a channel exception will be raised and the channel will be closed.\n\nSee: ",
"type": "boolean"
},
"prefetch_count": {
"title": "Prefetch count",
"description": "The number of messages you want to prefetch prior to consume them.\n\nSee: ",
"default": 0,
"type": "integer"
},
"routing_key": {
"title": "Routing keys",
"description": "The list of routing keys you will use to consume messages.\n\nSee: ",
"examples": [
[
"#"
]
],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/amqp/producer.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "AMQP Producer",
"description": "Send messages to a queue through the API Gateway.\n\nSee: ",
"type": "object",
"required": [
"name",
"exchange",
"routing_key"
],
"properties": {
"backoff_strategy": {
"title": "Backoff strategy",
"description": "When the connection to your event source gets interrupted for whatever reason, KrakenD keeps trying to reconnect until it succeeds or until it reaches the `max_retries`. The backoff strategy defines the delay in seconds in between consecutive failed retries. [Check the meaning of each strategy](https://www.krakend.io/docs/async/#backoff-strategies).\n\nSee: ",
"default": "fallback",
"enum": [
"linear",
"linear-jitter",
"exponential",
"exponential-jitter",
"fallback"
]
},
"delete": {
"title": "Delete",
"description": "When `true`, AMQP deletes the queue when there are no remaining connections. This option is **not recommended** in most of the scenarios. If for instance, the connectivity between KrakenD and AMQP is lost for whatever reason and it's the only client, AMQP will delete the queue no matter the number of messages there are inside, and when KrakenD gets the connection again the queue won't exist and future connections will recreate it again.\n\nSee: ",
"default": false,
"type": "boolean"
},
"durable": {
"title": "Durable",
"description": "true is recommended, but depends on the use case. Durable queues will survive server restarts and remain when there are no remaining consumers or bindings.\n\nSee: ",
"default": false,
"type": "boolean"
},
"exchange": {
"title": "Exchange",
"description": "The exchange name (must have a topic type if already exists).\n\nSee: ",
"examples": [
"some-exchange"
],
"type": "string"
},
"exclusive": {
"title": "Exclusive",
"description": "When `true`, AMQP will allow **a single KrakenD instance** to access the queue. This option is **not recommended** in environments where the gateway needs high availability and you have several instances running.\n\nSee: ",
"default": false,
"type": "boolean"
},
"exp_key": {
"title": "Expiration key",
"description": "Take a parameter from a `{placeholder}` in the endpoint definition to use as the expiration key. The key must have the first letter uppercased. For instance, when an endpoint parameter is defined as `{id}`, you must write `Id`.\n\nSee: ",
"default": "",
"type": "string"
},
"immediate": {
"title": "Immediate",
"description": "A consumer must be connected to the queue when true.\n\nSee: ",
"default": false,
"type": "boolean"
},
"mandatory": {
"title": "Mandatory",
"description": "The exchange must have at least one queue bound when true.\n\nSee: ",
"default": false,
"type": "boolean"
},
"max_retries": {
"title": "Max retries",
"description": "The maximum number of times you will allow KrakenD to retry reconnecting to a broken messaging system. During startup KrakenD will wait for a maximum of 3 retries before starting to use this policy. Use 0 for unlimited retries.\n\nSee: ",
"default": 0,
"type": "integer"
},
"msg_id_key": {
"title": "Expiration key",
"description": "Take a parameter from a `{placeholder}` in the endpoint definition to use as the message identifier. The key must have the first letter uppercased. For instance, when an endpoint parameter is defined as `{id}`, you must write `Id`.\n\nSee: ",
"default": "",
"type": "string"
},
"name": {
"title": "Name",
"description": "Queue name.\n\nSee: ",
"type": "string"
},
"no_local": {
"title": "No local",
"description": "The no_local flag is not supported by RabbitMQ.\n\nSee: ",
"type": "boolean"
},
"no_wait": {
"title": "No wait",
"description": "When true, do not wait for the server to confirm the request and immediately begin deliveries. If it is not possible to consume, a channel exception will be raised and the channel will be closed.\n\nSee: ",
"type": "boolean"
},
"priority_key": {
"title": "Expiration key",
"description": "Take a parameter from a `{placeholder}` in the endpoint definition to use as the reply key. The key must have the first letter uppercased. For instance, when an endpoint parameter is defined as `{id}`, you must write `Id`.\n\nSee: ",
"default": "",
"type": "string"
},
"reply_to_key": {
"title": "Expiration key",
"description": "Take a parameter from a `{placeholder}` in the endpoint definition to use as the reply key. The key must have the first letter uppercased. For instance, when an endpoint parameter is defined as `{id}`, you must write `Id`.\n\nSee: ",
"default": "",
"type": "string"
},
"routing_key": {
"title": "Routing key",
"description": "The routing key you will use to send messages, case sensitive.\n\nSee: ",
"default": "#",
"type": "string"
},
"static_routing_key": {
"title": "Static Routing key",
"description": "Defines whether the `routing_key` will have a static value or not, instead of taking the value from a parameter.\n\nSee: ",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/conditional.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Conditional Routing",
"description": "Evaluates a rule to determine if the backend is callable or not, and skip to the next one in case it's not.\n\nSee: ",
"type": "object",
"required": [
"strategy"
],
"properties": {
"name": {
"title": "Header Name",
"description": "Only used with the `header` strategy. It is the name of the header you want to use for the evaluation in the [canonical format of the MIME header](https://www.krakend.io/docs/endpoints/parameter-forwarding/#case-sensitive-and-case-insensitive-parameters). **Make sure to declare the header** in the `input_headers` list of the endpoint.\n\nSee: ",
"examples": [
"X-Test"
],
"type": "string"
},
"strategy": {
"title": "Strategy",
"description": "Choose `header` when you want to check the value of a specific header, `policy` when you want to write a more complex logical expression, or `fallback` when the backend will execute when all the rest of conditional backends have failed to evaluate to true. Only one fallback can be defined per endpoint.\n\nSee: ",
"enum": [
"header",
"policy",
"fallback"
]
},
"value": {
"title": "Value",
"description": "The value according to the strategy. With the `header` strategy, this is the literal value contained in the header (case sensitive). With the `policy` strategy, the [Security Policy expression](https://www.krakend.io/docs/enterprise/security-policies/policy-language/). When using policies you can access to the variables `req` and `req_params` (a previous backend response might be in the latter), and to [advanced macros](https://www.krakend.io/docs/enterprise/security-policies/advanced-policy-macros/). Access to headers require you to add the corresponding `input_headers` in the endpoint.\n\nSee: ",
"examples": [
"TestA",
"hasHeader('X-Test') && req_params.Resp0_message == '0 items left'"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/graphql.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "GraphQL",
"description": "Convert REST endpoints to GraphQL calls (adapter/transformer)",
"type": "object",
"oneOf": [
{
"required": [
"type",
"query"
]
},
{
"required": [
"type",
"query_path"
]
}
],
"properties": {
"type": {
"title": "Query type",
"description": "The type of query you are declaring, `query` (read), or `mutation` (write).\n\nSee: ",
"enum": [
"query",
"mutation"
]
},
"operationName": {
"title": "Operation name",
"description": "A meaningful and explicit name for your operation, required in multi-operation documents and for helpful debugging and server-side logging.\n\nSee: ",
"examples": [
"addMktPreferencesForUser"
],
"type": "string"
},
"query": {
"title": "Query",
"description": "An inline GraphQL query you want to send to the server. Use this attribute for simple and inline queries, use `query_path` instead for larger queries. Use escaping when needed.\n\nSee: ",
"examples": [
"{ \n find_follower(func: uid(\"0x3\")) {\n name \n }\n }"
],
"type": "string"
},
"query_path": {
"title": "Query path",
"description": "Path to the file containing the query. This file is loaded during startup and never checked again, if it changes KrakenD will be unaware of it.\n\nSee: ",
"examples": [
"./graphql/mutations/marketing.graphql"
],
"type": "string"
},
"variables": {
"title": "Variables",
"description": "A dictionary defining all the variables sent to the GraphQL server. You can use `{placeholders}` to inject parameters from the endpoint URL.\n\nSee: ",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/client_tls.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "TLS client settings",
"description": "TLS options to connect to upstream services.\n\nSee: ",
"properties": {
"allow_insecure_connections": {
"title": "Allow insecure connections",
"description": "By default, KrakenD verifies every SSL connection. This option allows you to connect to backends considered **insecure**, for instance when you are using self-signed certificates",
"default": false,
"type": "boolean"
},
"ca_certs": {
"title": "CA certificates",
"description": "An array with all the CA certificates you would like to validate the server you are connecting to.\n\nSee: ",
"examples": [
[
"ca.pem"
]
],
"default": [],
"type": "array"
},
"cipher_suites": {
"title": "Cipher Suites",
"description": "The list of cipher suites as defined in the documentation.\n\nSee: ",
"default": [
4865,
4866,
4867
],
"type": "array",
"uniqueItems": true
},
"client_certs": {
"title": "Client certificates",
"description": "The list of all client certificates available when fetching data from the upstream service.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"required": [
"certificate",
"private_key"
],
"properties": {
"certificate": {
"title": "Certificate",
"description": "The path to the certificate you will use for mTLS connections.",
"type": "string"
},
"private_key": {
"title": "Private key",
"description": "The path to the private key you will use for mTLS connections.",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"curve_preferences": {
"title": "Curve identifiers",
"description": "The list of all the identifiers for the curve preferences. Use `23` for CurveP256, `24` for CurveP384 or `25` for CurveP521.\n\nSee: ",
"default": [
23,
24,
25
],
"type": "array",
"uniqueItems": true,
"items": {
"enum": [
23,
24,
25
]
}
},
"disable_system_ca_pool": {
"title": "Disable system's CA",
"description": "Ignore any certificate in the system's CA. The only certificates loaded will be the ones in the `ca_certs` list when true.\n\nSee: ",
"default": false,
"type": "boolean"
},
"max_version": {
"title": "Maximum TLS version",
"description": "Maximum TLS version supported.\n\nSee: ",
"default": "TLS13",
"enum": [
"SSL3.0",
"TLS10",
"TLS11",
"TLS12",
"TLS13"
]
},
"min_version": {
"title": "Minimum TLS version",
"description": "Minimum TLS version supported. When specifiying very old and insecure versions under TLS12 you must provide the `ciphers_list`.\n\nSee: ",
"default": "TLS13",
"enum": [
"SSL3.0",
"TLS10",
"TLS11",
"TLS12",
"TLS13"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
},
"https://www.krakend.io/schema/v2.13/timeunits.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Time units / Duration patterns",
"$defs": {
"timeunit": {
"title": "Duration",
"description": "The amount of time you want to assign followed by its unit (e.g.: `2s`, `200ms`). Valid time units are: ns, us, (or µs), ms, s, m, h.",
"type": "string",
"pattern": "^[0-9]+(ns|ms|us|µs|s|m|h)$"
}
}
},
"https://www.krakend.io/schema/v2.13/backend/grpc.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "gRPC backend connection",
"description": "Enterprise only. Handles the communication with a backend using gRPC, after having defined the protocol buffer definitions.\n\nSee: ",
"type": "object",
"properties": {
"client_tls": {
"title": "Enable TLS client options",
"description": "Enables specific TLS connection options when using the gRPC service. Supports all options under [TLS client settings](https://www.krakend.io/docs/service-settings/tls/#client-tls-settings).\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1client_tls.json"
},
"disable_query_params": {
"title": "Disable query parameters",
"description": "When `true`, it does not use URL parameters (`{placeholders}` in endpoints) or query strings to fill the gRPC payload to send. If `use_request_body` is not set, or set to `false`, and this option is set to `true`, there will be no input used for the gRPC message to send. That is still a valid option, when we just want to send the message with its default values, or when the input for the gRPC calls is just the [empty message](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/empty.proto).\n\nSee: ",
"default": false,
"type": "boolean"
},
"header_mapping": {
"title": "Mapping of headers",
"description": "A dictionary that rename the received header (key) to a new header name (value). If the header starts with `grpc` they will be renamed to `in-grpc-*` as the word is reserved.\n\nSee: ",
"examples": [
{
"X-Tenant": "customerid"
}
],
"type": "object",
"additionalProperties": false,
"patternProperties": {
".*": {
"type": "string"
}
}
},
"idle_conn_disconnect_time": {
"title": "Request naming convention",
"description": "The maximum time a connection is kept without being used.\n\nSee: ",
"default": "10m",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"input_assume_bytes": {
"title": "Assume input are bytes",
"description": "When set to true, when the backend has to fill a bytes field for a grpc protobuf payload to send, first tries to decode the input data (the one coming from either a json body field, a query param or header string) from base64: if it succeeds it fills the field to send with that binary / bytes data. If the incoming field is not a valid base64 decoded field (the one used in jsonpb), it will fill the binary field with the verbatim conversion of the incoming string to bytes.",
"default": false
},
"input_mapping": {
"title": "Mapping of parameters",
"description": "A dictionary that converts query string parameters and parameters from `{placeholders}` into a different field during the backend request. When passing parameters using `{placeholder}` the parameter capitalizes the first letter, so you receive `Placeholder`.\n\nSee: ",
"examples": [
{
"lat": "where.latitude",
"lon": "where.longitude"
}
],
"type": "object",
"additionalProperties": false,
"patternProperties": {
".*": {
"type": "string"
}
}
},
"max_call_recv_msg_size": {
"title": "Maximum size for messages",
"description": "Specifies the maximum size (in bytes) for messages the grpc client is allowed to receive. If the value is unset, or `0`, it uses its default (4MB)",
"examples": [
33554432,
4194304,
0
],
"type": "number"
},
"output_duration_as_string": {
"title": "Output duration types as string",
"description": "Well-known Duration types (`google.protobuf.Duration`) are returned as a struct containing fields with `seconds` and `nanos` fields (flag set to `false`). Setting this flag to `true` transforms the timestamps into a string representation in seconds.\n\nSee: ",
"default": false,
"type": "boolean"
},
"output_enum_as_string": {
"title": "Output enum types as string",
"description": "Enum types are returned as numeric values (flag set to `false`). Set this flag to `true` to return the string representation of the enum value. For instance, an enum representing allergies, such as `['NUTS', 'MILK', ' SOY', 'WHEAT']` would return a value `SOY` when this flag is `true`, or `2` when `false`.\n\nSee: ",
"default": false,
"type": "boolean"
},
"output_remove_unset_values": {
"title": "Output removes unset values",
"description": "This attribute defines what to do when a field that is declared in the definition does not exist in the backend response. When the flag is `true`, any fields in the definition that are not present in the backend response are removed before returning the content to the user. When the flag is `false` missing fields are returned but set with a zeroed-value depending on its type (zero, nil, false, etc).\n\nSee: ",
"default": false,
"type": "boolean"
},
"output_timestamp_as_string": {
"title": "Output timestamps types as string",
"description": "Well-known Timestamp types (`google.protobuf.Timestamp`) are returned as a struct containing fields with `seconds` and `nanos` fields (flag set to `false`). Setting this flag to `true` transforms the timestamps into a string representation in RFC3999 format.\n\nSee: ",
"default": false,
"type": "boolean"
},
"read_buffer_size": {
"title": "Read buffer size",
"description": "Specifies the size of the client buffer reading the gRPC communication in bytes. If the value is unset, or `0`, it uses its default (32KB). Use a negative value to disable the buffer, and if you do there won't be memory pre-allocation to read. To determine the right number, calculate the average size of the responses the gRPC client will receive.\n\nSee: ",
"examples": [
32768,
8192,
-1
],
"type": "number"
},
"request_naming_convention": {
"title": "Request naming convention",
"description": "Defines the naming convention used to format the request. Applies to query strings and JSON field names. By default, the gateway uses `snake_case` which makes use of the standard `encoding/json` package, while when you choose `camelCase` the `protobuf/encoding` deserialization is used instead.\n\nSee: ",
"default": "snake_case",
"enum": [
"camelCase",
"snake_case"
]
},
"response_naming_convention": {
"title": "Response naming convention",
"description": "Defines the naming convention used to format the returned data. By default, the gateway uses `snake_case` which makes use of the standard `encoding/json` package, while when you choose `camelCase` the `protobuf/encoding` deserialization is used instead.\n\nSee: ",
"default": "snake_case",
"enum": [
"camelCase",
"snake_case"
]
},
"use_alternate_host_on_error": {
"title": "Use alternate host on error",
"description": "When `true`, before sending a message to a host, it checks if the connection status is in a \"transient failure\" or \"failure\" state and tries to use a different host (from the service discovery or randomly from the list of hosts). If the connection is in a valid state, but an error happens when sending the gRPC message, it also tries to use a different host to retry sending the message. Depending on the host list, the retry attempts may go to the same host initially in a \"bad state\".\n\nSee: ",
"type": "boolean"
},
"use_request_body": {
"title": "Use body",
"description": "Enables the use of the sent body to fill the gRPC request. Take into account that when you set this flag to `true` a body is expected, and this body is **consumed** in the first backend. If the endpoint that uses this gRPC backend has additional backends (either gRPC or HTTP) that also expect to consume the payload, these requests might fail.\n\nSee: ",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/http_client.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "HTTP Client options",
"description": "Enterprise only. Allows you to set the different HTTP client options with the backend, like TLS, no redirect or connect via a proxy.\n\nSee: ",
"type": "object",
"properties": {
"client_tls": {
"title": "TLS Client settings",
"description": "Allows to set specific transport settings when using TLS in your upstream services. See the global [Client TLS options](https://www.krakend.io/docs/service-settings/tls/#client-tls-settings) for the list of all supported options.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1client_tls.json"
},
"no_redirect": {
"title": "No redirect",
"description": "Set `no_redirect` to true if you don't want KrakenD to follow redirects and let the consuming user to receive the `30x` status code.\n\nSee: ",
"default": false,
"type": "boolean"
},
"proxy_address": {
"title": "Proxy address",
"description": "The proxy address used to forward the traffic. The address must contain the protocol and the port.\n\nSee: ",
"examples": [
"http://proxy.corp:9099"
]
},
"send_body_on_redirect": {
"title": "Enable redirect POST",
"description": "Post the original body to the final URL after a 307 or a 308 redirection.\n\nSee: ",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/lambda.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "AWS Lambda functions",
"description": "Invoke Amazon Lambda functions on a KrakenD endpoint call.\n\nSee: ",
"type": "object",
"properties": {
"endpoint": {
"title": "Endpoint",
"description": "An optional parameter to customize the Lambda endpoint to call. Useful when Localstack is used for testing instead of direct AWS usage.\n\nSee: ",
"type": "string"
},
"function_name": {
"title": "Function name",
"description": "Name of the lambda function as saved in the AWS service. You have to choose between function_name and function_param_name but not both.\n\nSee: ",
"type": "string"
},
"function_param_name": {
"title": "Function_param_name",
"description": "The endpoint {placeholder} that sets the function name, with the **first letter uppercased**. You have to choose between `function_name` and `function_param_name` but not both. If your endpoint defines the route `/foo/{bar}` the value of `function_param_name` must be `Bar` with the uppercased B.\n\nSee: ",
"type": "string"
},
"max_retries": {
"title": "Max retries",
"description": "Maximum times you want to execute the function until you have a successful response. The value -1 defers the max retry setting to the service specific configuration.\n\nSee: ",
"default": 0,
"type": "integer"
},
"region": {
"title": "AWS Region",
"description": "The AWS identifier region\n\nSee: ",
"examples": [
"us-east-1",
"eu-west-2"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/pubsub/publisher.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Pubsub publisher",
"description": "Publishes to a topic using the desired driver.\n\nSee: ",
"type": "object",
"required": [
"topic_url"
],
"properties": {
"topic_url": {
"title": "Topic URL",
"description": "Topic URL according to the selected driver\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/messaging/kafka/sasl.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Kafka SASL",
"description": "Enterprise only. SASL base authentication with broker: there are multiple SASL authentication methods but the current implementation is limited to plaintext (SASL/PLAIN) authentication",
"type": "object",
"properties": {
"mechanism": {
"title": "SASL Mechanism",
"description": "Name of the enabled SASL mechanism",
"default": "PLAIN",
"enum": [
"PLAIN",
"OAUTHBEARER"
]
},
"azure_event_hub": {
"title": "Connect to Azure Event Hub",
"description": "Kafka > 1.x should use SASL V1, except on Azure EventHub which uses V0",
"default": false,
"type": "boolean"
},
"disable_hanshake": {
"title": "Disable Handshake",
"description": "Whether or not to send the Kafka SASL handshake first if enabled. You should only set this to false if you're using a non-Kafka SASL proxy",
"default": true,
"type": "boolean"
},
"auth_identity": {
"title": "Auth Identity",
"description": "Auth Identity is an (optional) authorization identity (authzid) to use for SASL/PLAIN authentication (if different from User) when an authenticated user is permitted to act as the presented alternative user. See RFC4616 for details",
"type": "string"
},
"user": {
"title": "User",
"description": "Authentication identity (authcid) to present for SASL/PLAIN or SASL/SCRAM authentication",
"type": "string"
},
"password": {
"title": "Password",
"description": "Password for SASL/PLAIN authentication",
"type": "string"
},
"scram_auth_id": {
"title": "SCRAM Auth ID",
"description": "Authz id used for SASL/SCRAM authentication",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/messaging/kafka/cluster.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Kafka Cluster Connection",
"description": "Enterprise only. Defines how to connect to a Kafka cluster",
"type": "object",
"required": [
"brokers"
],
"properties": {
"brokers": {
"title": "Brokers available to connect to",
"description": "",
"type": "array",
"items": {
"type": "string"
}
},
"client_tls": {
"title": "TLS client options",
"description": "Enables specific TLS connection options when connecting to the Kafke brokers. Supports all options under [TLS client settings](https://www.krakend.io/docs/service-settings/tls/#client-tls-settings).\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1client_tls.json",
"type": "object"
},
"sasl": {
"title": "SASL Connection options",
"description": "Enables to authenticate to the Kafka service using user and password",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1sasl.json",
"type": "object"
},
"dial_timeout": {
"title": "Dial Timeout",
"description": "Dial timeout for establishing new connections",
"default": "30s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"read_timeout": {
"title": "Read Timeout",
"description": "Maximum time allowed to read from broker",
"default": "30s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"write_timeout": {
"title": "Write Timeout",
"description": "Maximum time allowed to write to broker",
"default": "30s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"keep_alive": {
"title": "Keep Alive",
"description": "Time to maintain an idle connection open",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"client_id": {
"title": "Client ID",
"description": "A name to give to the client stablishing the connection",
"default": "KrakenD v[X].[Y].[Z]",
"type": "string"
},
"rack_id": {
"title": "Rack ID",
"description": "A name to identify the rack we are connecting from",
"default": "",
"type": "string"
},
"channel_buffer_size": {
"title": "Channel Buffer Size",
"description": "The number of events to buffer in internal and external channels. This permits the producer and consumer to continue processing some messages in the background while user code is working, greatly improving throughput",
"default": 256,
"type": "number",
"minimum": 0
},
"metadata_retry_backoff": {
"title": "Metadata Retry Backoff",
"description": "The time between attempts to reconnect when disconnected",
"default": "250ms",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"metadata_retry_max": {
"title": "Metadata Maximum Retries",
"description": "When a disconnection happens, the client needs to refresh its metadata to know the current state of the kafka cluster (effectively the number of attempts to reconnect)",
"default": 3,
"type": "number",
"minimum": 0
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/messaging/kafka/producer.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Kafka Producer Details",
"description": "Enterprise only. Defines details about how to write messages to a Kafka cluster",
"type": "object",
"properties": {
"max_message_bytes": {
"title": "Max Message Bytes",
"description": "Maximum permitted size of a message. Should be set equal to or smaller than the broker's `message.max.bytes`.",
"type": "number",
"minimum": 0
},
"required_acks": {
"title": "Required Acks",
"description": "Level of acknowledgement reliability needed from the broker. Equivalent to the `request.required.acks` setting of the JVM producer. Can be a positibe number (as a string), or one of hte following values: `no_response` (no required acks), `wait_for_local` (waits for only the local commit to succeed before responding), `wait_for_all` (waits for all in-sync replicas to commit before responding).",
"default": "wait_for_local",
"type": "string"
},
"required_acks_timeout": {
"title": "Required Acks Timeout",
"description": "Maximum duration the broker will wait the receipt of the number of `required_acks`. This is only relevant when `required_acks` is set to WaitForAll or a number > 1. Only supports millisecond resolution, nanoseconds will be truncated. Equivalent to the JVM producer's `request.timeout.ms` setting.",
"default": "10s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"compression_codec": {
"title": "Compression Codec",
"description": "Type of compression to use on messages (defaults to no compression). Similar to `compression.codec` setting of the JVM producer.",
"default": "none",
"enum": [
"none",
"gzip",
"snappy",
"lz4",
"zstd"
]
},
"compression_level": {
"title": "Compression Level",
"description": "Level of compression to use on messages. The meaning depends on the actual compression type used and defaults to default compression level for the codec.",
"type": "string"
},
"partitioner": {
"title": "Partitioner",
"description": "Select behaviour for choosing the partition to send messages (similar to the `partitioner.class` setting for the JVM producer). The options are:\n- `sarama`: **DEPRECATED** uses a Partitioner which behaves as follows: If the message's key is nil then a random partition is chosen. Otherwise the `FNV-1a` hash of the encoded bytes of the message key is used, modulus the number of partitions. This ensures that messages with the same key always end up on the same partition.\n- `standard` is like `sarama` except that it handles absolute values in the same way as the reference Java implementation. `sarama` was supposed to do that but it had a mistake and now there are people depending on both behaviours. This will all go away on the next major version bump.\n- `random` uses a Partitioner which chooses a random partition each time.\n- `roundrobin` uses a Partitioner which walks through the available partitions one at a time.",
"default": "standard",
"enum": [
"sarama",
"standard",
"random",
"roundrobin"
]
},
"idempotent": {
"title": "Idempotent",
"description": "If enabled, the producer will ensure that exactly one copy of each message is written",
"default": false,
"type": "boolean"
},
"retry_max": {
"title": "Retry Max",
"description": "The total number of times to retry sending a message. Similar to the `message.send.max.retries` setting of the JVM producer.",
"default": 3,
"type": "number",
"minimum": 0
},
"retry_backoff": {
"title": "Retry Backoff",
"description": "How long to wait for the cluster to settle between retries (similar to the `retry.backoff.ms` setting of the JVM producer.",
"default": "100ms",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/messaging/kafka/writer.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Kafka Writer",
"description": "Enterprise only. Defines how to write messages to a Kafka cluster",
"type": "object",
"required": [
"cluster",
"topic"
],
"properties": {
"cluster": {
"title": "Cluster connection details",
"description": "Settings to establish the connection to the kafka cluster",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1cluster.json",
"type": "object"
},
"producer": {
"title": "Producer options",
"description": "Details about how to write to a topic",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1producer.json",
"type": "object"
},
"topic": {
"title": "Topic",
"description": "Topic to write to",
"type": "string"
},
"key_meta": {
"title": "Key Meta Name",
"description": "Name of the header where the kafka message key value is written",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/pubsub/kafka/publisher.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "PubSub Kafka Publisher EE",
"description": "Enterprise only. Allows for fine grained control over a kafka publishing connection",
"type": "object",
"required": [
"writer"
],
"properties": {
"success_status_code": {
"title": "Success Status Code",
"description": "HTTP status code to return for a successful write in the queue",
"default": 200,
"type": "number",
"maximum": 201,
"minimum": 200
},
"writer": {
"title": "Writer",
"description": "Define how to write messages to a kafka topic",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1writer.json",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/pubsub/subscriber.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Pubsub subscriber",
"description": "Subscribes a backend using the desired driver.\n\nSee: ",
"type": "object",
"required": [
"subscription_url"
],
"properties": {
"subscription_url": {
"title": "Subscription URL",
"description": "Subscription URL according to the selected driver\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/messaging/kafka/group.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Kafka Consumer Details",
"description": "Enterprise only. Defines the detaisl for a Kafka consumer group.",
"type": "object",
"properties": {
"id": {
"title": "Consumer Group ID",
"description": "Name of the consumer group to use",
"type": "string"
},
"session_timeout": {
"description": "Timeout used to detect consumer failures when using Kafka's group management facility. The consumer sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this consumer from the group and initiate a rebalance. Note that the value must be in the allowable range as configured in the broker configuration by `group.min.session.timeout.ms` and `group.max.session.timeout.ms`",
"default": "10s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"heartbeat_interval": {
"title": "Grup Heartbeat Interval",
"description": "Expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than Consumer.Group.Session.Timeout, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances",
"default": "3s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"rebalance_strategies": {
"title": "Group Rebalance Strategies",
"description": "Priority-ordered list of client-side consumer group balancing strategies that will be offered to the coordinator. The first strategy that all group members support will be chosen by the leader. Options are: `range`, `roundrobin`, and `sticky`",
"default": [
"range"
],
"type": "array",
"items": {
"enum": [
"range",
"roundrobin",
"sticky"
]
}
},
"rebalance_timeout": {
"title": "Group Rebalance Timeout",
"description": "Maximum allowed time for each worker to join the group once a rebalance has begun. This is basically a limit on the amount of time needed for all tasks to flush any pending data and commit offsets. If the timeout is exceeded, then the worker will be removed from the group, which will cause offset commit failures.",
"default": "60s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"instance_id": {
"title": "Group Instance ID",
"description": "Support KIP-345",
"type": "string"
},
"fetch_default": {
"title": "Fetch Default",
"description": "The default number of message bytes to fetch from the broker in each request (default 1MB). This should be larger than the majority of your messages, or else the consumer will spend a lot of time negotiating sizes and not actually consuming. Similar to the JVM's `fetch.message.max.bytes`",
"type": "number"
},
"isolation_level": {
"title": "Isolation Level",
"description": "Supports 2 modes: `read_commited` to consume and return all messages in message channel, and `read_uncommited` to hide messages that are part of an aborted transaction",
"default": "read_commited",
"enum": [
"read_commited",
"read_uncommited"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/messaging/kafka/reader.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Kafka Reader",
"description": "Enterprise only. Defines how to read messages from a Kafka cluster",
"type": "object",
"required": [
"cluster",
"topics"
],
"properties": {
"cluster": {
"title": "Cluster connection details",
"description": "Settings to stablish the connection to the kafka cluster",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1cluster.json",
"type": "object"
},
"group": {
"title": "Consumer group options",
"description": "Details about the consumer croup",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1group.json",
"type": "object"
},
"topics": {
"title": "Topics",
"description": "List of topics to read from",
"type": "array",
"items": {
"type": "string"
}
},
"key_meta": {
"title": "Key Meta Name",
"description": "Name of the header where the kafka message key value is written",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/pubsub/kafka/subscriber.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "PubSub Kafka Subscriber EE",
"description": "Enterprise only. Allows for fine grained control over a kafka subcription connection",
"type": "object",
"required": [
"reader"
],
"properties": {
"reader": {
"title": "Reader",
"description": "Define how to read messages from a kafka topic",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1reader.json",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/soap.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "SOAP Template modifier",
"description": "Enterprise only. Build and modify requests to communicate with SOAP services.\n\nSee: ",
"type": "object",
"oneOf": [
{
"required": [
"path"
]
},
{
"required": [
"template"
]
}
],
"properties": {
"content_type": {
"title": "Content-Type",
"description": "The `Content-Type` used in your template, and that will be sent to the SOAP server. This is not the content-type the end-user sent in the request.\n\nSee: ",
"examples": [
"application/xml",
"text/xml"
],
"default": "text/xml",
"type": "string"
},
"debug": {
"title": "Enable debug",
"description": "When `true`, shows useful information in the logs with `DEBUG` level about the input received and the body generated. Do not enable in production. Debug logs are multiline and designed fore developer readibility, not machine processing.\n\nSee: ",
"default": false,
"type": "boolean"
},
"path": {
"title": "Path to template",
"description": "The path to the Go template file you want to use to craft the body.\n\nSee: ",
"examples": [
"./path/to.xml"
],
"type": "string"
},
"template": {
"title": "Template",
"description": "An inline base64 encoded Go template with the body XML content you want to send to the SOAP service. This option is useful if you don't want to rely on external files and embed the template in the configuration.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend/static-filesystem.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Static Filesystem",
"description": "Enterprise only. Allows you to fetch and serve static content from the disk instead of a remote server, and you can use it to mock data.\n\nSee: ",
"type": "object",
"required": [
"path"
],
"properties": {
"directory_listing": {
"description": "Whether to allow directory listings or not",
"default": false,
"type": "boolean"
},
"path": {
"title": "Path",
"description": "The folder in the filesystem containing the static files. Relative to the working dir where KrakenD config is (e.g.: `./assets`) or absolute (e.g.: `/var/www/assets`).\n\nSee: ",
"examples": [
"./static/"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/governance/quota.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Attachment of a quota",
"description": "Enterprise only. Attach a quota to the endpoint, backend, or service. Needs a governance/processor namespace.\n\nSee: ",
"type": "object",
"required": [
"quota_name",
"tier_key",
"tiers"
],
"properties": {
"disable_quota_headers": {
"description": "When set to `true`, the quota headers `X-Quota-Limit`, `X-Quota-Remaining`, and `Retry-After` will not be added to the response. This is useful when you want to hide the quota information from the client.\n\nSee: ",
"default": false,
"type": "boolean"
},
"on_unmatched_tier_allow": {
"description": "When a tier cannot be infered from the request, whether to allow the request to continue or not. In case a request does not match any of the tiers, the request will be rejected with a 400 error unless you set this to `true`.\n\nSee: ",
"default": false,
"type": "boolean"
},
"quota_name": {
"description": "Name of the quota you want to reuse, written exactly as declared under the `processors` list.\n\nSee: ",
"examples": [
"my_quota"
],
"type": "string"
},
"tier_key": {
"description": "Header used to determine the tier. Use `tier_value` and `tier_value_as` on each tier to determine how to match the value.\n\nSee: ",
"examples": [
"X-User-Tier",
"X-User-ID"
],
"type": "string"
},
"tiers": {
"description": "List of tiers to match against the request. The first tier that matches will be used to determine the quota to consume.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"required": [
"rule_name"
],
"properties": {
"key": {
"description": "The key (e.g., header name, IP, claim name) that contains the identity of the caller, like the user ID of who is doing the request. The key must be present in the request.\n\nSee: ",
"type": "string"
},
"rule_name": {
"description": "Tier limit defined in the global `processor`. It must be within the defined `limits` of the quota_name processor. If it's not found, the system will complain at startup and affected endpoints will be degraded with a 500 error\n\nSee: ",
"type": "string"
},
"strategy": {
"description": "Where to find the key containing the identity of the caller. Use `header` for headers, `ip` for the IP address of the caller, and `param` for an endpoint {parameter}.\n\nSee: ",
"default": "header",
"enum": [
"header",
"ip",
"param"
]
},
"tier_value": {
"description": "Literal value or CEL expression to match.\n\nSee: ",
"type": "string"
},
"tier_value_as": {
"description": "How to treat the value. In most cases the tier value contains the plan name, like `gold`, so you will choose `literal`. But you can also set in the value a security policy (CEL) that will evaluate to resolve the tier policy accordingly, or put an asterisk `*` to always match and use as your last and default tier.\n\nSee: ",
"default": "literal",
"enum": [
"literal",
"policy",
"*"
]
}
}
}
},
"weight_key": {
"description": "Instead of incrementing the quota counter by one unit, use the value provided in a field or header with its dynamic value. For instance, an LLM can return how many tokens it consumed, and you can use that value to increment the quota counter. The value must be a parseable number, and the field or header must be present in the backend response. The `weight_key` is only used in the `endpoint` and `backend` scopes, and it is ignored in the service level.\n\nSee: ",
"type": "string"
},
"weight_strategy": {
"description": "Where to find the key containing the counter value to increment. Use `body` for any type of encoding different than `no-op` and `header` for `no-op`.\n\nSee: ",
"default": "body",
"enum": [
"body",
"header"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/modifier/body-generator.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Template-based body generator",
"description": "Enterprise only. Crafts the body/payload using a templating system.\n\nSee: ",
"$comment": "This schema is used by modifier/request-body-generator and modifier/body-generator simultaneously",
"type": "object",
"oneOf": [
{
"required": [
"path"
]
},
{
"required": [
"template"
]
}
],
"properties": {
"content_type": {
"title": "Content-Type",
"description": "The `Content-Type` you are generating in the template, so it can be recognized by whoever is using it.\n\nSee: ",
"examples": [
"application/json",
"application/xml",
"text/xml"
],
"default": "application/json",
"type": "string"
},
"debug": {
"title": "Enable debug",
"description": "When `true`, shows useful information in the logs with `DEBUG` level about the input received and the body generated. Do not enable in production. Debug logs are multiline and designed fore developer readibility, not machine processing.\n\nSee: ",
"default": false,
"type": "boolean"
},
"path": {
"title": "Path to template",
"description": "The path to the Go template file you want to use to craft the body.\n\nSee: ",
"examples": [
"./path/to.tmpl"
],
"type": "string"
},
"template": {
"title": "Template",
"description": "An inline base64 encoded Go template with the body you want to generate. This option is useful if you want to have the template embedded in the configuration instead of an external file.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/modifier/jmespath.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "JMESPath: Response manipulation with query language",
"description": "Enterprise only. The JMESPath query language allows you to select, slice, filter, map, project, flatten, sort, and all sorts of operations on data.\n\nSee: ",
"type": "object",
"required": [
"expr"
],
"properties": {
"expr": {
"title": "Expression",
"description": "The JMESPath expression you want to apply to this endpoint.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/modifier/lua.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Lua modifier",
"description": "Scripting with Lua is an additional choice to extend your business logic, and is compatible with the rest of options such as CEL, Martian, or other Go plugins and middlewares.\n\nSee: ",
"type": "object",
"properties": {
"allow_open_libs": {
"title": "Open external libs",
"description": "As an efficiency point the Lua component does not load the standard libraries by default. If you need to import Lua libraries (e.g, the I/O, String, etc.), then you must set this flag to true.\n\nSee: ",
"default": false,
"type": "boolean"
},
"live": {
"title": "Live reload",
"description": "For security and efficiency, the Lua script is loaded once into memory and not reloaded even if the file contents change. Set this flag to `true` if you want to modify the Lua script while KrakenD is running and apply the changes live (mostly during development to avoid the snippet being cached).\n\nSee: ",
"default": false,
"type": "boolean"
},
"md5": {
"title": "MD5 Checksum",
"description": "The md5sum is an extra security feature to make sure that once you have coded the Lua script, the MD5 of what is loaded into memory matches what you expect and has not been tampered by a malicious 3rd party. The key of the object must match **exactly** the filename under sources, **including all the path**.\n\nSee: ",
"examples": [
{
"./path/to/file1.lua": "49ae50f58e35f4821ad4550e1a4d1de0"
}
],
"type": "object"
},
"post": {
"title": "post-execution code",
"description": "The Lua code that is executed **after** performing the request. Available when used in the `backend` section. You can write all the Lua code inline (e.g., `print('Hi'); print('there!')` but you can also call functions that live inside one of the files under `sources` (e.g., `my_function()`).\n\nSee: ",
"examples": [
"local r = response.load(); r:headers('Set-Cookie', 'key1='.. r:data('response'));"
],
"type": "string"
},
"pre": {
"title": "Pre-execution code",
"description": "The Lua code that is executed **before** performing the request. Unlike `post`, it's available in all sections. You can write all the Lua code inline (e.g., `print('Hi'); print('there!')` but you can also call functions that live inside one of the files under `sources` (e.g., `my_function()`).\n\nSee: ",
"examples": [
"print('Backend response, pre-logic:'); local r = request.load(); print(r:body());"
],
"type": "string"
},
"skip_next": {
"title": "Skip next",
"description": "Available on the `backend` section only. Instead of connecting to next backend in the pipe, returns an empty response and executes the `post` lua function.\n\nSee: ",
"default": false,
"type": "boolean"
},
"sources": {
"title": "Sources",
"description": "An array with all the Lua files that will be processed. If no path is provided (e.g., `myfile.lua`) the file loads from the [working directory](https://www.krakend.io/docs/configuration/working-directory/).\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/modifier/martian.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Martian modifiers",
"description": "The Martian component allows you to modify requests and responses with static data through a simple DSL definition in the configuration file.\n\nSee: ",
"type": "object",
"maxProperties": 1,
"properties": {
"body.Modifier": {
"title": "Body Modifier",
"description": "The body.Modifier changes or sets the body of a request or response. The body must be uncompressed and Base64 encoded.\n\nSee: ",
"type": "object",
"required": [
"scope",
"body"
],
"properties": {
"body": {
"title": "Body in base64",
"description": "The body you want to set, formatted in base64.",
"type": "string"
},
"contentType": {
"title": "Content Type",
"description": "The content-type representing the body you are setting",
"examples": [
"application/x-www-form-urlencoded",
"text/plain"
],
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
}
}
},
"cookie.Filter": {
"title": "Cookie Filter",
"description": "The cookie.Filter executes the contained modifier when a cookie is provided under the name.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifier",
"name"
],
"properties": {
"else": {
"description": "The modifier you want to execute when the condition does not match",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"modifier": {
"description": "The modifier you want to execute when the cookie name (and value if provided) matches",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"name": {
"description": "The name of the Cookie you want to check. Notice that the `input_headers` must contain `Cookie` in the list when you want to check cookies sent by the client.",
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"const": [
"request"
]
},
"value": {
"description": "If besides the cookie name, you set this value, it ensures the cookie has a literal match."
}
}
},
"cookie.Modifier": {
"title": "Cookie Modifier",
"description": "Adds a cookie to a request or a response. If you set cookies in a response, the cookies are only set to the client when you use no-op encoding.\n\nSee: ",
"type": "object",
"required": [
"scope",
"name",
"value"
],
"properties": {
"domain": {
"description": "Domain of the Cookie you want to set",
"examples": [
"example.com"
],
"type": "string"
},
"expires": {
"description": "Date in RFC 3339 format and is absolute, not relative to the current time.",
"examples": [
"2025-04-12T23:20:50.52Z"
],
"type": "string"
},
"httpOnly": {
"description": "Create the Cookie with the httpOnly flag. When `true`, mitigates the risk of client side script accessing the protected cookie (if the browser supports it), mitigating the Most Common XSS",
"default": false,
"type": "boolean"
},
"maxAge": {
"description": "For how long this Cookie is valid, in seconds. `0` means that the attribute is not set. `maxAge<0` means delete cookie now",
"default": 0,
"type": "integer"
},
"name": {
"description": "Name of the Cookie you want to set",
"type": "string"
},
"path": {
"description": "Path of the Cookie you want to set",
"examples": [
"/path/to"
],
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
},
"secure": {
"description": "Cookie secure flag. When `true`, the user agent will include the cookie in the request when using https only",
"default": false,
"type": "boolean"
},
"value": {
"description": "Value of the Cookie you want to set",
"type": "string"
}
}
},
"fifo.Group": {
"title": "FIFO group",
"description": "The fifo.Group holds a list of modifiers executed in first-in, first-out order.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifiers"
],
"properties": {
"aggregateErrors": {
"description": "When true, the group will continue to execute consecutive modifiers when a modifier in the group encounters an error. The Group will then return all errors returned by each modifier after all modifiers have been executed. When false, if an error is returned by a modifier, the error is returned by ModifyRequest/Response and no further modifiers are run.",
"default": false,
"type": "boolean"
},
"modifiers": {
"description": "The list of modifiers you want to execute in the declared order",
"type": "array",
"items": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json"
}
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
}
}
},
"header.Append": {
"title": "Append a header",
"description": "See: ",
"type": "object",
"required": [
"scope",
"name",
"value"
],
"properties": {
"name": {
"description": "Name of the header you want to append a value. Add the same name under the `input_headers` list to append more values to an existing header passed by the client. In addition, to see the header in the response, you must use `no-op`.",
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
},
"value": {
"description": "The value you want to add or append.",
"type": "string"
}
}
},
"header.Blacklist": {
"title": "Blacklist headers",
"description": "The header.Blacklist removes the listed headers under names in the request and response of the backend.\n\nSee: ",
"type": "object",
"required": [
"scope",
"names"
],
"properties": {
"names": {
"description": "List of all the headers you want to supress from the request or the response. If you want to see the headers in the client, you must use the `output_encoding: no-op`, and if you want the client headers to propagate to the backend, you need to use `input_headers` too.",
"type": "array",
"items": {
"type": "string"
}
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
}
}
},
"header.Copy": {
"title": "Header Copy",
"description": "The header.Copy lets you duplicate a header using another name\n\nSee: ",
"type": "object",
"required": [
"scope",
"from",
"to"
],
"properties": {
"from": {
"description": "The origin header you want to copy. When the header is provided by the user it must be included in the `input_headers` list.",
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
},
"to": {
"description": "The destination header you want to create. If this header is returned to the end-user you must use `no-op` in the `output_encoding` of the endpoint.",
"type": "string"
}
}
},
"header.Filter": {
"title": "Header Filter",
"description": "The header.Filter executes its contained modifier if the request or response contain a header that matches the defined name and value. The value is optional, and only the header’s existence evaluates when undefined.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifier",
"name"
],
"properties": {
"else": {
"description": "The modifier you want to execute when the condition does not match",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"modifier": {
"description": "The modifier you want to execute when the condition matches",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"name": {
"description": "Name of the header you want to check. You must add under `input_headers` the `name` included in the filter.",
"examples": [
"X-Some",
"Content-Type"
],
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
},
"value": {
"description": "Value of the header you want to check",
"type": "string"
}
}
},
"header.Id": {
"title": "Header Id",
"description": "See: ",
"type": "object",
"required": [
"scope"
],
"properties": {
"header": {
"title": "Header",
"description": "The header name you want to use to save the ID. In the case the header is already set, the header is unmodified.",
"default": "X-Krakend-Id",
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"const": [
"request"
]
}
}
},
"header.Modifier": {
"title": "Header Modifier",
"description": "The header.Modifier adds a new header or changes the value of an existing one.\n\nSee: ",
"type": "object",
"required": [
"scope",
"name",
"value"
],
"properties": {
"name": {
"description": "Name of the header you want to set",
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
},
"value": {
"description": "Value of the header you want to set",
"type": "string"
}
}
},
"header.RegexFilter": {
"title": "Header RegexFilter",
"description": "The header.RegexFilter checks that a regular expression (RE2 syntax) passes on the target header and, if it does, executes the modifier.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifier",
"header",
"regex"
],
"properties": {
"header": {
"description": "Name of the header you want to check. You must add under `input_headers` the `name` included in the filter.",
"examples": [
"X-Some",
"Content-Type"
],
"type": "string"
},
"modifier": {
"description": "The modifier you want to execute when the condition matches",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"regex": {
"description": "The regular expression you want to check against the header value",
"examples": [
".*localhost.*",
"^foo-[a-z]+$"
],
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
}
}
},
"port.Filter": {
"title": "Port Filter",
"description": "The port.Filter executes its modifier only when the port matches the one used in the request. It does not support else.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifier",
"port"
],
"properties": {
"else": {
"description": "The modifier you want to execute when the condition does not match",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"modifier": {
"description": "The modifier you want to execute when the condition matches",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"port": {
"description": "The port number you want to check",
"type": "integer"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"const": [
"request"
]
}
}
},
"port.Modifier": {
"title": "Port Modifier",
"description": "The port.Modifier alters the request URL and Host header to use the provided port.\n\nSee: ",
"type": "object",
"oneOf": [
{
"required": [
"scope",
"port"
]
},
{
"required": [
"scope",
"defaultForScheme"
]
},
{
"required": [
"scope",
"remove"
]
}
],
"properties": {
"defaultForScheme": {
"description": "Uses the default port of the schema. `80` for `` or `443` for ``. Other schemas are ignored.",
"type": "boolean"
},
"port": {
"description": "Defines which port will be used.",
"type": "integer"
},
"remove": {
"description": "Removes the port from the host string when `true`.",
"type": "boolean"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"const": [
"request"
]
}
}
},
"priority.Group": {
"title": "Priority group",
"description": "The priority.Group contains the modifiers you want to execute, but the order in which they are declared is unimportant. Instead, each modifier adds a priority attribute that defines the order in which they are run.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifiers"
],
"properties": {
"modifiers": {
"description": "The list of modifiers you want to execute, order specified in the items using `priority`.",
"type": "array",
"items": {
"required": [
"priority",
"modifier"
],
"properties": {
"modifier": {
"description": "The modifier definition you want to execute",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json"
},
"priority": {
"description": "The assigned priority number",
"type": "integer"
}
},
"type": "object"
}
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
}
}
},
"querystring.Filter": {
"title": "QueryString Filter",
"description": "The querystring.Filter executes the modifier if the request or response contains a query string parameter that matches the defined name and value in the filter.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifier",
"name"
],
"properties": {
"else": {
"description": "The modifier you want to execute when the condition does not match",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"modifier": {
"description": "The modifier you want to execute when the condition matches",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"name": {
"description": "Name of the query string you want to check",
"examples": [
"page",
"limit"
],
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
},
"value": {
"description": "Value of the query string you want to check",
"type": "string"
}
}
},
"querystring.Modifier": {
"title": "Querystring Modifier",
"description": "The querystring.Modifier adds a new query string or modifies existing ones in the request.\n\nSee: ",
"type": "object",
"required": [
"scope",
"name",
"value"
],
"properties": {
"name": {
"description": "Name of the query string you want to set",
"examples": [
"page",
"limit"
],
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"const": [
"request"
]
},
"value": {
"description": "The value of the query string you want to set",
"type": "string"
}
}
},
"stash.Modifier": {
"title": "Stash Modifier",
"description": "The stash.Modifier creates a new header (or replaces an existing one with a matching name) containing the value of the original URL and all its query string parameters.\n\nSee: ",
"type": "object",
"required": [
"scope",
"headerName"
],
"properties": {
"headerName": {
"description": "The header you want to create. If this header is returned to the end-user you must use `no-op` in the `output_encoding` of the endpoint.",
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
}
}
},
"url.Filter": {
"title": "URL Filter",
"description": "The url.Filter executes its contained modifier if the request URL matches all of the provided parameters.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifier"
],
"properties": {
"else": {
"description": "The modifier you want to execute when the condition does not match",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"host": {
"description": "The literal hostname that must match, including the port",
"examples": [
"localhost:8080"
],
"type": "string"
},
"modifier": {
"description": "The modifier you want to execute when the condition matches",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"path": {
"description": "The `/path` of the URL, without query strings.",
"examples": [
"/path/to"
],
"type": "string"
},
"query": {
"description": "The query strings you want to check. Use `key1=value1&key2=value2` to check that the request has exactly these keys and values (order is irrelevant, but content not). Suppose the request has more query strings than declared here because the `input_query_strings` allowed them to pass. In that case, the evaluation will be `false`, and the `else` modifier will be executed.",
"examples": [
"/path/to"
],
"type": "string"
},
"scheme": {
"description": "The literal scheme it must match",
"examples": [
"http",
"https"
],
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"enum": [
[
"request",
"response"
],
[
"request"
],
[
"response"
]
]
}
}
},
"url.Modifier": {
"title": "URL Modifier",
"description": "The url.Modifier allows you to change the URL despite what is set in the host and url_pattern combination.\n\nSee: ",
"type": "object",
"required": [
"scope"
],
"properties": {
"host": {
"description": "The hostname part of the URL including the port",
"examples": [
"example.com",
"localhost:8080"
],
"type": "string"
},
"path": {
"description": "The path part of the URL",
"examples": [
"/path/to"
],
"type": "string"
},
"query": {
"description": "Sets the query string parameters you want to pass, overwriting anything passed in the request. Notice that if you set a `query`, if the user passes other query string parameters listed under `input_query_strings`, they will be lost, and only the values passed in the modifier will be sent. For such uses, see the `querystring.Modifier`",
"examples": [
"param=1",
"key1=val&key2=val"
],
"type": "string"
},
"scheme": {
"description": "The scheme to apply",
"examples": [
"http",
"https"
],
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"const": [
"request"
]
}
}
},
"url.RegexFilter": {
"title": "URL RegexFilter",
"description": "The url.RegexFilter evaluates a regular expression (RE2 syntax) and executes the modifier desired when it matches, and the modifier declared under else when it does not.\n\nSee: ",
"type": "object",
"required": [
"scope",
"modifier",
"regex"
],
"properties": {
"else": {
"description": "The modifier you want to execute when the condition does not match",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"modifier": {
"description": "The modifier you want to execute when the condition matches",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"regex": {
"description": "The regular expression you want to check against the URL",
"type": "string"
},
"scope": {
"title": "Scope",
"description": "Scopes in which this modifier acts",
"const": [
"request"
]
}
}
}
},
"additionalProperties": false
},
"https://www.krakend.io/schema/v2.13/modifier/response-body.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Response values modifier",
"description": "Enterprise only. The content replacer plugin allows you to modify the response of your services by doing literal replacements or more sophisticated replacements with regular expressions.\n\nSee: ",
"type": "object",
"properties": {
"modifiers": {
"title": "Operations",
"description": "A list of modifiers you would like to apply to specific fields. The modifiers are evaluated and applied in sequential order.\n\nSee: ",
"default": [],
"type": "array",
"items": {
"type": "object",
"maxProperties": 1,
"properties": {
"literal": {
"title": "Literal replacement",
"description": "A literal replacement of strings (case sensitive).\n\nSee: ",
"examples": [
{
"field": "data.example",
"find": "findme",
"replace": "replaceme"
}
],
"type": "object",
"required": [
"field",
"find",
"replace"
],
"properties": {
"field": {
"title": "Field to modify",
"description": "The field you want to modify. The field supports dot notation to access nested objects (it does not work with nested arrays).\n\nSee: ",
"examples": [
"data.credit_card"
],
"type": "string"
},
"find": {
"title": "Find",
"description": "The exact string you want to replace.\n\nSee: ",
"type": "string"
},
"replace": {
"title": "Replace",
"description": "The replacement string you want to use for all matching results. \n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"lower": {
"title": "Lowercase",
"description": "Converts a given string to lowercase.\n\nSee: ",
"examples": [
{
"field": "surname"
}
],
"type": "object",
"required": [
"field"
],
"properties": {
"field": {
"title": "Field to modify",
"description": "The field you want to modify. The field supports dot notation to access nested objects (it does not work with nested arrays).\n\nSee: ",
"examples": [
"user.surname"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"regexp": {
"title": "Regular expression modifier",
"description": "A list of regular expressions you would like to apply to specific fields. The expressions are evaluated and applied in sequential order.\n\nSee: ",
"examples": [
{
"field": "data.credit_card",
"find": "(^\\d{4})(.*)",
"replace": "${1}-XXXX"
}
],
"type": "object",
"required": [
"field",
"find",
"replace"
],
"properties": {
"field": {
"title": "Field to modify",
"description": "The field you want to modify. The field supports dot notation to access nested objects (it does not work with nested arrays).\n\nSee: ",
"examples": [
"data.credit_card"
],
"type": "string"
},
"find": {
"title": "Find",
"description": "The find expression or literal you want to use. The syntax of the regular expressions accepted is the same general syntax used by Perl, Python, and other languages. More precisely, it is the syntax accepted by RE2 and described at [\n\nSee: ",
"type": "string"
},
"replace": {
"title": "Replace",
"description": "The literal string or expression you want to use as a replacement. Use `$` signs to replace captured groups. \n\nSee: ",
"examples": [
"${1}-XXXX"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"trim": {
"title": "Trims by character",
"description": "Removes a specific set of characters from the beginning and the end of the string.\n\nSee: ",
"examples": [
{
"field": "description",
"find": "\n"
}
],
"type": "object",
"required": [
"field",
"find"
],
"properties": {
"field": {
"title": "Field to modify",
"description": "The field you want to modify. The field supports dot notation to access nested objects (it does not work with nested arrays).\n\nSee: ",
"examples": [
"description"
],
"type": "string"
},
"find": {
"title": "Find",
"description": "The sequence of characters you want to trim in the response.\n\nSee: ",
"examples": [
"\r\n",
"\n",
"\t",
" "
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"upper": {
"title": "Uppercase",
"description": "Converts a given string to uppercase.\n\nSee: ",
"examples": [
{
"field": "surname"
}
],
"type": "object",
"required": [
"field"
],
"properties": {
"field": {
"title": "Field to modify",
"description": "The field you want to modify. The field supports dot notation to access nested objects (it does not work with nested arrays).\n\nSee: ",
"examples": [
"user.surname"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/http-client.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "HTTP client plugins.\n\nSee: https://www.krakend.io/docs/extending/injecting-plugins/",
"type": "object",
"properties": {
"name": {
"title": "Plugin name",
"description": "The name of the plugin to load. Only one plugin is supported per backend.\n\nSee: ",
"examples": [
"no-redirect",
"http-logger",
"static-filesystem"
],
"type": "string"
}
}
},
"https://www.krakend.io/schema/v2.13/plugin/middleware.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Enterprise only. Middleware plugins.\n\nSee: https://www.krakend.io/docs/extending/injecting-plugins/",
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"title": "Plugin name",
"description": "An array with the names of plugins to load. The names are defined inside your plugin.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"https://www.krakend.io/schema/v2.13/plugin/content-replacer.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Content Replacer",
"description": "Enterprise only. The content replacer plugin allows you to modify the response of your services by doing literal replacements or more sophisticated replacements with regular expressions.\n\nSee: See: ",
"deprecated": true,
"type": "object",
"minProperties": 1,
"additionalProperties": {
"type": "object",
"required": [
"find",
"replace"
],
"properties": {
"find": {
"title": "Find",
"description": "The find expression or literal you want to use.\n\nSee: ",
"type": "string"
},
"regexp": {
"title": "Is a regexp?",
"description": "When you are passing regular expressions instead of literal values, set it to true.\n\nSee: ",
"default": false,
"type": "boolean"
},
"replace": {
"title": "Find",
"description": "The literal string or expression you want to use as a replacement.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"https://www.krakend.io/schema/v2.13/plugin/ip-filter.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "IP filter",
"description": "Enterprise only. The IP filtering plugin allows you to restrict the traffic to your API gateway based on the IP address. It works in two different modes (allow or deny) where you define the list of IPs (CIDR blocks) that are authorized to use the API, or that are denied from using the API.\n\nSee: ",
"type": "object",
"required": [
"CIDR",
"allow"
],
"properties": {
"CIDR": {
"title": "CIDR",
"description": "The CIDR blocks (list of IPs) you want to allow or deny.\n\nSee: ",
"examples": [
[
"192.168.0.0/24",
"172.17.2.56/32"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"allow": {
"title": "Allow or deny mode",
"description": "When true, only the matching IPs are able to access the content. When false, all matching IPs are discarded.\n\nSee: ",
"default": false,
"type": "boolean"
},
"client_ip_headers": {
"title": "Client IP Headers",
"description": "A custom list of all headers that might contain the real IP of the client. The first matching IP in the list will be used. Default headers are (in order of checking): X-Forwarded-For, X-Real-IP, and X-Appengine-Remote-Addr.\n\nSee: ",
"examples": [
[
"X-Forwarded-For",
"X-Real-IP",
"X-Appengine-Remote-Addr"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"trusted_proxies": {
"title": "Trusted proxies",
"description": "A custom list of all the recognized machines/balancers that proxy the client to your application. This list is used to avoid spoofing when trying to get the real IP of the client.\n\nSee: ",
"examples": [
[
"10.0.0.0/16"
]
],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/response-schema-validator.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Response Schema Validator",
"description": "Enterprise only. The response schema validator plugin adds a schema validation before the gateway returns the response to the end-user or before it’s merged in the endpoint with the rest of the backends.\n\nSee: ",
"deprecated": true,
"type": "object",
"required": [
"schema"
],
"properties": {
"error": {
"title": "Error definition",
"description": "In case the validation fails, the error definition containing body and status.\n\nSee: ",
"examples": [
{
"body": "We couldn't process you request, try again later.",
"status": 401
}
],
"type": "object",
"properties": {
"body": {
"title": "Error body",
"description": "The error message you want to show when the validation fails. Set it to an empty string `\"\"` to show the JSON-schema validation error.",
"default": "",
"type": "string"
},
"status": {
"title": "Error code",
"description": "The HTTP status code you want to set back in the response.",
"default": 500,
"type": "integer"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"schema": {
"title": "JSON Schema",
"description": "Write your JSON schema directly in this field, with any number of fields or validations you need.\n\nSee: ",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/req-resp-modifier.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Request-Response modifier plugins",
"type": "object",
"properties": {
"content-replacer": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1content-replacer.json"
},
"ip-filter": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1ip-filter.json"
},
"name": {
"title": "Plugin name",
"description": "An array with the names of plugins to load. The names are defined inside your plugin.\n\nSee: ",
"examples": [
[
"myplugin"
]
],
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"response-schema-validator": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1response-schema-validator.json"
}
}
},
"https://www.krakend.io/schema/v2.13/proxy/flatmap.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Flatmap (Array manipulation)",
"description": "The flatmap middleware allows you to manipulate collections (or arrays, or lists, you name it) from the backend response. While the basic manipulation operations allow you to work directly with objects, the collections require a different approach: the flatmap component.\n\nSee: ",
"examples": [
[
{
"type": "move",
"args": [
"a.*.b1.*.c",
"a.*.b1.*.d"
]
}
]
],
"type": "array",
"items": {
"title": "Flatmap operation",
"type": "object",
"required": [
"type",
"args"
],
"properties": {
"type": {
"title": "Type",
"description": "The types of operations are defined as follows.\n\nSee: ",
"enum": [
"move",
"del",
"append"
]
},
"args": {
"title": "Args",
"description": "The arguments passed to the operation.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"https://www.krakend.io/schema/v2.13/proxy.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Proxy option",
"type": "object",
"properties": {
"flatmap_filter": {
"title": "Flatmap (Array manipulation)",
"description": "The list of operations to **execute sequentially** (top down). Every operation is defined with an object containing two properties:\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1proxy~1flatmap.json",
"type": "array"
},
"shadow": {
"title": "Traffic shadowing or mirroring",
"description": "Mark this backend as a shadow backend. Sending copies of the traffic but ignore its responses.\n\nSee: ",
"default": true,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/qos/circuit-breaker.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Circuit Breaker",
"description": "The circuit breaker prevents sending more traffic to a failing backend.\n\nSee: ",
"type": "object",
"required": [
"interval",
"timeout",
"max_errors"
],
"properties": {
"interval": {
"title": "Interval",
"description": "Time window where the errors count, in seconds.\n\nSee: ",
"type": "integer"
},
"log_status_change": {
"title": "Log status change",
"description": "Whether to log the changes of state of this circuit breaker or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"max_errors": {
"title": "Max Errors",
"description": "The **CONSECUTIVE** (not total) number of errors within the `interval` window to consider the backend unhealthy. All HTTP status codes different than `20x` are considered an error, except for the `no-op` encoding that does not evaluate status codes and is limited to connectivity/networking, security and component errors. See the definition of error below.\n\nSee: ",
"type": "integer"
},
"name": {
"title": "Name",
"description": "A friendly name to follow this circuit breaker's activity in the logs.\n\nSee: ",
"examples": [
"cb-backend-1"
],
"type": "string"
},
"timeout": {
"title": "Timeout",
"description": "For how many seconds the circuit breaker will wait before testing again if the backend is healthy.\n\nSee: ",
"type": "integer"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/qos/circuit-breaker-http.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Circuit Breaker",
"description": "Enterprise only. The HTTP circuit breaker prevents sending more traffic to a backend that is returning status codes that are considered errors.\n\nSee: ",
"type": "object",
"required": [
"interval",
"timeout",
"max_errors",
"valid_status_codes"
],
"properties": {
"interval": {
"title": "Interval",
"description": "Time window where the errors count, in seconds.\n\nSee: ",
"type": "integer"
},
"log_status_change": {
"title": "Log status change",
"description": "Whether to log the changes of state of this circuit breaker or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"max_errors": {
"title": "Max Errors",
"description": "The **CONSECUTIVE** (not total) number of errors within the `interval` window to consider the backend unhealthy. All HTTP status codes different than `20x` are considered an error, except for the `no-op` encoding that does not evaluate status codes and is limited to connectivity/networking, security and component errors. See the definition of error below.\n\nSee: ",
"examples": [
5
],
"type": "integer"
},
"name": {
"title": "Name",
"description": "A friendly name to follow this circuit breaker's activity in the logs.\n\nSee: ",
"examples": [
"cb-backend-1"
],
"type": "string"
},
"timeout": {
"title": "Timeout",
"description": "For how many seconds the circuit breaker will wait before testing again if the backend is healthy. This number of seconds can also be read as the **minimum cooldown** of the backend interaction.\n\nSee: ",
"examples": [
10
],
"type": "integer"
},
"valid_status_codes": {
"title": "Valid Status Codes",
"description": "A list of HTTP status codes that will be considered successful responses. Any response with a status code not in this list will be counted as an error by the circuit breaker.\n\nSee: ",
"examples": [
[
200,
201,
404
]
],
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "integer",
"maximum": 599,
"minimum": 100
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/qos/ratelimit/proxy.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Backend Ratelimit",
"description": "Restrict the rate of requests KrakenD makes to your backends.\n\nSee: ",
"type": "object",
"required": [
"max_rate",
"capacity"
],
"properties": {
"capacity": {
"title": "Capacity",
"description": "The capacity according to the [token bucket algorithm](https://www.krakend.io/docs/throttling/token-bucket/). Defines the maximum requests you can do in an instant (including the zero moment when you start the gateway), and can be larger or smaller than the `max_rate`. When unsure, use the same value of `max_rate`, so the maximum number of requests can be consumed at once.\n\nSee: ",
"default": 1,
"type": "integer"
},
"every": {
"title": "Time window",
"description": "Time period in which the counter works. For instance, if you set an `every` of `10m` and a `max_rate` of `5`, you are allowing 5 requests every ten minutes.\n\nSee: ",
"default": "1s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"max_rate": {
"title": "Max rate",
"description": "Maximum requests per second you want to accept in this backend.\n\nSee: ",
"examples": [
0.5
],
"type": "number"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/backend_log.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Enterprise only. Improved logging",
"description": "Enables the Backend Log capabilities.\n\nSee: ",
"type": "object",
"minProperties": 1,
"properties": {
"custom_format": {
"title": "Backend Log Format",
"description": "Specify the custom format of the Backend Logs.\n\nSee: ",
"examples": [
"%{time:kitchen} | (╯°□°)╯( ┻━┻ %{statusCode} | %{method} %{host} %{path}\n"
],
"default": "%{prefix}%{time} |%{statusCode}| %{latencyMs} | %{method} %{host} %{path}\n",
"type": "string"
},
"log_with_level": {
"title": "Backend Log Level",
"description": "What type of **reporting level** do you want to set at the backends? The options below go from more verbose to least. Use the `DEBUG` level in the development stages but not in production. Some components can add extra verbosity while in DEBUG mode and send **multiline content**, which is not always suitable for automated log parsing.\n\nSee: ",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
]
},
"no_value": {
"title": "Backend Log No Value",
"description": "When the variable does not resolve to any value, the string you want to write in the log. If the string is set to an empty value, a dash `-` is printed.\n\nSee: ",
"examples": [
"-",
"null",
"no_value",
""
],
"default": "-",
"type": "string"
},
"prefix": {
"title": "Backend Log Prefix",
"description": "Adds the defined string at the beginning of every logged line, so you can quickly filter messages with external tools later on.\n\nSee: ",
"examples": [
">>> "
],
"default": "",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/opentelemetry-backend.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "OpenTelemetry Backend Override",
"description": "Enterprise only. Overrides metrics and traces declared by the OpenTelemetry service.\n\nSee: ",
"type": "object",
"properties": {
"backend": {
"title": "Report backend activity",
"description": "Reports the activity between KrakenD and each of your backend services. This is the more granular layer.\n\nSee: ",
"type": "object",
"properties": {
"metrics": {
"type": "object",
"properties": {
"detailed_connection": {
"title": "Detailed HTTP connection metrics",
"description": "Whether you want to enable detailed metrics for the HTTP connection phase or not. Includes times to connect, DNS querying, and the TLS handshake.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_stage": {
"title": "Disable this stage",
"description": "Whether to turn off the metrics or not. Setting this to `true` means stop reporting any data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"read_payload": {
"title": "Detailed payload read",
"description": "Whether you want to enable metrics for the response reading payload or not (HTTP connection not taken into account).\n\nSee: ",
"default": false,
"type": "boolean"
},
"round_trip": {
"title": "Detailed Round Trip",
"description": "Whether you want to enable metrics for the actual HTTP request for the backend or not (manipulation not taken into account). This is the time your backend needs to produce a result.\n\nSee: ",
"default": false,
"type": "boolean"
},
"static_attributes": {
"title": "static attributes",
"description": "a list of tags or labels you want to associate with these metrics.\n\nsee: ",
"examples": [
[
{
"key": "my_metric_attr",
"value": "my_metric_val"
}
]
],
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"title": "key",
"description": "the key, tag, or label name you want to use.\n\nsee: ",
"type": "string"
},
"value": {
"title": "value",
"description": "the static value you want to assign to this key.\n\nsee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"traces": {
"type": "object",
"properties": {
"detailed_connection": {
"title": "Detailed HTTP connection",
"description": "Whether you want to add detailed trace attributes for the HTTP connection phase or not. Includes times to connect, DNS querying, and the TLS handshake.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_stage": {
"title": "Disable this stage",
"description": "Whether to turn off the traces or not. Setting this to `true` means stop reporting any data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"read_payload": {
"title": "Detailed payload read",
"description": "Whether you want to add trace attributes for the response reading payload or not (HTTP connection not taken into account).\n\nSee: ",
"default": false,
"type": "boolean"
},
"report_headers": {
"title": "Report headers",
"description": "Whether you want to report the final headers that reached the backend.\n\nSee: ",
"default": false,
"type": "boolean"
},
"round_trip": {
"title": "Detailed Round Trip",
"description": "Whether you want to add trace attributes for the actual HTTP request for the backend or not (manipulation not taken into account). This is the time your backend needs to produce a result.\n\nSee: ",
"default": false,
"type": "boolean"
},
"skip_headers": {
"title": "Skip headers",
"description": "A list of headers you want to skip when reporting the headers that reached the backend. This is useful to avoid reporting sensitive data.\n\nSee: ",
"examples": [
[
"X-Backend-Secret",
"X-All-Secret"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"static_attributes": {
"title": "static attributes",
"description": "a list of tags or labels you want to associate with these metrics.\n\nsee: ",
"examples": [
[
{
"key": "my_metric_attr",
"value": "my_metric_val"
}
]
],
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"title": "key",
"description": "the key, tag, or label name you want to use.\n\nsee: ",
"type": "string"
},
"value": {
"title": "value",
"description": "the static value you want to assign to this key.\n\nsee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/validation/cel.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Common Expression Language (CEL) validations",
"description": "The Common Expression Language (CEL) middleware enables expression evaluation, when an expression returns false, KrakenD does not return the content as the condition has failed. Otherwise, if all expressions returned true, the content is served.\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"title": "Object in array",
"type": "object",
"required": [
"check_expr"
],
"properties": {
"check_expr": {
"title": "Check expression",
"description": "The expression that evaluates as a boolean, you can write here any conditional. If the result of the expression is `true`, the execution continues. See in the docs how to use additional variables to retrieve data from requests, responses, and tokens.\n\nSee: ",
"examples": [
"int(req_params.Id) % 3 == 0"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"https://www.krakend.io/schema/v2.13/validation/response-json-schema.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Response Schema Validator",
"description": "Enterprise only. The response schema validator adds a schema validation before the gateway returns the response to the end-user or before it’s merged in the endpoint with the rest of the backends.\n\nSee: ",
"type": "object",
"required": [
"schema"
],
"properties": {
"error": {
"title": "Error definition",
"description": "In case the validation fails, the error definition containing body and status.\n\nSee: ",
"examples": [
{
"body": "We couldn't process you request, try again later.",
"status": 401
}
],
"type": "object",
"properties": {
"body": {
"title": "Error body",
"description": "The error message you want to show when the validation fails. Set it to an empty string `\"\"` to show the JSON-schema validation error.",
"default": "",
"type": "string"
},
"content_type": {
"title": "Content-Type",
"description": "The Content-Type header you want to set back in the response when you are setting a custom `body`",
"examples": [
"application/json"
],
"default": "text/plain",
"type": "string"
},
"status": {
"title": "Error code",
"description": "The HTTP status code you want to set back in the response.",
"default": 500,
"type": "integer"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"schema": {
"title": "JSON Schema",
"description": "Write your JSON schema directly in this field, with any number of fields or validations you need.\n\nSee: ",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/security/policies.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Securiy Policies",
"description": "Enterprise only. The policies engine allows you to write custom sets of policies that are validated during requests, responses, or token validation.\n\nSee: ",
"type": "object",
"anyOf": [
{
"required": [
"req"
]
},
{
"required": [
"resp"
]
},
{
"required": [
"jwt"
]
}
],
"properties": {
"auto_join_policies": {
"title": "Auto-join policies",
"description": "When true, all policies of the same type concatenate with an AND operation to evaluate a single expression. Performs faster, but its harder the debug.",
"default": false,
"type": "boolean"
},
"debug": {
"title": "Debug",
"description": "When true, all the inputs and evaluation results are printed in the console.",
"default": false,
"type": "boolean"
},
"disable_macros": {
"title": "Disable advanced macros",
"description": "Advanced macros can be disabled in those policies not needing them for a faster evaluation.",
"default": false,
"type": "boolean"
},
"jwt": {
"title": "JWT policies",
"description": "All the policies applied in the JWT context (token validation). **You must configure `auth/validator`** for the policies to run, otherwise they will be skipped. Any policy failing will generate a `401 Unauthorized` error. Works in the `endpoint` context only, and is not available under `backend`.\n\nSee: ",
"type": "object",
"required": [
"policies"
],
"properties": {
"policies": {
"title": "Policies",
"description": "An array with all the policies to evaluate. Each policy is represented as a string\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"title": "The policy you want to evaluate",
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"req": {
"title": "Request policies",
"description": "All the policies applied in the request context.\n\nSee: ",
"type": "object",
"required": [
"policies"
],
"properties": {
"error": {
"type": "object",
"properties": {
"body": {
"title": "Error body",
"description": "Leave an empty string to use the validation error, or write a string with the error response body. This error is NOT returned in the response, but in the application logs, unless you enable `return_detailed_errors` in the `router` section. You can add escaped JSON, XML, etc in the string and add a Content-Type.\n\nSee: ",
"default": "",
"type": "string"
},
"content_type": {
"title": "Content-Type",
"description": "The Content-Type header you'd like to send with the error response. When unset, uses `text/plain` by default.\n\nSee: ",
"default": "text/plain",
"type": "string"
},
"status": {
"title": "HTTP status code",
"description": "The HTTP status code you want to return when the validation fails.\n\nSee: ",
"default": 500,
"type": "integer"
}
}
},
"policies": {
"title": "Policies",
"description": "An array with all the policies to evaluate. Each policy is represented as a string\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"title": "The policy you want to evaluate",
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"resp": {
"title": "Response policies",
"description": "All the policies applied in the response context.\n\nSee: ",
"type": "object",
"required": [
"policies"
],
"properties": {
"error": {
"type": "object",
"properties": {
"body": {
"title": "Error body",
"description": "Leave an empty string to use the validation error, or write a string with the error response body. This error is NOT returned in the response, but in the application logs, unless you enable `return_detailed_errors` in the `router` section. You can add escaped JSON, XML, etc in the string and add a Content-Type.\n\nSee: ",
"default": "",
"type": "string"
},
"content_type": {
"title": "Content-Type",
"description": "The Content-Type header you'd like to send with the error response. When unset, uses `text/plain` by default.\n\nSee: ",
"default": "text/plain",
"type": "string"
},
"status": {
"title": "HTTP status code",
"description": "The HTTP status code you want to return when the validation fails.\n\nSee: ",
"default": 500,
"type": "integer"
}
}
},
"policies": {
"title": "Policies",
"description": "An array with all the policies to evaluate. Each policy is represented as a string\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"title": "The policy you want to evaluate",
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/workflow_extra_config.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Schema definition for extra_config of workflows",
"type": "object",
"properties": {
"modifier/jmespath": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1jmespath.json"
},
"modifier/lua-proxy": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1lua.json"
},
"modifier/request-body-generator": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1body-generator.json"
},
"modifier/response-body-generator": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1body-generator.json"
},
"plugin/req-resp-modifier": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1req-resp-modifier.json"
},
"proxy": {
"title": "Proxy",
"type": "object",
"properties": {
"combiner": {
"title": "Custom combiner",
"description": "For custom builds of KrakenD only",
"examples": [
"combiner_name"
],
"type": "string"
},
"flatmap_filter": {
"title": "Flatmap (Array manipulation)",
"description": "The list of operations to **execute sequentially** (top down). Every operation is defined with an object containing two properties:\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1proxy~1flatmap.json",
"type": "array"
},
"sequential": {
"title": "Sequential proxy",
"description": "The sequential proxy allows you to chain backend requests, making calls dependent one of each other.\n\nSee: ",
"default": true,
"type": "boolean"
},
"sequential_propagated_params": {
"title": "Sequential propagated parameters",
"description": "The list of parameters you want to propagate from a previous response to the next request. Parameters are accessible by Lua scripts, CEL, security policies, the body generator, or plugins. When you add a `resp`-like parameter in this list, the parameter becomes available to the components mentioned in subsequent calls, **uppercasing the first letter**. For instance, if you add `resp0_user`, you can access in the second, third, etc. backends in Lua to `req:params('Resp0_user')`.The format of the parameters must start with `respX_` or `respX`, where `X` is the backend index from which you want to take the parameter. If you don't set the underscore `_`, you set the whole payload as a parameter. For instance, `resp0` sets a parameter `Resp0` to use in Lua or a Body generator and contains **the entire payload of the backend 0** (as a string). In this extreme case, you must use `no-op` in the backend's output (even the endpoint has a `json` output encoding) and you should access the value in Lua or a plugin. Note that access to **nested parameters** uses a single string with the dot notation inside, e.g.: `req_params['Resp0_f1.f2.f3']` (CEL and Security Policies), or `{{ index .req_params \"Resp0_f1.f2.f3\" }}` (body generators).\n\nSee: ",
"examples": [
[
"resp0"
],
[
"resp1_my_field",
"resp0_user_id"
]
],
"type": "array",
"items": {
"title": "Propagated parameter name",
"description": "A `resp`-like string that references the field you want to set a parameter and use it in the next backend call.",
"type": "string",
"pattern": "^resp[0-9]+(_[^\\s]+)?$"
}
},
"static": {
"title": "Static response",
"description": "The static proxy injects static data in the final response when the selected strategy matches.\n\nSee: ",
"type": "object",
"required": [
"data",
"strategy"
],
"properties": {
"data": {
"title": "Data",
"description": "The static data (as a JSON object) that you will return.\n\nSee: ",
"type": "object"
},
"strategy": {
"title": "Strategy",
"description": "One of the supported strategies\n\nSee: ",
"enum": [
"always",
"success",
"complete",
"errored",
"incomplete"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"security/policies": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1security~1policies.json"
},
"validation/cel": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1validation~1cel.json"
},
"validation/json-schema": {
"title": "Validating the body with the JSON Schema",
"description": "apply automatic validations using the JSON Schema vocabulary before the content passes to the backends. The json schema component allows you to define validation rules on the body, type definition, or even validate the fields' values.\n\nSee: ",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/workflow.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Workflow Object",
"type": "object",
"required": [
"endpoint",
"backend"
],
"properties": {
"backend": {
"title": "Backend",
"description": "List of all the [backend objects](https://www.krakend.io/docs/backends/) called within this workflow. Each backend can initiate another workflow if needed.",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend.json",
"type": "object"
}
},
"concurrent_calls": {
"title": "Concurrent calls",
"description": "The concurrent requests are an excellent technique to improve the response times and decrease error rates by requesting in parallel the same information multiple times. Yes, you make the same request to several backends instead of asking to just one. When the first backend returns the information, the remaining requests are canceled.\n\nSee: ",
"default": 1,
"type": "integer",
"maximum": 5,
"minimum": 1
},
"endpoint": {
"title": "Workflow endpoint name",
"description": "An endpoint name for the workflow that will be used in logs. The name will be appended to the string `/__workflow/` in the logs, and although it does not receive traffic under this route, it is necessary when you want to pass URL `{params}` to the nested backends.\n\nSee: ",
"examples": [
"/workflow-1/{param1}"
],
"type": "string"
},
"extra_config": {
"title": "Extra configuration",
"description": "Configuration entries for additional components that are executed within this endpoint, during the request, response or merge operations.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1workflow_extra_config.json",
"type": "object"
},
"ignore_errors": {
"title": "Ignore errors",
"description": "Allow the workflow to continue with the rest of declared actions when there are errors (like security policies, network errors, etc). The default behavior of KrakenD is to abort an execution that has errors as soon as possible. If you use conditional backends and similar approaches, you might want to allow the gateway to go through all steps.\n\nSee: ",
"default": false
},
"output_encoding": {
"title": "Output encoding",
"description": "The gateway can work with several content types, even allowing your clients to choose how to consume the content. See the [supported encodings](https://www.krakend.io/docs/endpoints/content-types/)",
"default": "json",
"enum": [
"json",
"json-collection",
"yaml",
"fast-json",
"xml",
"negotiate",
"string",
"no-op"
]
},
"timeout": {
"title": "Timeout",
"description": "The duration you write in the timeout represents the **whole duration of the pipe**, so it counts the time all your backends take to respond and the processing of all the components involved in the endpoint (the request, fetching data, manipulation, etc.). By default the timeout is taken from the parent endpoint, if redefined **make sure that is smaller than the endpoint's**",
"examples": [
"2s",
"1500ms"
],
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend_extra_config.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Extra configuration for backends",
"type": "object",
"properties": {
"ai/llm": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1ai~1llm.json"
},
"auth/aws-sigv4": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1aws-sigv4.json"
},
"auth/client-credentials": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1client-credentials.json"
},
"auth/gcp": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1gcp.json"
},
"auth/ntlm": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1ntlm.json"
},
"backend/amqp/consumer": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1amqp~1consumer.json"
},
"backend/amqp/producer": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1amqp~1producer.json"
},
"backend/conditional": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1conditional.json"
},
"backend/graphql": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1graphql.json"
},
"backend/grpc": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1grpc.json"
},
"backend/http": {
"oneOf": [
{
"required": [
"return_error_details"
]
},
{
"required": [
"return_error_code"
]
}
],
"properties": {
"return_error_code": {
"title": "Return error code",
"description": "Returns the HTTP status code of the backend (when there is only one). The headers are not returned.\n\nSee: ",
"type": "boolean"
},
"return_error_details": {
"title": "Return error details",
"description": "Returns to the client details of a failing request.\n\nSee: ",
"type": "string"
}
},
"type": "object"
},
"backend/http/client": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1http_client.json"
},
"backend/lambda": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1lambda.json"
},
"backend/pubsub/publisher": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1pubsub~1publisher.json"
},
"backend/pubsub/subscriber": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1pubsub~1subscriber.json"
},
"backend/pubsub/publisher/kafka": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1pubsub~1kafka~1publisher.json"
},
"backend/pubsub/subscriber/kafka": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1pubsub~1kafka~1subscriber.json"
},
"backend/soap": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1soap.json"
},
"backend/static-filesystem": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend~1static-filesystem.json"
},
"governance/quota": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1governance~1quota.json"
},
"modifier/body-generator": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1body-generator.json"
},
"modifier/jmespath": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1jmespath.json"
},
"modifier/lua-backend": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1lua.json"
},
"modifier/martian": {
"title": "Martian modifiers",
"description": "Transform requests and responses through a simple DSL definition in the configuration file.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1martian.json",
"type": "object"
},
"modifier/request-body-generator": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1body-generator.json"
},
"modifier/response-body": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1response-body.json"
},
"modifier/response-body-generator": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1body-generator.json"
},
"plugin/http-client": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1http-client.json"
},
"plugin/middleware": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1middleware.json"
},
"plugin/req-resp-modifier": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1req-resp-modifier.json"
},
"proxy": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1proxy.json"
},
"qos/circuit-breaker": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1circuit-breaker.json"
},
"qos/circuit-breaker/http": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1circuit-breaker-http.json"
},
"qos/http-cache": {
"title": "Backend Cache",
"description": "Enable in-memory caching for backend responses for as long as its `Cache-Control` header permits. Only safe methods are cached (GET or HEAD). The final backend URL and the `Vary` headers are used to create the caching key.\n\nSee: ",
"type": "object",
"oneOf": [
{
"required": [
"max_size",
"max_items"
]
},
{
"required": [
"shared"
]
},
{
"maxProperties": 0
}
],
"properties": {
"max_items": {
"title": "Max items",
"description": "To be released on open source on v2.10. The maximum number of items the LRU cache will store **for this cache bucket** before starting to do evictions. When `max_items` is declared, you must declare `max_size` as well.\n\nSee: ",
"examples": [],
"type": "integer",
"minimum": 1
},
"max_size": {
"title": "Max size",
"description": "To be released on open source on v2.10. The maximum number of bytes you allow the LRU cache to store **for this cache bucket** before starting to do evictions. This is not the total cache you allow to the system, but the number of bytes you reserve to this backend (or its `shared` neighbours). will store before starting to do evictions. When `max_size` is declared, you must declare `max_items` as well.\n\nSee: ",
"examples": [
104857600,
1048576
],
"type": "integer",
"minimum": 1024
},
"shared": {
"title": "Shared cache",
"description": "Allows different backend definitions with this flag set to true to reuse the store between them when the request is the same. Otherwise, each backend uses a private cache context that is not accessible by other endpoints. The cache definition is unique for every backend URL + `Vary` header combination.\n\nSee: ",
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"qos/ratelimit/proxy": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1proxy.json"
},
"security/policies": {
"title": "Securiy Policies",
"description": "Enterprise only. The policies engine allows you to write custom sets of policies that are validated during requests, responses, or token validation.\n\nSee: ",
"type": "object",
"anyOf": [
{
"required": [
"req"
]
},
{
"required": [
"resp"
]
}
],
"properties": {
"auto_join_policies": {
"title": "Auto-join policies",
"description": "When true, all policies of the same type concatenate with an AND operation to evaluate a single expression. Performs faster, but its harder the debug.",
"default": false,
"type": "boolean"
},
"debug": {
"title": "Debug",
"description": "When true, all the inputs and evaluation results are printed in the console.",
"default": false,
"type": "boolean"
},
"disable_macros": {
"title": "Disable advanced macros",
"description": "Advanced macros can be disabled in those policies not needing them for a faster evaluation.",
"default": false,
"type": "boolean"
},
"req": {
"title": "Request policies",
"description": "All the policies applied in the request context.\n\nSee: ",
"type": "object",
"required": [
"policies"
],
"properties": {
"error": {
"type": "object",
"properties": {
"body": {
"title": "Error body",
"description": "Leave an empty string to use the validation error, or write a string with the error response body. This error is NOT returned in the response, but in the application logs, unless you enable `return_detailed_errors` in the `router` section. You can add escaped JSON, XML, etc in the string and add a Content-Type.\n\nSee: ",
"default": "",
"type": "string"
},
"content_type": {
"title": "Content-Type",
"description": "The Content-Type header you'd like to send with the error response. When unset, uses `text/plain` by default.\n\nSee: ",
"default": "text/plain",
"type": "string"
},
"status": {
"title": "HTTP status code",
"description": "The HTTP status code you want to return when the validation fails.\n\nSee: ",
"default": 500,
"type": "integer"
}
}
},
"policies": {
"title": "Policies",
"description": "An array with all the policies to evaluate. Each policy is represented as a string\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"title": "The policy you want to evaluate",
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"resp": {
"title": "Response policies",
"description": "All the policies applied in the response context.\n\nSee: ",
"type": "object",
"required": [
"policies"
],
"properties": {
"error": {
"type": "object",
"properties": {
"body": {
"title": "Error body",
"description": "Leave an empty string to use the validation error, or write a string with the error response body. This error is NOT returned in the response, but in the application logs, unless you enable `return_detailed_errors` in the `router` section. You can add escaped JSON, XML, etc in the string and add a Content-Type.\n\nSee: ",
"default": "",
"type": "string"
},
"content_type": {
"title": "Content-Type",
"description": "The Content-Type header you'd like to send with the error response. When unset, uses `text/plain` by default.\n\nSee: ",
"default": "text/plain",
"type": "string"
},
"status": {
"title": "HTTP status code",
"description": "The HTTP status code you want to return when the validation fails.\n\nSee: ",
"default": 500,
"type": "integer"
}
}
},
"policies": {
"title": "Policies",
"description": "An array with all the policies to evaluate. Each policy is represented as a string\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"title": "The policy you want to evaluate",
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"telemetry/logging": {
"title": "Backend Log",
"description": "Enterprise only. Add a specific Backend Log. Useful to see status codes, headers, and other information that come from your backends.\n\nSee: ",
"type": "object",
"properties": {
"backend": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1backend_log.json"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"telemetry/opentelemetry": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1opentelemetry-backend.json"
},
"validation/cel": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1validation~1cel.json"
},
"validation/response-json-schema": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1validation~1response-json-schema.json"
},
"workflow": {
"title": "Workflow",
"description": "Enterprise only. A whole new endpoint that is executed within this backend context.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1workflow.json",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/backend.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Backend Object",
"description": "A backend object is an array of all the services that an endpoint connects to. It defines the list of hostnames that connects to and the URL to send or receive the data.",
"type": "object",
"required": [
"url_pattern"
],
"properties": {
"allow": {
"title": "Allow (data manipulation)",
"description": "**Only return the fields in the list**. Only the matching fields (case-sensitive) are returned in the final response. Use a dot `.` separator to define nested attributes, e.g.: `a.b` returns `{\"a\":{\"b\": true}}` \n\nSee: ",
"examples": [
[
"user_id",
"field1.subfield2"
]
],
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"deny": {
"title": "Deny (data manipulation)",
"description": "**Don't return the fields in the list**. All matching fields (case-sensitive) defined in the list, are removed from the response. Use a dot `.` separator to define nested attributes, e.g.: `a.b` removes `{\"a\":{\"b\": true}}`.\n\nSee: ",
"examples": [
[
"token",
"CVV",
"password"
]
],
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"disable_host_sanitize": {
"title": "Disable host sanitize",
"description": "Set it to `true` when the host doesn't need to be checked for an HTTP protocol. This is the case of `sd=dns` or when using other protocols like `amqp://`, `nats://`, `kafka://`, etc. When set to true, and the protocol is not HTTP, KrakenD fails with an `invalid host` error.",
"default": false,
"type": "boolean"
},
"encoding": {
"title": "Backend Encoding",
"description": "Defines your [needed encoding](https://www.krakend.io/docs/backends/supported-encodings/) to set how to parse the response. Defaults to the value of its endpoint's `encoding`, or to `json` if not defined anywhere else. Notice that `fast-json` and `yaml` are for Enterprise only.\n\nSee: ",
"default": "json",
"enum": [
"json",
"safejson",
"fast-json",
"xml",
"rss",
"string",
"no-op",
"yaml"
]
},
"extra_config": {
"title": "Backend Extra configuration",
"description": "When there is additional configuration related to a specific component or middleware (like a circuit breaker, rate limit, etc.), it is declared under this section.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend_extra_config.json",
"type": "object"
},
"group": {
"title": "Group (data manipulation)",
"description": "Instead of placing all the response attributes in the root of the response, create a new key and encapsulate the response inside.\n\nSee: ",
"default": "backend1",
"type": "string"
},
"host": {
"title": "Host array",
"description": "An array with all the available hosts to [load balance](https://www.krakend.io/docs/throttling/load-balancing/#balancing-egress-traffic-to-upstream) requests, including the schema (when possible) `schema://host:port`. E.g.: ` `. If you are in a platform where hosts or services are balanced (e.g., a K8S service), write a single entry in the array with the service name/balancer address. Defaults to the `host` declaration at the configuration's root level, and the service fails starting when there is none.",
"type": "array",
"items": {
"type": "string",
"pattern": ".+",
"minLength": 1
}
},
"input_headers": {
"title": "Allowed Headers In",
"description": "A second level of header filtering that defines the list of all headers allowed to reach this backend when different than the endpoint.\nBy default, all headers in the endpoint `input_headers` reach the backend, unless otherwise specified here. An empty list `[]` is considered a zero-value and allows all headers to pass. Use `[\"\"]` to explicitly remove all headers. See [headers forwarding](https://www.krakend.io/docs/endpoints/parameter-forwarding/#headers-forwarding)",
"examples": [
[
""
],
[
"User-Agent",
"Accept"
]
],
"default": [],
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"input_query_strings": {
"title": "Allowed Querystrings In",
"description": "A second level of query string filtering that defines the list of all query strings allowed to reach this backend when different than the endpoint.\nBy default, all query strings in the endpoint `input_query_strings` reach the backend, unless otherwise specified here. An empty list `[]` is considered a zero-value and allows all headers to pass. Use `[\"\"]` to explicitly remove all query strings. See [query strings forwarding](https://www.krakend.io/docs/endpoints/parameter-forwarding/#query-string-forwarding)",
"examples": [
[
""
],
[
"page",
"limit"
]
],
"default": [],
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"is_collection": {
"title": "Is a collection/array",
"description": "Set to true when your API does not return an object {} but a collection []\n\nSee: ",
"default": true,
"type": "boolean"
},
"mapping": {
"title": "Mapping",
"description": "Mapping, or also known as renaming, let you change the name of the fields of the generated responses, so your composed response would be as close to your use case as possible without changing a line on any backend.\n\nSee: ",
"examples": [
{
"from": "to"
}
],
"type": "object"
},
"method": {
"title": "Method",
"description": "The method sent to this backend in **uppercase**. The method does not need to match the endpoint's method. When the value is omitted, it uses the same endpoint's method. Some special methods will require you to use no-op encoding (like HEAD or OPTIONS) when these return an empty body.\n\nSee: ",
"default": "GET",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD",
"CONNECT",
"TRACE"
]
},
"sd": {
"title": "Service Discovery",
"description": "The [Service Discovery](https://www.krakend.io/docs/backends/service-discovery/) system to resolve your backend services. Defaults to `static` (no external Service Discovery). Use `dns` to use DNS SRV records. Use `dns-shared` to share the DNS resolution between backends using the same hosts.\n\nSee: ",
"default": "static",
"enum": [
"static",
"dns",
"dns-shared"
]
},
"sd_scheme": {
"title": "Service Discovery Scheme",
"description": "The [Service Discovery](https://www.krakend.io/docs/backends/service-discovery/) scheme to connect to your backend services.\n\nSee: ",
"examples": [
"http",
"https"
],
"default": "http",
"type": "string"
},
"target": {
"title": "Target (data manipulation)",
"description": "Removes the matching object from the reponse and returns only its contents.\n\nSee: ",
"examples": [
"data",
"content",
"response"
],
"type": "string"
},
"url_pattern": {
"title": "URL Pattern",
"description": "The path inside the service (no protocol, no host, no method). E.g: `/users`. Some functionalities under `extra_config` might drop the requirement of declaring a valid `url_pattern`, but they are exceptions. The URL must be RESTful, if it is not (e.g.: `/url.{some_variable}.json`), then see how to [disable RESTful checking](#disable-restful-checking).\n\nSee: ",
"examples": [
"/users",
"/user/{id_user}"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/async/amqp.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Async AMQP Driver",
"description": "The Async AMQP component enables the AMQP driver for the Async functionality.\n\nSee: ",
"type": "object",
"required": [
"name",
"host",
"exchange"
],
"properties": {
"auto_ack": {
"title": "Auto ACK",
"description": "When KrakenD retrieves the messages, regardless of the success or failure of the operation, it marks them as ACK. When auto ACK is not used, only successful backend responses do the ACK, and failing messages are requeued. Defaults to `false`.\n\nSee: ",
"default": false,
"type": "boolean"
},
"delete": {
"title": "Delete",
"description": "When `true`, AMQP deletes the queue when there are no remaining connections. This option is **not recommended** in most of the scenarios. If for instance, the connectivity between KrakenD and AMQP is lost for whatever reason and it's the only client, AMQP will delete the queue no matter the number of messages there are inside, and when KrakenD gets the connection again the queue won't exist and future connections will recreate it again.\n\nSee: ",
"default": false,
"type": "boolean"
},
"durable": {
"title": "Durable",
"description": "Durable queues will survive server restarts and remain when there are no remaining consumers or bindings. Most of the times `true` is recommended, but depends on the use case.\n\nSee: ",
"default": false,
"type": "boolean"
},
"exchange": {
"title": "Exchange",
"description": "The entity name where messages are retrieved (it will be created, or it must have a **topic** type if already exists).\n\nSee: ",
"examples": [
"some-exchange"
],
"type": "string"
},
"exclusive": {
"title": "Exclusive",
"description": "When `true`, AMQP will allow **a single KrakenD client** to access the queue. This option is **not recommended** in environments where the gateway needs high availability and you have several instances running.\n\nSee: ",
"default": false,
"type": "boolean"
},
"host": {
"title": "Host",
"description": "The connection string, ends in slash. E.g: `amqp://user:password@host:5672/`.\n\nSee: ",
"type": "string"
},
"nack_discard": {
"title": "NACK Discard",
"description": "When `true`, messages that cannot be processed are discarded instead of being sent back to the queue. This is useful for scenarios where you want to avoid reprocessing failed messages.\n\nSee: ",
"default": false,
"type": "boolean"
},
"name": {
"title": "Name",
"description": "The queue name.\n\nSee: ",
"type": "string"
},
"no_local": {
"title": "No local",
"description": "The no_local flag is not supported by RabbitMQ.\n\nSee: ",
"type": "boolean"
},
"no_wait": {
"title": "No wait",
"description": "When true, do not wait for the server to confirm the request and immediately begin deliveries. If it is not possible to consume, a channel exception will be raised and the channel will be closed.\n\nSee: ",
"type": "boolean"
},
"prefetch_count": {
"title": "Prefetch count",
"description": "The number of messages you want to prefetch prior to consume them.\n\nSee: ",
"default": 10,
"type": "integer"
},
"prefetch_size": {
"title": "Prefetch size",
"description": "The number of bytes you want to use to prefetch messages.\n\nSee: ",
"default": 0,
"type": "integer"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/messaging/kafka/async_reader.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Kafka Reader",
"description": "Enterprise only. Defines how to read messages from a Kafka cluster for an async agent",
"type": "object",
"required": [
"cluster"
],
"properties": {
"cluster": {
"title": "Cluster connection details",
"description": "Settings to stablish the connection to the kafka cluster",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1cluster.json",
"type": "object"
},
"group": {
"title": "Consumer group options",
"description": "Details about the consumer croup",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1group.json",
"type": "object"
},
"key_meta": {
"title": "Key Meta Name",
"description": "Name of the header where the kafka message key value is written",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/async_agent.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Async Agents",
"description": "Async agents are routines listening to queues or PubSub systems that react to new events and push data to your backends. Through async agents, you can start a lot of consumers to process your events autonomously.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"consumer",
"backend",
"extra_config"
],
"properties": {
"backend": {
"title": "Backend definition",
"description": "The [backend definition](https://www.krakend.io/docs/backends/) (as you might have in any endpoint) indicating where the event data is sent. It is a full backend object definition, with all its possible options, transformations, filters, validations, etc.",
"type": "array",
"items": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend.json"
}
},
"connection": {
"title": "Connection",
"description": "A key defining all the connection settings between the agent and your messaging system.\n\nSee: ",
"type": "object",
"properties": {
"backoff_strategy": {
"title": "Backoff strategy",
"description": "When the connection to your event source gets interrupted for whatever reason, KrakenD keeps trying to reconnect until it succeeds or until it reaches the `max_retries`. The backoff strategy defines the delay in seconds in between consecutive failed retries.\n\nSee: ",
"default": "fallback",
"enum": [
"linear",
"linear-jitter",
"exponential",
"exponential-jitter",
"fallback"
]
},
"health_interval": {
"title": "Health interval",
"description": "The time between pings checking that the agent is connected to the queue and alive. Regardless of the health interval, if an agent fails, KrakenD will restart it again immediately as defined by `max_retries`and `backoff_strategy`.\n\nSee: ",
"default": "1s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit"
},
"max_retries": {
"title": "Max retries",
"description": "The maximum number of times you will allow KrakenD to retry reconnecting to a broken messaging system. Use 0 for unlimited retries.\n\nSee: ",
"default": 0,
"type": "integer"
}
}
},
"consumer": {
"title": "Consumer",
"description": "Defines all the settings for each agent consuming messages.\n\nSee: ",
"required": [
"topic"
],
"properties": {
"max_rate": {
"title": "Max Rate",
"description": "The maximum number of messages you allow each worker to consume per second. Use any of `0` or `-1` for unlimited speed.\n\nSee: ",
"default": 0,
"type": "number"
},
"timeout": {
"title": "Timeout",
"description": "The maximum time the agent will wait to process an event sent to the backend. If the backend fails to process it, the message is reinserted for later consumption. Defaults to the timeout in the root level, or to `2s` if no value is declared.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit"
},
"topic": {
"title": "Topic",
"description": "The topic name you want to consume. The syntax depends on the driver. Examples for AMQP: `*`, `mytopic`, `lazy.#`, `*`, `foo.*`.\n\nSee: ",
"type": "string"
},
"workers": {
"title": "Workers",
"description": "The number of workers (consuming processes) you want to start simultaneously for this agent.\n\nSee: ",
"default": 1,
"type": "integer"
}
},
"type": "object"
},
"encoding": {
"title": "Backend Encoding",
"description": "Informs KrakenD how to parse the responses of your services.\n\nSee: ",
"default": "json",
"enum": [
"json",
"safejson",
"xml",
"rss",
"string",
"no-op"
]
},
"extra_config": {
"description": "Defines the driver that connects to your queue or PubSub system. In addition, you can place other middlewares to modify the request (message) or the response, apply logic or any other endpoint middleware, but adding the driver is mandatory.\n\nSee: ",
"oneOf": [
{
"required": [
"async/amqp"
]
},
{
"required": [
"async/kafka"
]
}
],
"properties": {
"async/amqp": {
"title": "Async Agent extra configuration",
"description": "[See the configuration for async/amqp](https://www.krakend.io/docs/async/amqp/)",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1async~1amqp.json"
},
"async/kafka": {
"title": "Kafka driver",
"description": "config details to consume from kafka topics",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1messaging~1kafka~1async_reader.json"
}
},
"type": "object"
},
"name": {
"title": "Name",
"description": "A unique name for this agent. KrakenD shows it in the health endpoint and logs and metrics. KrakenD does not check collision names, so make sure each agent has a different name.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"https://www.krakend.io/schema/v2.13/ai/mcp_endpoint.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "MCP endpoint",
"description": "Enterprise only. Declares the current endpoint as an MCP server entry point. \n\nSee: ",
"type": "object",
"required": [
"server_name"
],
"properties": {
"server_name": {
"title": "Server name",
"description": "The MCP server you want to attach to this endpoint. When you add this namespace, the endpoint becomes the MCP server entry point URL. The name used must match the name in the `ai/mcp` configuration in the root level.\n\nSee: ",
"examples": [
"stories-tracker"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/basic.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Basic Authentication",
"description": "Enterprise only. The Basic Authentication component protects the access to selected endpoints using basic username and password credentials.\n\nSee: ",
"type": "object",
"properties": {
"htpasswd_path": {
"title": "Path to htpasswd file",
"description": "Absolute Path to the `htpasswd` filename (recommended) or relative `./` to the workdir (less secure).\n\nSee: ",
"examples": [
"/path/to/.htpasswd"
],
"type": "string"
},
"users": {
"title": "Additional users",
"description": "**Additional** users to the `htpasswd` file can be declared directly inside the configuration. The content of both places will be merged (and this list will overwrite users already defined in the htpasswd file). The key of each entry is the username, and the value the bcrypt.\n\nSee: ",
"examples": [
{
"admin": "$2y$05$HpdPmv2Z3h3skMCVaf/CEep/UUBuhZ...",
"user2": "$2y$05$HpdPmv2Z3h3skMCVaf/CEep/UUBuhZ..."
}
],
"type": "object",
"additionalProperties": false,
"patternProperties": {
"(.*)": {
"type": "string"
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/signer.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "JWT signer",
"description": "creates a wrapper for your login endpoint that signs with your secret key the selected fields of the backend payload right before returning the content to the end-user.\n\nSee: ",
"type": "object",
"oneOf": [
{
"required": [
"alg",
"jwk_local_path",
"disable_jwk_security"
]
},
{
"required": [
"alg",
"jwk_url"
]
}
],
"required": [
"alg",
"kid",
"keys_to_sign"
],
"properties": {
"alg": {
"title": "Algorithm",
"description": "The hashing algorithm used by the issuer. Usually `RS256`. The algorithm you choose directly affects the CPU consumption.\n\nSee: ",
"enum": [
"EdDSA",
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
]
},
"cipher_suites": {
"title": "Cipher suites",
"description": "Override the default cipher suites (see [JWT validation](https://www.krakend.io/docs/authorization/jwt-signing/)). Unless you have a legacy JWK, **you don't need to set this value**.",
"default": [
49199,
49195,
49200,
49196,
52392,
52393
],
"type": "array",
"items": {
"title": "Object in array",
"description": "See: ",
"enum": [
5,
10,
47,
53,
60,
156,
157,
49159,
49161,
49162,
49169,
49170,
49171,
49172,
49187,
49191,
49199,
49195,
49200,
49196,
52392,
52393
]
}
},
"cypher_key": {
"title": "Cypher key",
"description": "The cyphering key.\n\nSee: ",
"type": "string"
},
"disable_jwk_security": {
"title": "Disable_jwk_security",
"description": "Disables HTTP security of the JWK client and allows insecure connections (plain HTTP) to download the keys. The flag should be `false` when you use HTTPS, and `true` when using plain HTTP or loading the key from a local file.\n\nSee: ",
"default": false,
"type": "boolean"
},
"full": {
"title": "Full format",
"description": "Use JSON format instead of the compact form JWT provides.\n\nSee: ",
"default": false,
"type": "boolean"
},
"jwk_fingerprints": {
"title": "JWK Fingerprints",
"description": "A list of fingerprints (the unique identifier of the certificate) for certificate pinning and avoid man in the middle attacks. Add fingerprints in base64 format.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"jwk_local_ca": {
"title": "Local CA",
"description": "Path to the CA’s certificate verifying a secure connection when downloading the JWK. Use when not recognized by the system (e.g., self-signed certificates).\n\nSee: ",
"type": "string"
},
"jwk_local_path": {
"title": "JWK local path",
"description": "Local path to the JWK public keys, has preference over `jwk_url`. Instead of pointing to an external URL (with `jwk_url`), public keys are kept locally, in a plain JWK file (security alert!), or encrypted. When encrypted, also add `secret_url` and `cypher_key`.\n\nSee: ",
"examples": [
"./jwk.txt"
],
"type": "string"
},
"jwk_url": {
"title": "JWK URL",
"description": "The URL to the JWK endpoint with the private keys used to sign the token.\n\nSee: ",
"examples": [
"http://your-backend/jwk/symmetric.json"
],
"type": "string"
},
"keys_to_sign": {
"title": "Keys to sign",
"description": "List of all the specific keys that need signing (e.g., `refresh_token` and `access_token`).\n\nSee: ",
"examples": [
[
"access_token",
"refresh_token"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"kid": {
"title": "Kid",
"description": "The key ID purpose is to match a specific key, as the jwk_url might contain several keys.\n\nSee: ",
"examples": [
"sim2"
],
"type": "string"
},
"leeway": {
"title": "Leeway",
"description": "A margin of extra time where you will still accept the token after its expiration date. You should not accept expired tokens other than enabling two environments that are not perfectly synchronized and have minor clock drifts to accept each other differences. Any value specified here will be rounded to seconds, with a minimum of one second.\n\nSee: ",
"examples": [
"1m",
"1s"
],
"default": "1s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"secret_url": {
"title": "Secret's URL",
"description": "An URL with a custom scheme using one of the supported providers (e.g.: `awskms://keyID`) ([see providers](https://www.krakend.io/docs/authorization/jwt-validation/#accepted-providers-for-encrypting-payloads)).\n\nSee: ",
"examples": [
"base64key://smGbjm71Nxd1Ig5FS0wj9SlbzAIrnolCz9bQQ6uAhl4=",
"awskms://keyID",
"azurekeyvault://keyID",
"gcpkms://projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEY_RING]/cryptoKeys/[KEY]",
"hashivault://keyID"
],
"type": "string",
"pattern": "(base64key|awskms|azurekeyvault|gcpkms|hashivault)://(.*)"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/validator.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "JWT validator",
"description": "Protect endpoints from public usage by validating JWT tokens generated by any industry-standard OpenID Connect (OIDC) integration.\n\nSee: ",
"type": "object",
"oneOf": [
{
"required": [
"alg",
"jwk_local_path"
]
},
{
"required": [
"alg",
"jwk_url"
]
}
],
"properties": {
"alg": {
"title": "Algorithm",
"description": "The hashing algorithm used by the token issuer.\n\nSee: ",
"default": "RS256",
"enum": [
"EdDSA",
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
]
},
"audience": {
"title": "Audience",
"description": "Reject tokens that do not contain ALL audiences declared in the list.\n\nSee: ",
"examples": [
[
"audience1"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"auth_header_name": {
"title": "Authorization header",
"description": "Allows to parse the token from a custom header.\n\nSee: ",
"examples": [
"X-Custom-Auth"
],
"default": "Authorization",
"type": "string"
},
"cache": {
"title": "Cache",
"description": "Set this value to `true` (recommended) to stop downloading keys on every request and store them in memory for the next `cache_duration` period and avoid hammering the key server, as recommended for performance. Do not use this flag when using `jwk_local_ca`.\n\nSee: ",
"default": false,
"type": "boolean"
},
"cache_duration": {
"title": "Cache duration",
"description": "The cache duration in seconds when the `cache` is enabled. 15 minutes when unset.\n\nSee: ",
"default": 900,
"type": "integer"
},
"cipher_suites": {
"title": "Cipher suites",
"description": "Override the default cipher suites. Use it if you want to enforce an even higher security standard.\n\nSee: ",
"default": [
49199,
49195,
49200,
49196,
52392,
52393
],
"type": "array",
"items": {
"title": "Object in array",
"description": "See: ",
"enum": [
5,
10,
47,
53,
60,
156,
157,
49159,
49161,
49162,
49169,
49170,
49171,
49172,
49187,
49191,
49199,
49195,
49200,
49196,
52392,
52393
]
}
},
"cookie_key": {
"title": "Cookie key",
"description": "Add the key name of the cookie containing the token when it is not passed in the headers\n\nSee: ",
"examples": [
"cookie_jwt"
],
"type": "string"
},
"cypher_key": {
"title": "Cypher key",
"description": "The cyphering key.\n\nSee: ",
"type": "string"
},
"disable_jwk_security": {
"title": "Disable_jwk_security",
"description": "When true, disables security of the JWK client and allows insecure connections (plain HTTP) to download the keys. Useful for development environments.\n\nSee: ",
"default": false,
"type": "boolean"
},
"failed_jwk_key_cooldown": {
"title": "Failed JWK Key cooldown",
"description": "When a request comes with a token declaring an unknown `kid` (or the key strategy you choose), and the JWK is in a remote destination, KrakenD downloads the JWK from the Identity Provider for its recognition. Suppose there is a network failure, or the key is not in the list (e.g., you rotated the keys without anticipation). In that case, you can tell the gateway not to contact the Identity Provider again during the time specified here. We recommend setting this value, even with a low time (e.g., `10s`), to prevent misconfigurations from hammering your Identity Providers. Any values under one second are ignored.\n\nSee: ",
"examples": [
"1m",
"10s",
"1h"
],
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"issuer": {
"title": "Issuer",
"description": "When set, tokens not matching the issuer are rejected.\n\nSee: ",
"examples": [
"issuer"
],
"type": "string"
},
"jwk_fingerprints": {
"title": "Roles",
"description": "A list of fingerprints (the certificate's unique identifier) for certificate pinning and avoid man-in-the-middle attacks. Add fingerprints in base64 format.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"jwk_local_ca": {
"title": "Local CA",
"description": "Path to the CA's certificate verifying a secure connection when downloading the JWK. Use when not recognized by the system (e.g., self-signed certificates).\n\nSee: ",
"type": "string"
},
"jwk_local_path": {
"title": "JWK local path",
"description": "Local path to the JWK public keys, has preference over `jwk_url`. Instead of pointing to an external URL (with `jwk_url`), public keys are kept locally, in a plain JWK file (security alert!), or encrypted. When encrypted, also add `secret_url` and `cypher_key`.\n\nSee: ",
"examples": [
"./jwk.txt"
],
"type": "string"
},
"jwk_url": {
"title": "JWK URL",
"description": "The URL to the JWK endpoint with the public keys used to verify the token's authenticity and integrity. Use with `cache` to avoid re-downloading the key on every request. Consider enabling [shared caching](https://www.krakend.io/docs/authorization/jwk-caching/) too. The identity server will receive an HTTP(s) request from KrakenD with a KrakenD user agent, and the identity server must reply with a JSON object and a content-type `application/jwk-set+json` or `application/json`.\n\nSee: ",
"examples": [
"https://some-domain.auth0.com/.well-known/jwks.json",
"http://KEYCLOAK:8080/auth/realms/master/protocol/openid-connect/certs",
"https://yourOktaBaseUrl/v1/keys"
],
"type": "string"
},
"key_identify_strategy": {
"title": "Key identify strategy",
"description": "Allows strategies other than `kid` to load keys.\n\nSee: ",
"enum": [
"kid",
"x5t",
"x5t#S256",
"kid_x5t"
]
},
"leeway": {
"title": "Leeway",
"description": "A margin of time where you will accept an already expired token. You should not accept expired tokens other than enabling two environments that are not perfectly synchronized and have minor clock drifts to accept each other differences. Any value specified here will be rounded to seconds, with a minimum of one second.\n\nSee: ",
"examples": [
"1m",
"1s"
],
"default": "1s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"operation_debug": {
"title": "Debug",
"description": "When `true`, any JWT **validation operation** gets printed in the log with a level `ERROR`. You will see if a client does not have sufficient roles, the allowed claims, scopes, and other useful information.\n\nSee: ",
"default": false,
"type": "boolean"
},
"propagate_claims": {
"title": "Claims to propagate",
"description": "Enables passing claims in the backend's request header. You can pass nested claims using the dot `.` operator. E.g.: `realm_access.roles`.\n\nSee: ",
"type": "array",
"items": {
"type": "array",
"maxItems": 2,
"minItems": 2,
"items": {
"type": "string"
}
}
},
"propagate_claims_preserve_array": {
"title": "Preserve array structure",
"description": "When set to `true`, the JWT claims that are propagated to the backend will preserve their array structure as multi-value headers, if applies. If set to `false`, arrays will be converted to comma-separated strings.\n\nSee: ",
"default": false,
"type": "boolean"
},
"roles": {
"title": "Roles",
"description": "When set, the JWT token not having at least one of the listed roles is rejected.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"roles_key": {
"title": "Roles key",
"description": "When validating users through roles, provide the key name inside the JWT payload that lists their roles. If this key is nested inside another object, add `roles_key_is_nested` and use the dot notation `.` to traverse each level. E.g.: `resource_access.myclient.roles` represents the payload `{resource_access: { myclient: { roles: [\"myrole\"] } }`. Notice that the roles object you choose is a list, not a map.\n\nSee: ",
"examples": [
"resource_access.myclient.roles"
],
"type": "string"
},
"roles_key_is_nested": {
"title": "Roles key is nested",
"description": "If the roles key uses a nested object using the `.` dot notation, you must set it to `true` to traverse the object.\n\nSee: ",
"type": "boolean"
},
"scopes": {
"title": "Scopes",
"description": "A list of scopes to validate. The token, after decoding it, can have the scopes declared as a space-separated list, e.g.: `\"my_scopes\": \"resource1:action1 resource3:action7\"` or inside a list, e.g.: `\"my_scopes\": [\"resource1:action1\",\"resource3:action7\"]`.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"scopes_key": {
"title": "Scopes key",
"description": "The key name where KrakenD can find the scopes. The key can be a nested object using the `.` dot notation, e.g.: `data.access.my_scopes`.\n\nSee: ",
"type": "string"
},
"scopes_matcher": {
"title": "Scopes matcher",
"description": "Defines if the user needs to have in its token at least one of the listed claims (`any`), or `all` of them.\n\nSee: ",
"default": "any",
"enum": [
"any",
"all"
]
},
"secret_url": {
"title": "Secret's URL",
"description": "An URL with a custom scheme using one of the supported providers (e.g.: `awskms://keyID`) (see providers).\n\nSee: ",
"examples": [
"base64key://smGbjm71Nxd1Ig5FS0wj9SlbzAIrnolCz9bQQ6uAhl4=",
"awskms://keyID",
"azurekeyvault://keyID",
"gcpkms://projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEY_RING]/cryptoKeys/[KEY]",
"hashivault://keyID"
],
"type": "string",
"pattern": "(base64key|awskms|azurekeyvault|gcpkms|hashivault)://(.*)"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/documentation/openapi.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Generate documentation using OpenAPI",
"description": "Enterprise only. Generates OpenAPI documentation automatically through `krakend openapi export` command.\n\nSee: ",
"type": "object",
"properties": {
"description": {
"title": "API Description",
"description": "An introductory, optionally verbose, explanation supporting [CommonMark](http://commonmark.org/help/) syntax. If you'd like to load an **external markdown file**, you can use flexible configuration, for instance `\"description\": {{include \"openapi/intro.md\" | toJson }}`\n\nSee: ",
"examples": [
"Hi there, I am [OpenAPI](https://www.krakend.io/docs/enterprise/endpoints/openapi/)"
],
"type": "string"
},
"audience": {
"title": "Audience",
"description": "The list of audiences that will consume this endpoint. These values **do not define the gateway logic** in any way. They are a way to group endpoints and filter them out when generating the OpenAPI documentation. Use `*` to indicate an endpoint will be present in any audience generated.\n\nSee: ",
"examples": [
[
"gold",
"silver",
"*"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"base_path": {
"title": "Base path",
"description": "A starting path that is appended to any endpoint.\n\nSee: ",
"examples": [
"/v1"
],
"type": "string"
},
"components_schemas": {
"title": "Component Schemas",
"description": "The JSON Schemas you can reuse inside endpoint definitions using `ref`. You can either pass the JSON Schema object, or a bas64 string.",
"examples": [
{
"Pet": {
"type": "object",
"required": [
"id",
"name"
]
}
}
],
"type": "object",
"patternProperties": {
".*": {
"title": "JSON Schema",
"description": "JSON Schema in base64 or as an object",
"type": [
"string",
"object"
]
}
}
},
"contact_email": {
"title": "Contact email",
"description": "Email where users of your API can write to.\n\nSee: ",
"examples": [
"/v1"
],
"type": "string"
},
"contact_name": {
"title": "Contact name",
"description": "Contact name.\n\nSee: ",
"examples": [
"/v1"
],
"type": "string"
},
"contact_url": {
"title": "Contact URL",
"description": "Contact URL that users of your API can read.\n\nSee: ",
"examples": [
"/v1"
],
"type": "string"
},
"cookie_name": {
"title": "Cookie name",
"description": "When generating an OpenAPI spec, the name of the cookie used under components securitySchemes.",
"default": "SESSIONID",
"type": "string"
},
"custom_security_schemes": {
"title": "Custom security schemes",
"description": "Allows you to add custom security schemes under `components/securitySchemes` in the generated OpenAPI spec. This is useful when you want to define your own security schemes, different from the built-in ones (e.g., `jwt`, `apikey`, `cookie`, etc.). When the property is in the service level you must declare the schema (e.g., `\"OAuth2Security\":{...}`), and when it is in the endpoint you should only write the object name with not properties inside, e.g, `{\"OAuth2Security\":{}`.\n\nSee: ",
"examples": [
{
"OAuth2Security": {
"description": "OAuth2 security scheme",
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://example.com/oauth/authorize",
"scopes": {},
"tokenUrl": "https://example.com/oauth/token"
}
}
}
}
],
"type": "object",
"patternProperties": {
"^.*$": {
"title": "Security Scheme",
"description": "A valid OpenAPI Security Scheme object.",
"type": "object"
}
}
},
"disable_default_response_definitions": {
"title": "Disable default response definitions",
"description": "By default, KrakenD adds a `500` and a `200` response definition to each endpoint. Set this property to `true` if you want to avoid this behavior.\n\nSee: ",
"default": false,
"type": "boolean"
},
"example": {
"title": "Example",
"description": "**Deprecated in OAS3** (use `response_definition` instead). A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.\n\nSee: ",
"type": [
"object",
"string"
]
},
"header_definition": {
"title": "Header definition",
"description": "Sets a detailed description for the headers allowed in the endpoint. Make sure to include the same headers in the endpoint's `input_headers`.\n\nSee: ",
"examples": [
[
{
"description": "The type of content",
"name": "Content-Type"
}
]
],
"type": "array",
"items": {
"title": "Headers definition",
"type": "object",
"required": [
"name"
],
"properties": {
"description": {
"title": "Name",
"description": "The description of the header",
"examples": [
"The Content-Type sets the encoding of the request"
],
"type": "string"
},
"type": {
"title": "Type",
"description": "The type of data according to the OpenAPI spec",
"examples": [
"string"
],
"default": "string",
"enum": [
"integer",
"string",
"boolean",
"object",
"array",
"float",
"date-time"
]
},
"enum": {
"title": "Enum",
"description": "The allowed values for this header",
"examples": [
[
"application/json",
"application/xml"
]
],
"type": "array",
"items": {
"type": [
"array",
"boolean",
"integer",
"number",
"object",
"string"
]
}
},
"required": {
"title": "Required",
"description": "Set to `true` when this query string is required",
"default": false,
"type": "boolean"
},
"hide": {
"title": "Hide header",
"description": "Avoids this header from showing in the generated documentation",
"default": false,
"type": "boolean"
},
"name": {
"title": "Name",
"description": "The name of the header, as declared in `input_headers`",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"host": {
"title": "Host",
"description": "The hostname where you will publish your API.\n\nSee: ",
"examples": [
"my.api.com"
],
"type": "string"
},
"jwt_key": {
"title": "JWT key",
"description": "When generating an OpenAPI spec, the name of the JWT key used under components securitySchemes.",
"default": "KrakenD-JWT",
"type": "string"
},
"license_name": {
"title": "License name",
"description": "The license name (e.g.: Apache License)\n\nSee: ",
"examples": [
"/v1"
],
"type": "string"
},
"license_url": {
"title": "License URL",
"description": "The URL where the license is hosted\n\nSee: ",
"examples": [
"/v1"
],
"type": "string"
},
"operation_id": {
"title": "Operation ID",
"description": "A unique string identifying the operation identifier. Usually the method + the endpoint. If provided, these IDs must be unique among all operations described in your API.\n\nSee: ",
"examples": [
"GET/foo"
],
"type": "string"
},
"param_definition": {
"title": "Param definition",
"description": "Sets a detailed description for the URL parameters (e.g.: `/foo/{param}`) required in the endpoint. Make sure to include to write the param exactly as in the endpoint definition.\n\nSee: ",
"examples": [
[
{
"description": "The unique user ID",
"name": "id_user"
}
]
],
"type": "array",
"items": {
"title": "Parameters",
"type": "object",
"required": [
"name"
],
"properties": {
"description": {
"title": "Name",
"description": "The description of the parameter",
"type": "string"
},
"examples": {
"title": "Examples",
"description": "Guess what? Multiple example values for this parameter.",
"type": "object",
"patternProperties": {
"^.*$": {
"type": [
"string",
"number",
"boolean",
"array",
"object"
]
}
}
},
"type": {
"title": "Type",
"description": "The type of data according to the OpenAPI spec",
"examples": [
"string"
],
"default": "string",
"enum": [
"integer",
"number",
"string",
"boolean",
"object",
"array",
"float",
"date-time"
]
},
"enum": {
"title": "Enum",
"description": "The allowed values for this parameter",
"examples": [
[
"application/json",
"application/xml"
]
],
"type": "array",
"items": {
"type": [
"array",
"boolean",
"integer",
"number",
"object",
"string"
]
}
},
"format": {
"title": "Format",
"description": "The extending format for the previously defined type. If the type is `number` or `string` you can apply them one of the available formats. If you choose string formats for numbers or viceversa de linter does not check it.\n\nSee: ",
"enum": [
"int32",
"int64",
"float",
"double",
"date",
"date-time",
"byte",
"uuid",
""
]
},
"required": {
"title": "Required",
"description": "A path parameter is always mandatory on KrakenD, but you can still generate the OpenAPI documentation saying otherwise.",
"default": true,
"type": "boolean"
},
"example": {
"title": "Example",
"description": "An example value for this parameter. This example is injected in the spec as is.",
"type": [
"string",
"number",
"boolean",
"array",
"object"
]
},
"hide": {
"title": "Hide param",
"description": "Avoids this param from showing in the generated documentation, although is still part of the endpoint definition.",
"default": false,
"type": "boolean"
},
"name": {
"title": "Name",
"description": "The name of the parameter, as declared in `endpoint` without the curly braces `{}`",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"query_definition": {
"title": "Query definition",
"description": "Sets a detailed description for the query strings allowed in the endpoint. Make sure to include the same strings in the endpoint's `input_query_strings`.\n\nSee: ",
"examples": [
[
{
"description": "The number of the page",
"name": "page"
}
]
],
"type": "array",
"items": {
"title": "Query strings",
"type": "object",
"required": [
"name"
],
"properties": {
"description": {
"title": "Name",
"description": "The description of the querystring",
"type": "string"
},
"type": {
"title": "Type",
"description": "The type of data according to the OpenAPI spec",
"default": "string",
"enum": [
"integer",
"number",
"string",
"boolean",
"object",
"array",
"float",
"date-time"
]
},
"enum": {
"title": "Enum",
"description": "The allowed values for this query definition",
"type": "array",
"items": {
"type": [
"array",
"boolean",
"integer",
"number",
"object",
"string"
]
}
},
"format": {
"title": "Format",
"description": "The extending format for the previously defined type. If the type is `number` or `string` you can apply them one of the available formats. If you choose string formats for numbers or viceversa de linter does not check it.\n\nSee: ",
"enum": [
"int32",
"int64",
"float",
"double",
"date",
"date-time",
"byte",
"uuid",
""
]
},
"required": {
"title": "Required",
"description": "Set to `true` when this query string is required",
"default": true,
"type": "boolean"
},
"hide": {
"title": "Hide querystring",
"description": "Avoids this querystring from showing in the generated documentation",
"default": false,
"type": "boolean"
},
"name": {
"title": "Name",
"description": "The name of the querystring, as declared in `input_query_strings`",
"type": "string"
},
"example": {
"title": "Example",
"description": "A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.\n\nSee: ",
"type": [
"string",
"object",
"array",
"boolean",
"integer",
"null",
"number"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"request_definition": {
"title": "Definition of a request",
"description": "Describes the payload needed to consume the endpoint. If a JSON Schema validation exists, it takes precedence when generating the documentation. An example use case is when you need to document a `multipart/form-data` request body.This property is an array because you can document requests with multiple content types.\n\nSee: ",
"examples": [
[
{
"description": "Updates the user",
"content_type": "application/json",
"example": {
"first_name": "Mary",
"id_user": 33
}
}
]
],
"type": "array",
"items": {
"required": [
"content_type"
],
"properties": {
"description": {
"title": "Description",
"description": "The description of the payload this endpoint accepts.\n\nSee: ",
"type": "string"
},
"content_type": {
"title": "Content Type",
"description": "The content type returned by this error, e.g., `application/json`. You cannot repeat this content type in another item.",
"type": "string"
},
"example": {
"title": "Example",
"description": "A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.\n\nSee: ",
"type": [
"string",
"object",
"array",
"boolean",
"integer",
"null",
"number"
]
},
"examples": {
"title": "Examples",
"description": "A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.\n\nSee: ",
"examples": [
{
"Example 1": {
"msg": "a message"
}
},
{
"Example 1": {
"msg": "a message"
},
"Example 2": {
"error": "an error message"
}
}
],
"type": "object",
"additionalProperties": {
"title": "Example",
"type": [
"string",
"object",
"array",
"boolean",
"integer",
"null",
"number"
]
}
},
"example_schema": {
"description": "A JSON schema that describes the request format for the accepted payload in the endpoint. Use either example or example_schema, but not both.",
"type": [
"string",
"object"
]
},
"ref": {
"title": "Reference",
"description": "The relative reference to the `components/schema` OpenAPI definition that will be used as definition of the accepted request. Notice that the path `#/components/schemas/` is not needed.",
"examples": [
"your_schema_name"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
}
},
"response_definition": {
"title": "Definition of errors (OAS3 only)",
"description": "Describes the different status codes returned by this endpoint. Each key is the definition of the status code, represented by a string. E.g., `200` (success), `500` (internal error), etc.\n\nSee: ",
"examples": [
{
"404": {
"description": "Page not found",
"@comment": "Some comment",
"content_type": "application/json",
"example": {
"status": "KO"
}
}
}
],
"type": "object",
"additionalProperties": false,
"patternProperties": {
"default|^[0-9]+$": {
"type": "object",
"properties": {
"description": {
"title": "Description",
"description": "The description of this error code, e.g., `Page not found`.\n\nSee: ",
"type": "string"
},
"content_type": {
"title": "Content Type",
"description": "The content type returned by this error, e.g., `application/json`",
"type": "string"
},
"example": {
"title": "Example",
"description": "A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.\n\nSee: ",
"type": [
"string",
"object",
"array",
"boolean",
"integer",
"null",
"number"
]
},
"examples": {
"title": "Examples",
"description": "A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.\n\nSee: ",
"examples": [
{
"Example 1": {
"msg": "a message"
}
},
{
"Example 1": {
"msg": "a message"
},
"Example 2": {
"error": "an error message"
}
}
],
"type": "object",
"additionalProperties": {
"title": "Example",
"type": [
"string",
"object",
"array",
"boolean",
"integer",
"null",
"number"
]
}
},
"example_schema": {
"description": "A JSON schema that describes the response format for the endpoint, directly as a JSON object, or encoded as a base64 string. Use either example or example_schema, but not both.",
"type": [
"string",
"object"
]
},
"ref": {
"title": "Reference",
"description": "The relative reference to the `components/schema` OpenAPI definition that will be used as definition of the accepted request. Notice that the path `#/components/schemas/` is not needed.",
"examples": [
"your_schema_name"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"schemes": {
"title": "Supported schemes",
"description": "The list of schemes supported by the API, e.g. `http` or `https`\n\nSee: ",
"examples": [
[
"https",
"http"
]
],
"default": [
"http"
],
"type": "array",
"items": {
"type": "string"
}
},
"servers": {
"title": "Servers",
"description": "The list of servers where the API is hosted. The server URL can be a relative path, e.g., `/v1` or an absolute path. The URL might contain `{variables}`, although these are only recognized by OpenAPI and to KrakenD they are just literal strings because it does not use them.\n\nSee: ",
"examples": [
[
{
"url": "/v1"
}
],
[
{
"url": "https://example.com:{port}",
"variables": {
"port": {
"default": "8443",
"enum": [
"8443",
"443"
]
}
}
}
]
],
"type": "array",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"description": {
"title": "Description",
"description": "A short description of the server URL.",
"type": "string"
},
"url": {
"title": "URL",
"description": "The URL of the server. This URL will be used as the base path for all endpoints.",
"type": [
"string",
"object"
]
},
"variables": {
"title": "Variables",
"description": "A [Server Variable Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-variable-object) according to the OpenAPI specification. The variable name is the key and the value is the default value for that variable.",
"type": "object",
"patternProperties": {
"^.*$": {
"type": [
"string",
"object"
]
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"summary": {
"title": "Summary",
"description": "A short summary for the endpoint. Use the description field for the longest explanation.\n\nSee: ",
"type": "string"
},
"tag_definition": {
"title": "Tag definition",
"description": "Sets a detailed description for the tags classifiying endpoints when generating the OpenAPI spec.\n\nSee: ",
"examples": [
[
{
"description": "Description of tag1",
"name": "Tag1"
}
]
],
"type": "array",
"items": {
"title": "Tags",
"type": "object",
"required": [
"name"
],
"properties": {
"description": {
"title": "Tag Description",
"description": "Describe what this tag is grouping",
"type": "string"
},
"name": {
"title": "Tag name",
"description": "The name of the tag. You will use this name in each endpoint.",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"tags": {
"title": "Tags",
"description": "You can assign a list of tags to each API operation. If you declare tags in the `tag_definition` at the OpenAPI service level, they will have a description in the documentation. Tagged operations may be handled differently by tools and libraries. For example, Swagger UI uses tags to group the displayed operations.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"terms_of_service": {
"title": "Terms of Service",
"description": "The URL to the terms of service for using this API.\n\nSee: ",
"examples": [
"/v1"
],
"type": "string"
},
"version": {
"title": "Version",
"description": "The version numbering you want to apply to this release of API., e.g.: `1.0`.\n\nSee: ",
"examples": [
"1.0"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/documentation/postman_endpoint.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Generate documentation using Postman collections",
"description": "Enterprise only. Generates postman documentation automatically through `krakend postman export` command.\n\nSee: ",
"type": "object",
"properties": {
"description": {
"title": "Endpoint description",
"description": "An introductory, optionally verbose, explanation supporting Markdown syntax. If you'd like to load an **external markdown file**, you can use flexible configuration, for instance `\"description\": {{include \"postman/intro.md\" | toJson }}`\n\nSee: ",
"examples": [
"Hi there, I am a [postman endpoint](https://www.krakend.io/docs/enterprise/developer/postman/)"
],
"type": "string"
},
"folder": {
"title": "Folder",
"description": "The folder name where you want to put this endpoint. If you defined folders at the service level, use the same name to reuse their name and description",
"examples": [
"/Books"
],
"type": "string"
},
"name": {
"title": "Endpoint Name",
"description": "The name of the endpoint you are generating. If you don't set any name the last member path is used.\n\nSee: ",
"examples": [
"List books",
"Create user"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/modifier/request-body-extractor.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Request Body Extractor",
"description": "Enterprise only. Extracts fields from the incoming request body and promotes them to request headers or query strings.\n\nSee: ",
"type": "object",
"required": [
"operations"
],
"properties": {
"operations": {
"title": "Operations",
"description": "A list of extraction operations to apply. Each operation extracts a value from the request body and writes it to a header or query string parameter. Operations are evaluated in sequential order.\n\nSee: ",
"type": "array",
"items": {
"title": "Operation",
"description": "Defines a single extraction rule that reads a field from the request body and writes it to a header or query string parameter.\n\nSee: ",
"type": "object",
"required": [
"type",
"strategy",
"expression",
"target",
"on_conflict"
],
"properties": {
"type": {
"title": "Type",
"description": "The destination where the extracted value is written. Use `header` to inject the value as a request header, or `query_string` to inject it as a query string parameter.\n\nSee: ",
"enum": [
"header",
"query_string"
]
},
"strategy": {
"title": "Strategy",
"description": "The strategy used to navigate the request body and extract the value. Use `dotnotation` for straightforward field access using period-separated field names (e.g., `user.id`). Use `jmespath` to evaluate a JMESPath expression for more complex selections involving arrays, filtering, or projections.\n\nSee: ",
"enum": [
"dotnotation",
"jmespath"
]
},
"expression": {
"title": "Expression",
"description": "The expression that selects the value from the request body. When using the `dotnotation` strategy, use period-separated field names (e.g., `user.id`). When using `jmespath`, provide a valid JMESPath expression.\n\nSee: ",
"examples": [
"user.id",
"auth.role_key",
"data.items[0].name"
],
"type": "string"
},
"target": {
"title": "Target",
"description": "The name of the destination header or query string parameter where the extracted value is written.\n\nSee: ",
"examples": [
"Authorization",
"uid",
"X-Tenant-Id"
],
"type": "string"
},
"on_conflict": {
"title": "On Conflict",
"description": "Controls behaviour when the destination header or query string parameter already has a value. `skip` preserves the existing value and discards the extracted one. `replace` overwrites the existing value. `append` adds the extracted value alongside the existing one.\n\nSee: ",
"enum": [
"skip",
"replace",
"append"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/qos/ratelimit/router.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Endpoint ratelimit",
"type": "object",
"anyOf": [
{
"required": [
"max_rate"
]
},
{
"required": [
"client_max_rate"
]
}
],
"properties": {
"capacity": {
"title": "Capacity",
"description": "Defines the maximum number of [tokens a bucket can hold](https://www.krakend.io/docs/throttling/token-bucket/), or said otherwise, how many requests will you accept from **all users together** at **any given instant**. When the gateway starts, the bucket is full. As requests from users come, the remaining tokens in the bucket decrease. At the same time, the `max_rate` refills the bucket at the desired rate until its maximum capacity is reached. The default value for the `capacity` is the `max_rate` value expressed in seconds or 1 for smaller fractions. When unsure, use the same number as `max_rate`.\n\nSee: ",
"default": 1,
"type": "integer"
},
"cleanup_period": {
"title": "Cleanup Period",
"description": "The cleanup period is how often the routine(s) in charge of optimizing the memory dedicated will go iterate all counters looking for outdated TTL and remove them. A low value keeps the memory slightly decreasing, but as a trade-off, it will increase the CPU dedicated to achieving this optimization. This is an advanced micro-optimization setting that should be used with caution.\n\nSee: ",
"default": "1m",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"cleanup_threads": {
"title": "Cleanup Threads",
"description": "These are the number of routines that search for and remove outdated rate limit counters. The more routine(s) you add, the faster the memory optimization is completed, but the more CPU it will consume. Generally speaking, a single thread is more than enough because the delete operation is very fast, even with a large number of counters. This is an advanced micro-optimization setting that you should use with caution.\n\nSee: ",
"default": 1,
"type": "integer"
},
"client_capacity": {
"title": "Client capacity",
"description": "Defines the maximum number of [tokens a bucket can hold](https://www.krakend.io/docs/throttling/token-bucket/), or said otherwise, how many requests will you accept from **each individual user** at **any given instant**. Works just as `capacity`, but instead of having one bucket for all users, keeps a counter for every connected client and endpoint, and refills from `client_max_rate` instead of `max_rate`. The client is recognized using the `strategy` field (an IP address, a token, a header, etc.). The default value for the `client_capacity` is the `client_max_rate` value expressed in seconds or 1 for smaller fractions. When unsure, use the same number as `client_max_rate`.\n\nSee: ",
"default": 1,
"type": "integer"
},
"client_max_rate": {
"title": "Client max rate",
"description": "Number of tokens you add to the [Token Bucket](https://www.krakend.io/docs/throttling/token-bucket/) for each individual user (*user quota*) in the time interval you want (`every`). The remaining tokens in the bucket are the requests a specific user can do. It keeps a counter for every client and endpoint. Keep in mind that every KrakenD instance keeps its counters in memory for **every single client**.\n\nSee: ",
"type": "number"
},
"every": {
"title": "Time window",
"description": "Time period in which the maximum rates operate. For instance, if you set an `every` of `10m` and a rate of `5`, you are allowing 5 requests every ten minutes.\n\nSee: ",
"default": "1s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"key": {
"title": "Header or Param key",
"description": "Available when using `client_max_rate` and you have set a `strategy` equal to `header` or `param`. It makes no sense in other contexts. For `header` it is the header name containing the user identification (e.g., `Authorization` on tokens, or `X-Original-Forwarded-For` for IPs). When they contain a list of space-separated IPs, it will take the IP from the client that hit the first trusted proxy. For `param` it is the name of the placeholder used in the endpoint, like `id_user` for an endpoint `/user/{id_user}`.\n\nSee: ",
"examples": [
"X-Tenant",
"Authorization",
"id_user"
],
"type": "string"
},
"max_rate": {
"title": "Max rate",
"description": "Sets the maximum number of requests all users can do in the given time frame. Internally uses the [Token Bucket](https://www.krakend.io/docs/throttling/token-bucket/) algorithm. The absence of `max_rate` in the configuration or a `0` is the equivalent to no limitation. You can use decimals if needed.\n\nSee: ",
"type": "number"
},
"num_shards": {
"title": "Num Shards",
"description": "All rate limit counters are stored in memory in groups (shards). All counters in the same shard share a mutex (which controls that one counter is modified at a time), and this helps with contention. Having, for instance, 2048 shards (default) and 1M users connected concurrently (same instant) means that each user will need to coordinate writes in their counter with an average of under 500 other users (1M/2048=489). Lowering the shards might increase contention and latency but free additional memory. This is an advanced micro-optimization setting that should be used with caution.\n\nSee: ",
"default": 2048,
"type": "integer"
},
"strategy": {
"title": "Strategy",
"description": "Available when using `client_max_rate`. Sets the strategy you will use to set client counters. Choose `ip` when the restrictions apply to the client's IP address, or set it to `header` when there is a header that identifies a user uniquely. That header must be defined with the `key` entry.\n\nSee: ",
"enum": [
"ip",
"header",
"param"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/qos/ratelimit/redis.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Redis-backed Rate Limit",
"description": "Enterprise only. Redis-backed service ratelimit",
"type": "object",
"anyOf": [
{
"required": [
"connection_pool",
"max_rate"
]
},
{
"required": [
"connection_pool",
"client_max_rate"
]
},
{
"required": [
"connection_name",
"max_rate"
]
},
{
"required": [
"connection_name",
"client_max_rate"
]
}
],
"properties": {
"capacity": {
"title": "Capacity",
"description": "Defines the maximum number of [tokens a bucket can hold](https://www.krakend.io/docs/throttling/token-bucket/), or said otherwise, how many requests will you accept from **all users together** at **any given instant**. When the gateway starts, the bucket is full. As requests from users come, the remaining tokens in the bucket decrease. At the same time, the `max_rate` refills the bucket at the desired rate until its maximum capacity is reached. The default value for the `capacity` is the `max_rate` value expressed in seconds or 1 for smaller fractions. When unsure, use the same number as `max_rate`.\n\nSee: ",
"default": 1,
"type": "integer"
},
"client_capacity": {
"title": "Client capacity",
"description": "Defines the maximum number of [tokens a bucket can hold](https://www.krakend.io/docs/throttling/token-bucket/), or said otherwise, how many requests will you accept from **each individual user** at **any given instant**. Works just as `capacity`, but instead of having one bucket for all users, keeps a counter for every connected client and endpoint, and refills from `client_max_rate` instead of `max_rate`. The client is recognized using the `strategy` field (an IP address, a token, a header, etc.). The default value for the `client_capacity` is the `client_max_rate` value expressed in seconds or 1 for smaller fractions. When unsure, use the same number as `client_max_rate`.\n\nSee: ",
"default": 1,
"type": "integer"
},
"client_max_rate": {
"title": "Client max rate",
"description": "Number of tokens you add to the [Token Bucket](https://www.krakend.io/docs/throttling/token-bucket/) for each individual user (*user quota*) in the time interval you want (`every`). The remaining tokens in the bucket are the requests a specific user can do. It keeps a counter for every client and endpoint. Keep in mind that every KrakenD instance keeps its counters in memory for **every single client**.\n\nSee: ",
"type": "number"
},
"connection_name": {
"title": "Connection Name",
"description": "The connection pool name or cluster name that is used by this ratelimit. The value must match what you configured in the [Redis Connection Pool](https://www.krakend.io/docs/enterprise/service-settings/redis-connection-pools/)",
"type": "string"
},
"connection_pool": {
"title": "Connection Pool Name",
"description": "The connection pool name that is used by this ratelimit. The value must match what you configured in the [Redis Connection Pool](https://www.krakend.io/docs/enterprise/service-settings/redis-connection-pools/)",
"deprecated": true,
"type": "string"
},
"every": {
"title": "Time window",
"description": "Time period in which the maximum rates operate. For instance, if you set an `every` of `10m` and a rate of `5`, you are allowing 5 requests every ten minutes.\n\nSee: ",
"default": "1s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"key": {
"title": "Header or Param key",
"description": "Available when using `client_max_rate` and you have set a `strategy` equal to `header` or `param`. It makes no sense in other contexts. For `header` it is the header name containing the user identification (e.g., `Authorization` on tokens, or `X-Original-Forwarded-For` for IPs). When they contain a list of space-separated IPs, it will take the IP from the client that hit the first trusted proxy. For `param` it is the name of the placeholder used in the endpoint, like `id_user` for an endpoint `/user/{id_user}`.\n\nSee: ",
"examples": [
"X-Tenant",
"Authorization",
"id_user"
],
"type": "string"
},
"max_rate": {
"title": "Max rate",
"description": "Sets the maximum number of requests all users can do in the given time frame. Internally uses the [Token Bucket](https://www.krakend.io/docs/throttling/token-bucket/) algorithm. The absence of `max_rate` in the configuration or a `0` is the equivalent to no limitation. You can use decimals if needed.\n\nSee: ",
"type": "number"
},
"on_failure_allow": {
"title": "On Failure Allow?",
"description": "Whether you want to allow a request to continue when the Redis connection is failing or not. The default behavior blocks the request if Redis is not responding correctly",
"default": false,
"type": "boolean"
},
"strategy": {
"title": "Strategy",
"description": "Available when using `client_max_rate`. Sets the strategy you will use to set client counters. Choose `ip` when the restrictions apply to the client's IP address, or set it to `header` when there is a header that identifies a user uniquely. That header must be defined with the `key` entry.\n\nSee: ",
"enum": [
"ip",
"header",
"param"
]
}
}
},
"https://www.krakend.io/schema/v2.13/qos/ratelimit/tiered.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Tiered Rate Limit",
"description": "Enterprise only. Apply ratelimit based on tier match.",
"type": "object",
"required": [
"tier_key",
"tiers"
],
"properties": {
"tier_key": {
"title": "Tier key",
"description": "The header name containing the tier name. The string you provide is case-insensitive. If you need to take the value from a place that is not a header (a token, an API key), you must use propagate functions in the components that convert values to internal headers.\n\nSee: ",
"type": "string"
},
"tiers": {
"title": "Tiers",
"description": "The list of all tier definitions and limits for each. Each item in the list is a tier object.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"properties": {
"ratelimit": {
"title": "Ratelimit",
"description": "The rate limit definition. This is an object with the same attributes the [service rate limit](https://www.krakend.io/docs/enterprise/service-settings/service-rate-limit/) has.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1router.json",
"type": "object"
},
"ratelimit_redis": {
"title": "Redis Ratelimit",
"description": "The stateful rate limit definition. This is an object with the same attributes the [stateful service rate limit](https://www.krakend.io/docs/enterprise/throttling/global-rate-limit/) has.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1redis.json",
"type": "object"
},
"tier_value": {
"title": "Tier value",
"description": "The tier value. When you use `literal`, it is the tier name. When you use `policy`, it is the expression you want to evaluate to determine if the user matches this tier or not (see security policies for syntax).\n\nSee: ",
"examples": [
"gold",
"silver",
"value.matches('User-[a-zA-Z]+')"
],
"default": "",
"type": "string"
},
"tier_value_as": {
"title": "Tier value as",
"description": "Determines how to parse the value found in the tier header. When `literal` is used, the exact value of the header is compared against the tier name. When `policy` is used, the value is used to evaluate a policy. When `*` is used, all values will match. Make sure to put the `*` as the last tier; otherwise the rest will be ignored.\n\nSee: ",
"default": "literal",
"enum": [
"literal",
"policy",
"*"
]
}
}
}
}
}
},
"https://www.krakend.io/schema/v2.13/security/bot-detector.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Bot detector",
"description": "The bot detector module checks incoming connections to the gateway to determine if a bot made them, helping you detect and reject bots carrying out scraping, content theft, and form spam.\n\nSee: ",
"type": "object",
"minProperties": 1,
"properties": {
"allow": {
"title": "Allow",
"description": "An array with EXACT MATCHES of trusted user agents that can connect.\n\nSee: ",
"examples": [
[
"MyAndroidClient/1.0",
"Pingdom.com_bot_version_1.1"
]
],
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"cache_size": {
"title": "Cache size",
"description": "Size of the LRU cache that helps speed the bot detection. The size is the mumber of users agents that you want to keep in memory.\n\nSee: ",
"examples": [
1000
],
"type": "integer"
},
"deny": {
"title": "Deny",
"description": "An array with EXACT MATCHES of undesired bots, to reject immediately.\n\nSee: ",
"examples": [
[
"facebookexternalhit/1.1"
]
],
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"empty_user_agent_is_bot": {
"title": "Empty user agent is a bot?",
"description": "Whether to consider an empty user-agent a bot (and reject it) or not. \n\nSee: ",
"default": false,
"type": "boolean"
},
"patterns": {
"title": "Bot patterns",
"description": "An array with all the regular expressions that define bots. Matching bots are rejected.\n\nSee: ",
"examples": [
[
"GoogleBot.*",
"(facebookexternalhit)/.*"
]
],
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/security/cors.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "CORS",
"description": "Define Cross-Origin Resource Sharing (CORS) configuration to send additional HTTP headers to tell browsers if they can use resources from a different origin.\n\nSee: ",
"type": "object",
"properties": {
"allow_credentials": {
"title": "Allow credentials",
"description": "When requests can include user credentials like cookies, HTTP authentication or client side SSL certificates.\n\nSee: ",
"default": false,
"type": "boolean"
},
"allow_headers": {
"title": "Allowed headers",
"description": "An array with the headers allowed, but `Origin`is always appended to the list. Requests with headers not in this list are rejected.\n\nSee: ",
"examples": [
[
"Accept-Language"
]
],
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"allow_methods": {
"title": "Allowed methods",
"description": "An array with all the HTTP methods allowed, in uppercase. Possible values are `GET`, `HEAD`,`POST`,`PUT`,`PATCH`,`DELETE`, or `OPTIONS`\n\nSee: ",
"default": [
"GET",
"HEAD",
"POST"
],
"type": "array",
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS"
]
}
},
"allow_origins": {
"title": "Allowed origins",
"description": "An array with all the origins allowed, the use of one `*` is permitted to allow groups of hosts. Examples of values are ``, ``, `` `or just `*` (any origin).\n\nSee: ",
"default": [
"*"
],
"type": "array",
"items": {
"type": "string"
}
},
"allow_private_network": {
"title": "Allow private network",
"description": "Indicates whether to accept cross-origin requests over a private network.\n\nSee: ",
"default": false,
"type": "boolean"
},
"debug": {
"title": "Development flag",
"description": "Show debugging information in the logger, **use it only during development**.\n\nSee: ",
"default": false,
"type": "boolean"
},
"expose_headers": {
"title": "Expose headers",
"description": "List of headers that are safe to expose to the API of a CORS API specification.\n\nSee: ",
"default": [
"Content-Length",
"Content-Type"
],
"type": "array",
"items": {
"type": "string"
}
},
"max_age": {
"title": "Max Age",
"description": "For how long the response can be cached. For zero values the `Access-Control-Max-Age` header is not set.\n\nSee: ",
"default": "0h",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"options_passthrough": {
"title": "OPTIONS Passthrough",
"description": "Instructs preflight to let other potential next handlers to process the OPTIONS method. Turn this on when you set the [`auto_opts` flag in the router to `true`](https://www.krakend.io/docs/service-settings/router-options/#auto_options).\n\nSee: ",
"default": false,
"type": "boolean"
},
"options_success_status": {
"title": "Success Status Codes",
"description": "The HTTP status code that is considered a success.\n\nSee: ",
"examples": [
200
],
"default": 204,
"type": "integer"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/security/http.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "HTTP Security",
"description": "Security through HTTP headers, including HSTS, HPKP, MIME-Sniffing prevention, Clickjacking protection, and others.\n\nSee: ",
"type": "object",
"properties": {
"allowed_hosts": {
"title": "Allowed hosts",
"description": "When a request hits KrakenD, it will confirm if the value of the Host HTTP header is in the list. If so, it will further process the request. If the host is not in the allowed hosts list, KrakenD will simply reject the request.\n\nSee: ",
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"allowed_hosts_are_regex": {
"title": "Hosts are regexps",
"description": "Treat the allowed hosts list as regular expressions.\n\nSee: ",
"default": false,
"type": "boolean"
},
"browser_xss_filter": {
"title": "This feature enables the Cross-site scripting (XSS) filter in the user's browser.\n\nSee: https://www.krakend.io/docs/service-settings/security/",
"default": false,
"type": "boolean"
},
"content_security_policy": {
"title": "Content-Security-Policy (CSP)",
"description": "The HTTP Content-Security-Policy (CSP) default-src directive serves as a fallback for the other CSP fetch directives.\n\nSee: ",
"examples": [
"default-src 'self';"
],
"default": "",
"type": "string"
},
"content_type_nosniff": {
"title": "Nosniff",
"description": "Enabling this feature will prevent the user's browser from interpreting files as something else than declared by the content type in the HTTP headers.\n\nSee: ",
"default": false,
"type": "boolean"
},
"custom_frame_options_value": {
"title": "Clickjacking protection. Frame-Options value",
"description": "You can add an X-Frame-Options header using custom_frame_options_value with the value of DENY (default behavior) or even set your custom value.\n\nSee: ",
"examples": [
"ALLOW-FROM https://example.com"
],
"default": "",
"type": "string"
},
"force_sts_header": {
"title": "Force STS header",
"description": "Force a STS Header even if using plain HTTP.\n\nSee: ",
"default": false,
"type": "boolean"
},
"frame_deny": {
"title": "Clickjacking protection",
"description": "Set to true to enable clickjacking protection, together with `custom_frame_options_value`.\n\nSee: ",
"default": false,
"type": "boolean"
},
"host_proxy_headers": {
"title": "SSL Host",
"description": "A set of header keys that may hold a proxied hostname value for the request.\n\nSee: ",
"examples": [
[
"X-Forwarded-Hosts"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"hpkp_public_key": {
"title": "HTTP Public Key Pinning (HPKP)",
"description": "HTTP Public Key Pinning (HPKP) is a security mechanism which allows HTTPS websites to resist impersonation by attackers using mis-issued or otherwise fraudulent certificates. (For example, sometimes attackers can compromise certificate authorities, and then can mis-issue certificates for a web origin.).\n\nSee: ",
"examples": [
"pin-sha256=\"base64==\"; max-age=expireTime [; includeSubDomains][; report-uri=\"reportURI\"]"
],
"default": "",
"type": "string"
},
"is_development": {
"title": "Development flag",
"description": "This will cause the AllowedHosts, SSLRedirect, and STSSeconds/STSIncludeSubdomains options to be ignored during development. When deploying to production, be sure to set this to false.\n\nSee: ",
"default": false,
"type": "boolean"
},
"referrer_policy": {
"title": "Referrer Policy",
"description": "Allows the Referrer-Policy header with the value to be set with a custom value.\n\nSee: ",
"default": "same-origin",
"type": "string"
},
"ssl_host": {
"title": "SSL Host",
"description": "When the SSL redirect is true, the host where the request is redirected to.\n\nSee: ",
"examples": [
"ssl.host.domain"
],
"default": "ssl.host.domain",
"type": "string"
},
"ssl_proxy_headers": {
"title": "SSL Proxy Headers",
"description": "Header keys with associated values that would indicate a valid https request. Useful when using Nginx, e.g: `\"X-Forwarded-Proto\": \"https\"`\n\nSee: ",
"examples": [
{
"X-Forwarded-Proto": "https"
}
],
"type": "object"
},
"ssl_redirect": {
"title": "SSL redirect",
"description": "Redirect any request that is not using HTTPS\n\nSee: ",
"default": true,
"type": "boolean"
},
"sts_include_subdomains": {
"title": "Strict-Transport-Security include_subdomains",
"description": "Set to true when you want the `includeSubdomains` be appended to the Strict-Transport-Security header.\n\nSee: ",
"default": false,
"type": "boolean"
},
"sts_seconds": {
"title": "HTTP Strict Transport Security (HSTS) seconds",
"description": "Enable this policy by setting the `max-age` of the `Strict-Transport-Security` header. Setting to `0` disables HSTS.\n\nSee: ",
"default": 0,
"type": "integer"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/opentelemetry-endpoint.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "OpenTelemetry Endpoint Override",
"description": "Enterprise only. Overrides metrics and traces declared by the OpenTelemetry service.\n\nSee: ",
"type": "object",
"properties": {
"backend": {
"title": "Report backend activity",
"description": "Enterprise only. Reports the activity between KrakenD and each of your backend services. This is the more granular layer.\n\nSee: ",
"type": "object",
"properties": {
"metrics": {
"type": "object",
"properties": {
"detailed_connection": {
"title": "Detailed HTTP connection metrics",
"description": "Whether you want to enable detailed metrics for the HTTP connection phase or not. Includes times to connect, DNS querying, and the TLS handshake.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_stage": {
"title": "Disable this stage",
"description": "Whether to turn off the metrics or not. Setting this to `true` means stop reporting any data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"read_payload": {
"title": "Detailed payload read",
"description": "Whether you want to enable metrics for the response reading payload or not (HTTP connection not taken into account).\n\nSee: ",
"default": false,
"type": "boolean"
},
"round_trip": {
"title": "Detailed Round Trip",
"description": "Whether you want to enable metrics for the actual HTTP request for the backend or not (manipulation not taken into account). This is the time your backend needs to produce a result.\n\nSee: ",
"default": false,
"type": "boolean"
},
"static_attributes": {
"title": "Static attributes",
"description": "A list of tags or labels you want to associate with these metrics.\n\nSee: ",
"examples": [
[
{
"key": "my_metric_attr",
"value": "my_metric_val"
}
]
],
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"title": "Key",
"description": "The key, tag, or label name you want to use.\n\nSee: ",
"type": "string"
},
"value": {
"title": "Value",
"description": "The static value you want to assign to this key.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"traces": {
"type": "object",
"properties": {
"detailed_connection": {
"title": "Detailed HTTP connection",
"description": "Whether you want to add detailed trace attributes for the HTTP connection phase or not. Includes times to connect, DNS querying, and the TLS handshake.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_stage": {
"title": "Disable this stage",
"description": "Whether to turn off the traces or not. Setting this to `true` means stop reporting any data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"read_payload": {
"title": "Detailed payload read",
"description": "Whether you want to add trace attributes for the response reading payload or not (HTTP connection not taken into account).\n\nSee: ",
"default": false,
"type": "boolean"
},
"report_headers": {
"title": "Report headers",
"description": "Whether you want to report the final headers that reached the backend.\n\nSee: ",
"default": false,
"type": "boolean"
},
"round_trip": {
"title": "Detailed Round Trip",
"description": "Whether you want to add trace attributes for the actual HTTP request for the backend or not (manipulation not taken into account). This is the time your backend needs to produce a result.\n\nSee: ",
"default": false,
"type": "boolean"
},
"skip_headers": {
"title": "Skip headers",
"description": "A list of headers you want to skip when reporting the headers that reached the backend. This is useful to avoid reporting sensitive data.\n\nSee: ",
"examples": [
[
"X-Backend-Secret",
"X-All-Secret"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"static_attributes": {
"title": "Static attributes",
"description": "A list of tags or labels you want to associate to these traces.\n\nSee: ",
"examples": [
[
{
"key": "my_trace_attr",
"value": "my_trace_val"
}
]
],
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"title": "Key",
"description": "The key, tag, or label name you want to use.\n\nSee: ",
"type": "string"
},
"value": {
"title": "Value",
"description": "The static value you want to assign to this key.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"exporters_override": {
"title": "Exporters override",
"description": "Enterprise only. Override exporter configuration for this endpoint",
"type": "object",
"properties": {
"metric_exporters": {
"title": "Metrics exporters",
"description": "Overrides the metrics exporters used in this endpoint",
"examples": [
[
"local_prometheus"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"metric_reporting_period": {
"title": "Reporting period",
"description": "Override how often you want to report and flush the metrics in seconds.\n\nSee: ",
"type": "integer"
},
"trace_exporters": {
"title": "Trace exporters",
"description": "Overrides the trace exporters used in this endpoint",
"examples": [
[
"debug_jaeger",
"newrelic",
"local_tempo"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"trace_sample_rate": {
"title": "Trace sample rate",
"description": "Overrides the sample rate for traces defines the percentage of reported traces. This option is key to reduce the amount of data generated (and resource usage), while you still can debug and troubleshoot issues. For instance, a number of `0.25` will report a 25% of the traces seen in the system.\n\nSee: ",
"examples": [
0.25
],
"type": "number",
"maximum": 1,
"minimum": 0
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"global": {
"title": "Replace global configuration",
"description": "Overrides the global configuration for this endpoint.\n\nSee: ",
"properties": {
"metrics_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for metrics. Overrides the `metrics_static_attributes` defined at the service level.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
},
"traces_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for traces. Overrides the `traces_static_attributes` defined at the service level.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
},
"proxy": {
"title": "Report proxy activity",
"description": "Reports the activity at the beginning of the proxy layer, including spawning the required requests to multiple backends, merging, endpoint transformation and any other internals of the proxy between the request processing and the backend communication\n\nSee: ",
"type": "object",
"properties": {
"disable_metrics": {
"title": "Disable metrics",
"description": "Whether you want to disable all metrics in this endpoint or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_traces": {
"title": "Disable traces",
"description": "Whether you want to disable all traces in this endpoint or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"metrics_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for metrics.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
},
"report_headers": {
"title": "Report headers",
"description": "Whether you want to report all headers that passed from the request to the proxy layer (`input_headers` policy in the endpoint plus KrakenD's headers).\n\nSee: ",
"default": false,
"type": "boolean"
},
"skip_headers": {
"title": "Skip headers",
"description": "A list of headers you want to skip when reporting headers passed to the proxy layer. This is useful to avoid reporting sensitive data.\n\nSee: ",
"examples": [
[
"X-Sensitive-Data",
"X-Signature"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"traces_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for traces.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/websocket.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Schema definition for Websockets",
"description": "Enterprise only. Enables websocket communication.\n\nSee: ",
"type": "object",
"properties": {
"backoff_strategy": {
"title": "Backoff strategy",
"description": "When the connection to your event source gets interrupted for whatever reason, KrakenD keeps trying to reconnect until it succeeds or until it reaches the max_retries. The backoff strategy defines the delay in seconds in between consecutive failed retries. Defaults to 'fallback'\n\nSee: ",
"default": "fallback",
"enum": [
"linear",
"linear-jitter",
"exponential",
"exponential-jitter",
"fallback"
]
},
"connect_event": {
"title": "Notify connections",
"description": "Whether to send notification events to the backend or not when a user establishes a new Websockets connection.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_otel_metrics": {
"title": "Disable OpenTelemetry metrics",
"description": "Disables the OpenTelemetry metrics for the websocket connections.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disconnect_event": {
"title": "Notify disconnections",
"description": "Whether to send notification events to the backend or not when users disconnect from their Websockets connection.\n\nSee: ",
"default": false,
"type": "boolean"
},
"enable_direct_communication": {
"title": "Direct Communication (no multiplexing)",
"description": "When the value is set to `true` the communication is set one to one, and disables multiplexing. One client to KrakenD opens one connection to the backend. This mode of operation is sub-optimal in comparison to multiplexing.\n\nSee: ",
"default": false,
"type": "boolean"
},
"input_headers": {
"title": "Allowed Headers In",
"description": "Defines which input headers are allowed to pass to the backend. You don't need to declare the `input_headers` at the endpoint. Use `*` to pass all headers (not recommended, use explicit values instead). There are a few headers that won't be propagated regardless of your configuration, which are: `Upgrade`, `Connection`, `Sec-Websocket-Extensions`, `Sec-Websocket-Version`, and `Sec-Websocket-Key`.\n\nSee: ",
"examples": [
[
"Authorization",
"User-Agent",
"Accept"
],
[
"*"
]
],
"default": [],
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"max_message_size": {
"title": "Maximum message size",
"description": "Sets the maximum size of messages **in bytes** sent by or returned to the client. Messages larger than this value are discarded by KrakenD and the client disconnected.\n\nSee: ",
"default": 512,
"type": "integer"
},
"max_retries": {
"title": "Max retries",
"description": "The maximum number of times you will allow KrakenD to retry reconnecting to a broken websockets server. When the maximum retries are reached, the gateway gives up the connection for good. Minimum value is `1` retry, or use `<= 0` for unlimited retries.\n\nSee: ",
"default": 0,
"type": "integer"
},
"message_buffer_size": {
"title": "Message buffer size",
"description": "Sets the maximum number of messages **each end-user** can have in the buffer waiting to be processed. As this is a per-end-user setting, you must forecast how many consumers of KrakenD websockets you will have. The default value may be too high (memory consumption) if you expect thousands of clients consuming simultaneously.\n\nSee: ",
"default": 256,
"type": "integer"
},
"ping_period": {
"title": "Ping frequency",
"description": "Sets the time between pings checking the health of the system.\n\nSee: ",
"default": "54s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit"
},
"pong_wait": {
"title": "Pong timeout",
"description": "Sets the maximum time KrakenD will until the pong times out.\n\nSee: ",
"default": "60s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit"
},
"read_buffer_size": {
"title": "Read buffer size",
"description": "Connections buffer network input and output to reduce the number of system calls when reading messages. You can set the maximum buffer size for reading in bytes.\n\nSee: ",
"default": 1024,
"type": "integer"
},
"return_error_details": {
"title": "Return error details",
"description": "Provides an error `{'error':'reason here'}` to the client when KrakenD was unable to send the message to the backend.\n\nSee: ",
"default": false,
"type": "boolean"
},
"subprotocols": {
"title": "Subprotocols",
"description": "The list of subprotocols that the client can use to connect to the websocket.\n\nSee: ",
"examples": [
[
"streamlit"
]
],
"default": [],
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"timeout": {
"title": "Timeout",
"description": "Sets the read timeout for the backend. After a read has timed out, the websocket connection is terminated and KrakenD will try to reconnect according the `backoff_strategy`. Minimum accepted time is one minute. This flag only applies when you use ' enable_direct_communication`.\n\nSee: ",
"default": "5m",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit"
},
"write_buffer_size": {
"title": "Write buffer size",
"description": "Connections buffer network input and output to reduce the number of system calls when writing messages. You can set the maximum buffer size for writing in bytes.\n\nSee: ",
"default": 1024,
"type": "integer"
},
"write_wait": {
"title": "Write timeout",
"description": "Sets the maximum time KrakenD will wait until the write times out.\n\nSee: ",
"default": "10s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/endpoint_extra_config.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Endpoint extra configuration",
"type": "object",
"properties": {
"ai/mcp": {
"description": "Enterprise only. Declares the endpoint as an [MCP server entrypoint](https://www.krakend.io/docs/enterprise/ai-gateway/mcp-server/)",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1ai~1mcp_endpoint.json"
},
"auth/api-keys": {
"title": "API-key validation",
"description": "Enterprise only. Validates that users of this endpoint pass a valid API-key containing one of the declared roles.\n\nSee: ",
"type": "object",
"required": [
"roles"
],
"properties": {
"client_max_rate": {
"title": "Max rate",
"description": "If you want to limit the endpoint usage to this specific user at a number of requests per second. Exceeding the number of requests per second will give the client a `429 Too Many Requests` HTTP status code.\n\nSee: ",
"type": "number"
},
"identifier": {
"title": "Override Identifier",
"description": "The header name or the query string name that contains the API key. By default uses any value declared in the `auth/api-keys` component in the service level.\n\nSee: ",
"type": "string"
},
"roles": {
"title": "",
"description": "The list of roles allowed to access the endpoint. Values must match (case sensitive) definitions in the `keys` section at the service level of `auth/api-keys`. API Keys not having the right role, or unauthenticated requests, will receive a `401 Unauthorized`.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"strategy": {
"title": "Strategy",
"description": "Specifies where to expect the user API key, whether inside a header or as part of the query string. When you change the strategy at the endpoint level, **you should also set the identifier**, otherwise you could have for instance, a query string strategy expecting to have a URL like `/foo?Authorization=YOUR-KEY`.\n\nSee: ",
"enum": [
"header",
"query_string"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"auth/basic": {
"description": "Enterprise only. Validates the access to the endpoint using [Basic Authentication](https://www.krakend.io/docs/enterprise/authentication/basic-authentication/).",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1basic.json",
"type": "object"
},
"auth/signer": {
"description": "A component that [cryptographically signs tokens](https://www.krakend.io/docs/authorization/jwt-signing/) generated by your legacy login system (without JWT signing) to be later validated by the `auth/validator` component.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1signer.json",
"type": "object"
},
"auth/validator": {
"description": "Protect endpoints from public usage by [validating JWT tokens](https://www.krakend.io/docs/authorization/jwt-validation/) generated by any industry-standard OpenID Connect (OIDC) integration.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1validator.json",
"type": "object"
},
"documentation/openapi": {
"description": "Enterprise only. Documents the endpoint so you can [automatically generate OpenAPI documentation](https://www.krakend.io/docs/enterprise/developer/openapi/) through `krakend openapi export` command.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1documentation~1openapi.json",
"type": "object"
},
"documentation/postman": {
"description": "Enterprise only. Documents the endpoint so you can [generate postman documentation automatically](https://www.krakend.io/docs/enterprise/developer/postman/) through the `krakend postman export` command.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1documentation~1postman_endpoint.json",
"type": "object"
},
"governance/quota": {
"description": "Enterprise only. [Attach a quota](https://www.krakend.io/docs/enterprise/governance/quota/) to the endpoint, backend, or service. The quota component allows you to limit the number of requests a user can do in a given time window.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1governance~1quota.json",
"type": "object"
},
"modifier/jmespath": {
"description": "Enterprise only. The [JMESPath](https://www.krakend.io/docs/enterprise/endpoints/jmespath/) is a query language that allows you to select, slice, filter, map, project, flatten, sort, and all sorts of operations on data.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1jmespath.json",
"type": "object"
},
"modifier/lua-endpoint": {
"description": "[Scripting with Lua](https://www.krakend.io/docs/endpoints/lua/) is an additional choice to extend your business logic, and is compatible with the rest of options such as CEL, Martian, or other Go plugins and middlewares.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1lua.json",
"type": "object"
},
"modifier/lua-proxy": {
"description": "[Scripting with Lua](https://www.krakend.io/docs/endpoints/lua/) is an additional choice to extend your business logic, and is compatible with the rest of options such as CEL, Martian, or other Go plugins and middlewares.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1lua.json",
"type": "object"
},
"modifier/request-body-extractor": {
"description": "Enterprise only. [Extracts fields from the incoming request body](https://www.krakend.io/docs/enterprise/endpoints/request-body-extractor/) and promotes them to request headers or query strings. Runs in the proxy pipeline.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1request-body-extractor.json",
"type": "object"
},
"modifier/request-body-extractor/early": {
"description": "Enterprise only. [Extracts fields from the incoming request body](https://www.krakend.io/docs/enterprise/endpoints/request-body-extractor/) and promotes them to request headers or query strings. Runs at the HTTP handler level before authentication and all other handlers.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1request-body-extractor.json",
"type": "object"
},
"modifier/request-body-generator": {
"description": "Enterprise only. Freely [transform the request body/payload](https://www.krakend.io/backends/body-generator/) you will send to your services using a templating system.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1body-generator.json",
"type": "object"
},
"modifier/response-body": {
"description": "An alias of `modifier/response-body-generator`",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1response-body.json",
"type": "object"
},
"modifier/response-body-generator": {
"description": "Enterprise only. Freely [transform the response body](https://www.krakend.io/docs/enterprise/backends/response-body-generator/) you get from your backends.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1body-generator.json",
"type": "object"
},
"plugin/middleware": {
"description": "Enterprise only. Inject your own [Go middleware plugins](https://www.krakend.io/docs/extending/injecting-plugins/)",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1middleware.json",
"type": "object"
},
"plugin/req-resp-modifier": {
"description": "Inject your own [Go request and response modifier plugins](https://www.krakend.io/docs/enterprise/extending/plugin-modifiers/)",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1req-resp-modifier.json",
"type": "object"
},
"proxy": {
"title": "Proxy",
"description": "Fine tune different options for the proxy phase of the API request/response flow.",
"type": "object",
"properties": {
"combiner": {
"title": "Custom combiner",
"description": "For custom builds of KrakenD only",
"examples": [
"combiner_name"
],
"type": "string"
},
"decompress_gzip": {
"title": "Decompress Gzip",
"description": "Enterprise only. Decompresses any Gzipped content before sending it to the backend when the `Content-Encoding` has `gzip` in the first position. You can also set this value globally at the [service level](https://www.krakend.io/docs/enterprise/service-settings/router-options/#max_payload).\n\nSee: ",
"default": false,
"type": "boolean"
},
"flatmap_filter": {
"title": "Flatmap (Array manipulation)",
"description": "The list of operations to **execute sequentially** (top down). Every operation is defined with an object containing two properties:\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1proxy~1flatmap.json",
"type": "array",
"items": {
"type": "object"
}
},
"max_payload": {
"title": "Maximum Payload",
"description": "Enterprise only. Limits the maximum number of bytes a user can send to the endpoint. `0` means no limit. You can also set this value globally at the [service level](https://www.krakend.io/docs/enterprise/service-settings/router-options/#max_payload).\n\nSee: ",
"default": 0,
"type": "integer"
},
"sequential": {
"title": "Sequential proxy",
"description": "When set to true, instead of fetching all backend content in parallel, the calls are made in order (sequentially), allowing you to chain backend requests and making calls dependent one of each other. If any of the calls fail, the remaining ones are aborted.\n\nSee: ",
"default": false,
"type": "boolean"
},
"sequential_propagated_params": {
"title": "Sequential propagated parameters",
"description": "The list of parameters you want to propagate from a previous response to the next request. Parameters are accessible by Lua scripts, CEL, security policies, the body generator, or plugins. When you add a `resp`-like parameter in this list, the parameter becomes available to the components mentioned in subsequent calls, **uppercasing the first letter**. For instance, if you add `resp0_user`, you can access in the second, third, etc. backends in Lua to `req:params('Resp0_user')`.The format of the parameters must start with `respX_` or `respX`, where `X` is the backend index from which you want to take the parameter. If you don't set the underscore `_`, you set the whole payload as a parameter. For instance, `resp0` sets a parameter `Resp0` to use in Lua or a Body generator and contains **the entire payload of the backend 0** (as a string). In this extreme case, you must use `no-op` in the backend's output (even the endpoint has a `json` output encoding) and you should access the value in Lua or a plugin. Note that access to **nested parameters** uses a single string with the dot notation inside, e.g.: `req_params['Resp0_f1.f2.f3']` (CEL and Security Policies), or `{{ index .req_params \"Resp0_f1.f2.f3\" }}` (body generators).\n\nSee: ",
"examples": [
[
"resp0"
],
[
"resp1_my_field",
"resp0_user_id"
]
],
"type": "array",
"items": {
"title": "Propagated parameter name",
"description": "A `resp`-like string that references the field you want to set a parameter and use it in the next backend call.",
"type": "string",
"pattern": "^resp[0-9]+(_[^\\s]+)?$"
}
},
"static": {
"title": "Static response",
"description": "The static proxy injects static data in the final response when the selected strategy matches.\n\nSee: ",
"type": "object",
"required": [
"data",
"strategy"
],
"properties": {
"data": {
"title": "Data",
"description": "The static data (as a JSON object) that you will return.\n\nSee: ",
"type": "object"
},
"strategy": {
"title": "Strategy",
"description": "One of the supported strategies\n\nSee: ",
"enum": [
"always",
"success",
"complete",
"errored",
"incomplete"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"qos/ratelimit/router": {
"title": "Router Rate-limiting",
"description": "The router rate limit feature allows you to set a [number of maximum requests per second a KrakenD endpoint will accept](https://www.krakend.io/docs/enterprise/endpoints/rate-limit/).\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1router.json",
"type": "object"
},
"qos/ratelimit/router/redis": {
"description": "Enterprise only. Stateful endpoint rate limit persisted on a [Redis database](https://www.krakend.io/docs/enterprise/throttling/endpoint-redis-rate-limit/)",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1redis.json",
"type": "object"
},
"qos/ratelimit/tiered": {
"description": "Enterprise only. The [rate limit based on tiers](https://www.krakend.io/docs/enterprise/service-settings/tiered-rate-limit/) allows you to have multiple sets of rate limits that apply differently to users depending on their tier or sometimes called subscription plans.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1tiered.json",
"type": "object"
},
"security/bot-detector": {
"description": "The [bot detector](https://www.krakend.io/docs/throttling/botdetector/) module checks incoming connections to the gateway to determine if a bot made them, helping you detect and reject bots carrying out scraping, content theft, and form spam.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1security~1bot-detector.json",
"type": "object"
},
"security/cors": {
"description": "Define [Cross-Origin Resource Sharing (CORS)](https://www.krakend.io/docs/enterprise/service-settings/cors/) configuration to send additional HTTP headers to tell browsers if they can use resources from a different origin.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1security~1cors.json",
"type": "object"
},
"security/http": {
"description": "[Security HTTP headers](https://www.krakend.io/docs/service-settings/security/), including HSTS, HPKP, MIME-Sniffing prevention, Clickjacking protection, and others.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1security~1http.json",
"type": "object"
},
"security/policies": {
"description": "Enterprise only. A [policies engine](https://www.krakend.io/docs/enterprise/security-policies/) that allows you to write custom sets of policies that are validated during requests, responses, or token validation.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1security~1policies.json",
"type": "object"
},
"telemetry/opentelemetry": {
"description": "Enables metrics and traces using [OpenTelemetry](https://www.krakend.io/docs/telemetry/opentelemetry/).",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1opentelemetry-endpoint.json",
"type": "object"
},
"validation/cel": {
"description": "The [Common Expression Language (CEL)](https://www.krakend.io/docs/endpoints/common-expression-language-cel/) middleware enables expression evaluation, when an expression returns false, KrakenD does not return the content as the condition has failed. Otherwise, if all expressions returned true, the content is served.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1validation~1cel.json",
"type": "array"
},
"validation/json-schema": {
"title": "Validating the body with the JSON Schema",
"description": "Apply [automatic validations using a JSON Schema](https://www.krakend.io/docs/endpoints/json-schema/) definition before the content passes to the backends. The json schema component allows you to define validation rules on the body, type definition, or even validate the fields' values.",
"type": "object"
},
"validation/response-json-schema": {
"description": "Enterprise only. Applies a [JSON schema validation to the response](https://www.krakend.io/docs/enterprise/endpoints/response-schema-validator/) before is sent to the end-user or before it’s merged in the endpoint with the rest of the backends.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1validation~1response-json-schema.json",
"type": "object"
},
"websocket": {
"description": "Enterprise only. Enables [websocket communication](https://www.krakend.io/docs/enterprise/websockets/)",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1websocket.json",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/endpoint.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Endpoint Object",
"default": {
"backend": [
{
"url_pattern": "/url"
}
],
"endpoint": "/foo"
},
"type": "object",
"required": [
"endpoint",
"backend"
],
"properties": {
"backend": {
"title": "Backend",
"description": "An array with all the backend services you want to use in this endpoint. See [the backend object](https://www.krakend.io/docs/backends/) documentation to know all the available options, they are omitted here for brevity.\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend.json",
"type": "object"
}
},
"cache_ttl": {
"title": "Cache TTL",
"description": "Sets or overrides the cache headers to inform how long the client or CDN can cache the request to this endpoint. Setting this value to a zero-value will use the `cache_ttl` in the root of the configuration if any. This attribute **does not cache** content but tells others how to do it. For caching, see [Caching Backend Responses](https://www.krakend.io/docs/backends/caching/).",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit"
},
"concurrent_calls": {
"title": "Concurrent calls",
"description": "The concurrent requests are an excellent technique to improve the response times and decrease error rates by requesting in parallel the same information multiple times. Yes, you make the same request to several backends instead of asking to just one. When the first backend returns the information, the remaining requests are canceled.\n\nSee: ",
"default": 1,
"type": "integer",
"maximum": 5,
"minimum": 1
},
"endpoint": {
"title": "Endpoint",
"description": "The path of the URL you want to expose. The path is **case-sensitive** and should start with a slash `/`. You can use `{placeholders}` to allow dynamic variables. For example: `/foo/{var}/baz`. You can also add an ending `/*` in the path to enable [wildcards](https://www.krakend.io/docs/enterprise/endpoints/wildcard/). Enterprise only.\nThe router will try to automatically redirect calls to endpoints with an incorrect case or incorrect trailing slash to its correct version offering a `301`. There are no guarantees that it will succeed and the request might even fail completely while trying (and log an ugly error with a trace). The **safest option** is to [disable automatic redirections](https://www.krakend.io/docs/service-settings/router-options/) by setting to true the flags `disable_redirect_fixed_path` and `disable_redirect_trailing_slash` in the `router` options.\n**Limitations**: URLs do not support colons `:` in their definition. All `{vars}` are meant to be isolated in the path and not to be used to build words, like in `/file.{ext}` [See `disable_rest` for that usage](https://www.krakend.io/docs/service-settings/http-server-settings/#disable_rest).\n\nSee: ",
"examples": [
"/new-endpoint",
"/foo/{var}",
"/foo/{var1}/{var2}"
],
"type": "string",
"pattern": "^\\/[^\\*\\?\\&\\%]*(\\/\\*)?$"
},
"extra_config": {
"title": "Extra configuration",
"description": "Besides the functionality ofered by the endpoint, you can load more functionalty into this endpoint by adding new entries under this extra configuration object. You will find across all documentation a lot of functionality that is designed to be placed here.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1endpoint_extra_config.json",
"type": "object"
},
"input_headers": {
"title": "Allowed Headers In",
"description": "Defines the list of all headers allowed to reach the backend when passed.\nBy default, KrakenD won't pass any header from the client to the backend. This list is **case-insensitive**. You can declare headers in lowercase, uppercase, or mixed.\nAn entry `[\"Cookie\"]` forwards all cookies, and a single star element `[\"*\"]` as value forwards everything to the backend (**it's safer to avoid this option**), including cookies. See [headers forwarding](https://www.krakend.io/docs/endpoints/parameter-forwarding/#headers-forwarding)",
"default": [],
"type": "array",
"uniqueItems": true,
"items": {
"examples": [
"User-Agent",
"Accept",
"*"
],
"type": "string"
}
},
"input_query_strings": {
"title": "Allowed Query String parameters",
"description": "Defines the exact list of quey strings parameters that are allowed to reach the backend. This list is **case-sensitive**.\nBy default, KrakenD won't pass any query string to the backend.\nA single star element `[\"*\"]` as value forwards everything to the backend (**it's safer to avoid this option**)\n\nSee: ",
"default": [],
"type": "array",
"uniqueItems": true,
"items": {
"examples": [
"page",
"limit",
"*"
],
"type": "string"
}
},
"method": {
"title": "Method",
"description": "The method supported by this endpoint. Create multiple endpoint entries if you need different methods.\n\nSee: ",
"default": "GET",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
]
},
"output_encoding": {
"title": "Output encoding",
"description": "The gateway can work with several content types, even allowing your clients to choose how to consume the content. See the [supported encodings](https://www.krakend.io/docs/endpoints/content-types/)",
"default": "json",
"enum": [
"json",
"json-collection",
"yaml",
"fast-json",
"xml",
"negotiate",
"string",
"no-op"
]
},
"timeout": {
"title": "Timeout",
"description": "The duration you write in the timeout represents the **whole duration of the pipe**, so it counts the time all your backends take to respond and the processing of all the components involved in the endpoint (the request, fetching data, manipulation, etc.). Usually specified in seconds (`s`) or milliseconds (`ms`. e.g.: `2000ms` or `2s`). If you don't set any timeout, the timeout is taken from the entry in the service level, or to the system's default",
"examples": [
"2s",
"1500ms"
],
"default": "2s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/ai/mcp.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "MCP functionality",
"description": "MCP functionality.\n\nSee: ",
"type": "object",
"required": [
"servers"
],
"properties": {
"servers": {
"description": "The array of MCP servers available for linking to endpoints. Each object represents a different MCP server. The entry is only the definition of the server. You must create an endpoint that serves as the entrypoint to each server.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"version",
"title"
],
"properties": {
"title": {
"title": "MCP Server Title",
"description": "The description of the purpose of this MCP Server. Provide a meaningful description to help AI understand its use case.\n\nSee: ",
"examples": [
"Story tracker tools"
],
"type": "string"
},
"instructions": {
"title": "Instructions",
"description": "The instructions are key for the AI client to understand how to use this server.\n\nSee: ",
"default": "",
"type": "string"
},
"json_response": {
"title": "JSON Response",
"description": "Set to true if you want the response to be in JSON format. If set to false, the response will be in SSE format (text/event-stream).\n\nSee: ",
"default": false,
"type": "boolean"
},
"name": {
"title": "MCP Server Name",
"description": "A unique name for MCP server configuration. This name is an identifier used in the logs or when a title is not provided.\n\nSee: ",
"examples": [
"stories-tracker"
],
"type": "string"
},
"ping_period": {
"title": "Ping Period",
"description": "Krakend will ping all connected clients from time to time to determine if the session must be kept alive. This duration strings sets the ping period KrakenD will do to its connected clients. When you don't set a value, there is no ping process and KrakenD is unaware of disconnected clients, so it won't report live notifications.\n\nSee: ",
"default": "0s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"stateless": {
"title": "Stateless",
"description": "A stateless server does not validate the Mcp-Session-Id header, and uses a temporary session with default initialization parameters. Any server->client request is rejected immediately as there's no way for the client to respond. Server->Client notifications may reach the client if they are made in the context of an incoming request\n\nSee: ",
"default": false,
"type": "boolean"
},
"tools": {
"description": "The Model Context Protocol (MCP) allows servers to expose tools ([RFC](https://modelcontextprotocol.io/specification/2025-06-18/server/tools)) that can be invoked by language models. Tools enable models to interact with internal/external systems. Each tool is uniquely identified by a name and includes metadata describing its schema.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"title",
"description",
"workflow"
],
"properties": {
"title": {
"title": "MCP Server Title",
"description": "The description of the purpose of this MCP tool. Provide a meaningful text to help AI understand its use case.\n\nSee: ",
"examples": [
"Story list"
],
"type": "string"
},
"description": {
"title": "MCP Server Title",
"description": "The description of the purpose of this MCP tool. Provide a meaningful description to help AI understand its use case.\n\nSee: ",
"examples": [
"Get a list of open stories in tracker matching a search query"
],
"type": "string"
},
"type": {
"title": "Media Type",
"description": "The type of the response media.\n\nSee: ",
"default": "text",
"enum": [
"text",
"audio",
"image"
]
},
"input_headers": {
"title": "Allowed Headers In",
"description": "Defines the list of all headers allowed to reach the backend when passed.\nBy default, KrakenD won't pass any header from the client to the backend. This list is **case-insensitive**. You can declare headers in lowercase, uppercase, or mixed.\nAn entry `[\"Cookie\"]` forwards all cookies, and a single star element `[\"*\"]` as value forwards everything to the backend (**it's safer to avoid this option**), including cookies. See [headers forwarding](https://www.krakend.io/docs/endpoints/parameter-forwarding/#headers-forwarding)",
"default": [],
"type": "array",
"uniqueItems": true,
"items": {
"title": "Forwarded header",
"examples": [
"User-Agent",
"Accept",
"*"
],
"type": "string"
}
},
"input_schema": {
"title": "Input JSON Schema",
"description": "The input JSON schema to validate the input parameters sent by the AI client. The schema is **essential** in most clients to understand how to pass parameters to the MCP server. The schema must be a valid [2020-12 draft JSON Schema](https://json-schema.org/understanding-json-schema/) object.\n\nSee: ",
"type": "object"
},
"name": {
"title": "MCP Tool Name",
"description": "A unique name for MCP tool configuration. This name is an identifier used in the logs or when a title is not provided.\n\nSee: ",
"examples": [
"stories-list"
],
"type": "string"
},
"output_schema": {
"title": "Input JSON Schema",
"description": "The input JSON schema to validate the output parameters sent back to the AI client. The schema must be a valid [2020-12 draft JSON Schema](https://json-schema.org/understanding-json-schema/) object.\n\nSee: ",
"type": "object"
},
"return_error_msg": {
"title": "Return error message",
"description": "Set to true if you want the error message to be returned to the AI client. If set to false, the AI client will only receive a generic error message.\n\nSee: ",
"default": false,
"type": "boolean"
},
"workflow": {
"title": "Workflow",
"description": "This is the action/pipeline performed by the tool. While you can add a single action to the tool, because actions can be chained and have complex logic, we have called this a workflow, whether is connecting to a single remote service, many, aggreggating, or any other functionality supported by KrakenD. See the [Workflow syntax](https://www.krakend.io/docs/enterprise/endpoints/workflows/)",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1workflow.json",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"version": {
"title": "Title",
"description": "The version of the logic behind your MCP Server implementation. This version makes sense to your business and is not linked to anything else.\n\nSee: ",
"examples": [
"0.2.1"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
}
},
"https://www.krakend.io/schema/v2.13/auth/api-keys.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "API-key Authentication",
"description": "Enterprise only. Enables a Role-Based Access Control (RBAC) mechanism by reading the `Authorization` header of incoming requests.\n\nSee: ",
"type": "object",
"required": [
"keys"
],
"properties": {
"hash": {
"title": "Hash",
"description": "The hashing function used to store the value of the key. When you use `plain` the API key is written as it will passed by the user. The rest of the hashes require you to save the API key after applying the desired function.\n\nSee: ",
"default": "plain",
"enum": [
"plain",
"fnv128",
"sha256",
"sha1"
]
},
"identifier": {
"title": "Identifier",
"description": "The header name or the query string name that contains the API key. Defaults to `key` when using the `query_string` strategy and to `Authorization` when using the `header` strategy. The identifier set here is used across all endpoints with API key authentication enabled, but they can override this entry individually.\n\nSee: ",
"examples": [
"Authorization",
"X-Key"
],
"default": "Authorization",
"type": "string"
},
"keys": {
"title": "API Keys",
"description": "A list of objects defining each API Key.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"title": "API Key",
"description": "The secret key used by the client to access the resources. Don't have a key? Execute in a terminal `uuidgen` to generate a random one.\n\nSee: ",
"type": "string"
},
"roles": {
"title": "Roles",
"description": "All the roles this user has. See roles as all the identifying labels that belong to this client.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"propagate_role": {
"title": "Propagate role as header",
"description": "The name of a header that will propagate to the backend containing the matching role. The backend receives no header when the string is empty, or the attribute is not declared. Otherwise, the backend receives the declared header name containing **the first matching role of the user**. The header value will be `ANY` when the endpoint does not require roles. For instance, if an API key has roles `[A, B]`, and the endpoint demands roles `[B, C]`, the backend will receive a header with the value `B`.\n\nSee: ",
"examples": [
"X-Krakend-Role"
],
"default": "",
"type": "string"
},
"salt": {
"title": "Salt",
"description": "A salt string for the desired hashing function. When provided, the API key is concatenated after the salt string and both hashed together.\n\nSee: ",
"examples": [
"mySalt"
],
"default": "",
"type": "string"
},
"strategy": {
"title": "Strategy",
"description": "Specifies where to expect the user API key, whether inside a header or as part of the query string. The strategy set here is used across all endpoints with API key authentication enabled, but they can override this entry individually.\n\nSee: ",
"default": "header",
"enum": [
"header",
"query_string"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/revoker.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Revoke Server",
"description": "The API Gateway authorizes users that provide valid tokens according to your criteria, but at some point, you might want to change your mind and decide to revoke JWT tokens that are still valid.",
"type": "object",
"required": [
"N",
"P",
"hash_name",
"TTL",
"port",
"token_keys"
],
"properties": {
"N": {
"title": "Number of elements",
"description": "The maximum `N`umber of elements you want to keep in the bloom filter. Tens of millions work fine on machines with low resources.\n\nSee: ",
"examples": [
10000000
],
"type": "integer"
},
"P": {
"title": "Probability",
"description": "The `P`robability of returning a false positive. E.g.,`1e-7` for one false positive every 10 million different tokens. The values `N` and `P` determine the size of the resulting bloom filter to fulfill your expectations. E.g: 0.0000001\n\nSee: ",
"examples": [
1e-7
],
"type": "number"
},
"TTL": {
"title": "Time To Live",
"description": "The lifespan of the JWT you are generating in seconds. The value must match the expiration you are setting in the identity provider when creating the tokens.\n\nSee: ",
"type": "integer"
},
"hash_name": {
"title": "Hash function name",
"description": "Either `optimal` (recommended) or `default`. The `optimal` consumes less CPU but has less entropy when generating the hash, although the loss is negligible.\n\nSee: ",
"enum": [
"optimal",
"default"
]
},
"port": {
"title": "Port",
"description": "The port number exposed on each KrakenD instance for the RPC service to interact with the bloomfilter. This port is allocated only to the clients (running KrakenDs).\n\nSee: ",
"type": "integer"
},
"revoke_server_api_key": {
"title": "Revoke Server Ping URL",
"description": "A string used as an exchange API key to secure the communication between the Revoke Server and the KrakenD instances and to consume the REST API of the Revoker Server as well. E.g., a string generated with `uuidgen`.\n\nSee: ",
"examples": [
"639ee23f-f4c5-40c4-855c-912bf01fae87"
],
"type": "string"
},
"revoke_server_max_retries": {
"title": "Revoke Server Max Retries",
"description": "Maximum number of retries after a connection fails. When the value is less than zero it is changed automatically to zero.\n\nSee: ",
"default": 0,
"type": "integer"
},
"revoke_server_max_workers": {
"title": "Max workers",
"description": "How many workers are used concurrently to execute an action (e.g., push a token) to all registered instances, allowing you to limit the amount of memory consumed by the server. For example, if you have 100 KrakenD servers and need to push 5MB of data each, you need to send 500MB in total. A max_workers=5 will consume a maximum of `5MB x 5 workers = 25MB` of memory in a given instant. Defaults to the same number of CPUs available.\n\nSee: ",
"default": 5,
"type": "integer"
},
"revoke_server_ping_interval": {
"title": "Revoke Server ping interval",
"description": "Time the server and the client wait to verify they are alive with each other (health check). Defaults to `30s`. Do not lower this value a lot; otherwise, you will have a lot of internal traffic.\n\nSee: ",
"examples": [
"30s"
],
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"revoke_server_ping_url": {
"title": "Revoke Server Ping URL",
"description": "The address to the `/instances` endpoint in the Revoke Server.\n\nSee: ",
"examples": [],
"type": "string"
},
"token_keys": {
"title": "Token keys",
"description": "The list with all the claims in your JWT payload that need watching. These fields establish the criteria to revoke accesses in the future. The Revoker does not use this value, only the clients.\n\nSee: ",
"examples": [
[
"jti"
]
],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/auth/jose.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Shared JWK cache",
"description": "Enables global configurations for the HTTP client responsible of downloading and caching the JWK URLs for token validation and signing.",
"type": "object",
"required": [
"shared_cache_duration"
],
"properties": {
"shared_cache_duration": {
"title": "Shared cache duration",
"description": "The cache duration in seconds for the JWK client retrieving the `jwk_url`. The endpoint must enable the `cache` option in order to use this second level cache.\n\nSee: ",
"type": "integer"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/documentation/postman.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Generate documentation using Postman collections",
"description": "Enterprise only. Generates postman documentation automatically through `krakend postman export` command.\n\nSee: ",
"type": "object",
"properties": {
"description": {
"title": "API Collection Description",
"description": "An introductory, optionally verbose, explanation supporting Markdown syntax. If you'd like to load an **external markdown file**, you can use flexible configuration, for instance `\"description\": {{include \"postman/intro.md\" | toJson }}`\n\nSee: ",
"examples": [
"Hi there, I am a [postman collection](https://www.krakend.io/docs/enterprise/developer/postman/)"
],
"type": "string"
},
"folder": {
"title": "Folder",
"description": "The folder definition where you will add endpoints",
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"description": {
"title": "Folder description",
"description": "A description explaining the items inside this folder",
"examples": [
"Books from post-apocalyptic dystopias to brilliant time-travel"
]
},
"name": {
"title": "Folder name",
"description": "The folder name. This might look like the path in an operative system with a slash /, but is not strictly necessary. Usage of special chars is allowed.",
"examples": [
"/Books",
"/Books/Science Fiction/Dystopia",
"/书籍/科幻小说",
"/पुस्तकें/विज्ञान कथा",
"/本/サイエンスフィクション"
],
"type": "string"
}
},
"additionalProperties": false
}
},
"name": {
"title": "Collection Name",
"description": "The name of the Postman collection you are generating.\n\nSee: ",
"examples": [
"KrakenD Config v1"
],
"type": "string"
},
"version": {
"title": "Collection Version",
"description": "The version you assign to this Postman collection you are generating using **semantic versioning**.\n\nSee: ",
"examples": [
"1.2.3",
"0.7.9"
],
"type": "string",
"pattern": "^[0-9].[0-9].[0-9]+$"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/governance/processors.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Governance processors",
"description": "Declares rules and limits to be enforced.",
"type": "object",
"required": [
"quotas"
],
"properties": {
"quotas": {
"description": "The list of quota processors available for attachment. You can have multiple processors with different configurations.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"connection_name",
"rules"
],
"properties": {
"connection_name": {
"description": "The name of the [Redis connection](https://www.krakend.io/docs/enterprise/service-settings/redis-connection-pools/) to use, it must exist under the `redis` namespace at the service level and written exactly as declared.\n\nSee: ",
"type": "string"
},
"deny_queue_flush_interval": {
"description": "When you have a `rejecter_cache`, the time interval to write the events stored in the buffer in the bloom filter. This is the maximum time that can elapse before the events are written to the bloom filter.\n\nSee: ",
"default": "1s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"deny_queue_flush_threshold": {
"description": "When you have a `rejecter_cache`, the maximum number of events in the buffer that will force a write to the bloom filter event when the flush interval has not kicked in yet.\n\nSee: ",
"default": 10,
"type": "integer"
},
"deny_queue_size": {
"description": "When you have a `rejecter_cache`, the size of the buffer (number of events stored) to write in the bloomfilter. It defaults to the number of cores on the machine. This is the maximum number of events that can be stored in memory before being written to the bloom filter. You should not set this value unless you are seeing increased latencies on very high-concurrency scenarios; ask support for help.\n\nSee: ",
"type": "integer"
},
"hash_keys": {
"description": "Whether to hash the keys used for quota consumption. If you have PII (Personal Identifiable Information) in the keys (like an email), enable this option to `true` to avoid Redis containing clear text keys with PII. This is a setting for privacy, enabling it may affect performance because of the extra hashing, and makes data exploration difficult.\n\nSee: ",
"default": false,
"type": "boolean"
},
"name": {
"description": "Name of the quota. The exact name you type here is the one you need to reference when you attach a quota under the `governance/quota` namespace, and is also part of the key name on the persistence layer.\n\nSee: ",
"examples": [
"public_api",
"LLM"
],
"type": "string"
},
"on_failure_allow": {
"description": "What to do with the user request if Redis is down. When `true`, allows continuing to perform requests even when Redis is unreachable, but the quota won't be counted. When `false`, the request is rejected and the user receives a 500 error. This is a fail-safe option, but it may lead to quota overconsumption.\n\nSee: ",
"type": "boolean"
},
"on_failure_backoff_strategy": {
"description": "The backoff strategy to use when Redis is unreachable. The default is `exponential`, which means that the time between retries will increase exponentially. The other option is `linear`, which means that the time between retries will be constant.\n\nSee: ",
"default": "exponential",
"enum": [
"linear",
"exponential"
]
},
"on_failure_max_retries": {
"description": "Maximum number of retries to Redis when it is unreachable. Once the retries are exhausted, the processor is no longer usable and the quota stops working until the Redis connection is restored and the service restarted. The users will be able to consume content depending on the `on_failure_allow` option. A zero value means no retries.\n\nSee: ",
"default": 0,
"type": "integer"
},
"rejecter_cache": {
"description": "The bloom filter configuration that you use to cache rejections. The bloom filter is used to store the events that are rejected by the quota processor. This is useful to avoid rejecting the same event multiple times.\n\nSee: ",
"type": "object",
"required": [
"N",
"P"
],
"properties": {
"N": {
"title": "Number of elements",
"description": "The maximum `N`umber of elements you want to keep in the bloom filter. Tens of millions work fine on machines with low resources.\n\nSee: ",
"examples": [
10000000
],
"type": "integer"
},
"P": {
"title": "Probability",
"description": "The `P`robability of returning a false positive. E.g.,`1e-7` for one false positive every 10 million different tokens. The values `N` and `P` determine the size of the resulting bloom filter to fulfill your expectations. E.g: 0.0000001\n\nSee: \n\nSee: ",
"examples": [
1e-7
],
"type": "number"
},
"cleanup_interval": {
"description": "The time interval to clean up the bloom filter. This is the maximum time that can elapse before the bloom filter is cleaned up.\n\nSee: ",
"default": "30m",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"hash_name": {
"title": "Hash function name",
"description": "Either `optimal` (recommended) or `default`. The `optimal` consumes less CPU but has less entropy when generating the hash, although the loss is negligible.\n\nSee: \n\nSee: ",
"default": "optimal",
"enum": [
"optimal",
"default"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"rules": {
"description": "The rules to use for the quota processor.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"limits"
],
"properties": {
"limits": {
"description": "The limits for the rule. The limits are defined as an array of objects, each object containing an amount and a unit.\n\nSee: ",
"examples": [
[
{
"amount": 10,
"unit": "hour"
},
{
"amount": 250,
"unit": "day"
}
]
],
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"unit"
],
"properties": {
"amount": {
"description": "The amount of the limit. This is the maximum number of requests that can be made in the given time unit.\n\nSee: ",
"type": "number"
},
"unit": {
"description": "The time unit for the limit.\n\nSee: ",
"enum": [
"second",
"minute",
"hour",
"day",
"week",
"month",
"year"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"name": {
"description": "The name of the rule. This is the name that will be used to identify the rule in the logs and metrics. It is also the plan name.\n\nSee: ",
"examples": [
"gold",
"silver"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/grpc.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "gRPC server",
"description": "Enterprise only. gRPC server integration",
"type": "object",
"required": [
"catalog"
],
"properties": {
"catalog": {
"title": "Catalog definition",
"description": "The paths to the different `.pb` files you want to load, or the paths to directories containing `.pb` files. All content is scanned in the order of the list, and after fetching all files it resolves the dependencies of their imports. The order you use here is not important to resolve imports, but it matters when there are conflicts (different files using the same namespace and package type).\n\nSee: ",
"examples": [
[
"./grpc/flights.pb",
"./grpc/definitions",
"/etc/krakend/grpc"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"server": {
"title": "gRPC Server",
"description": "Defines the gRPC server properties.\n\nSee: ",
"type": "object",
"properties": {
"opentelemetry": {
"title": "OpenTelemetry settings",
"description": "Overrides [OpenTelemetry settings](https://www.krakend.io/docs/enterprise/telemetry/opentelemetry-layers-metrics/) for the gRPC server.",
"type": "object",
"properties": {
"disable_metrics": {
"title": "Disable metrics",
"description": "Whether you want to disable all metrics happening in the gRPC server.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_traces": {
"title": "Disable trace",
"description": "Whether you want to disable all traces happening in the gRPC server.\n\nSee: ",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"services": {
"title": "gRPC services",
"description": "Defines one object per available gRPC service.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"properties": {
"methods": {
"title": "Methods",
"description": "The gRPC methods available for this service. The `methods` entry is the gRPC equivalent of the HTTP `endpoints`, meaning that the `backend` object under `methods` can use the same configuration as HTTP, including all its `extra_config` parameters.\n\nSee: ",
"type": "array",
"items": {
"type": "object",
"properties": {
"backend": {
"title": "Backend",
"description": "An array with all the [backend objects](https://www.krakend.io/docs/backends/) mapped to this method",
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1backend.json",
"type": "object"
}
},
"extra_config": {
"title": "Extra configuration",
"description": "Extra configuration for this method",
"type": "object",
"properties": {
"auth/validator": {
"title": "JWT validation",
"description": "The JWT validation for this method. The configuration underneath is exactly as in the [JWT validator](https://www.krakend.io/docs/enterprise/authorization/jwt-validation/)",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1validator.json",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"input_headers": {
"title": "Allowed Headers In",
"description": "Defines the list of all client headers that you can use as gRPC metadata.\nBy default, KrakenD won't pass any header from the client to the backend. This list is **case-insensitive**. You can declare headers in lowercase, uppercase, or mixed.\nAn entry `[\"X-Something\"]` forwards a single `X-Something` header to the backend, ignoring everything else. A single star element `[\"*\"]` as value forwards everything to the backend (**it's safer to avoid this option**).",
"examples": [
[
"X-Custom-Trace"
],
[
"*"
]
],
"default": [],
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"name": {
"title": "Method name",
"description": "The name of the published gRPC method.\n\nSee: ",
"examples": [
"FindFlight"
],
"type": "string"
},
"payload_params": {
"description": "Maps a property of the gRPC incoming payload to a `{parameter}` that you can inject and reuse in a `url_pattern`. It supports dot nation to access nested objects.\n\nSee: ",
"examples": [
{
"some.grpc.object": "param1"
}
],
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"name": {
"title": "gRPC name",
"description": "The name of the published gRPC service.\n\nSee: ",
"examples": [
"flight_finder.Flights"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/modifier/response-headers.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Response headers modifier",
"description": "Enterprise only. Allows you to transform response headers declaratively.\n\nSee: ",
"type": "object",
"minProperties": 1,
"properties": {
"add": {
"title": "Headers to add",
"description": "The headers you want to add. Every key under `add` is the header name, and the values are declared in an array with all those you want to set. If the header didn't exist previously, it is created with the values you passed. If the header existed, then the new values are appended.\n\nSee: ",
"examples": [
{
"X-Hello": [
"World"
]
}
],
"type": "object",
"minProperties": 1,
"patternProperties": {
"(.+)": {
"description": "Header name you want to add",
"type": "array",
"items": {
"description": "Header value you want to add",
"type": "string"
}
}
}
},
"delete": {
"title": "Headers to delete",
"description": "The list of headers you want to delete. All headers listed will be missing in the response.\n\nSee: ",
"examples": [
[
"X-Krakend",
"X-Krakend-Completed"
]
],
"type": "array",
"minItems": 1,
"items": {
"description": "Header you want to delete",
"type": "string"
}
},
"rename": {
"title": "Headers to rename",
"description": "The headers you want to rename. The key used under `rename` is the original header name, and the value the new header name. This operation is destructive, meaning that if you rename to a header name that already existed it will be replaced with the new header and value.\n\nSee: ",
"examples": [
{
"Header-A": "Header-A-New-Name"
}
],
"type": "object",
"minProperties": 1,
"patternProperties": {
"(.+)": {
"description": "Header you want to rename",
"type": "string"
}
}
},
"replace": {
"title": "Headers to replace",
"description": "The headers you want to replace. The key used under `replace` is the header name, and the value an array with all the header values you want to set. The replacement overwrites any other value that could exist in this header.\n\nSee: ",
"examples": [
{
"Cache-Control": [
"no-store"
],
"Vary": [
"foo",
"bar",
"foobar"
]
}
],
"type": "object",
"minProperties": 1,
"patternProperties": {
"(.+)": {
"type": "array",
"items": {
"description": "Header value you want to replace",
"type": "string"
}
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/geoip.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "GeoIP",
"description": "Enterprise only. The GeoIP integration allows you load Maxmind's GeoIP2 City database (payment and free versions) and enrich all KrakenD calls to your backends with geo data.\n\nSee: ",
"type": "object",
"required": [
"citydb_path"
],
"properties": {
"citydb_path": {
"title": "CityDB path",
"description": "The path in the filesystem containing the database in GeoIP2 Binary (`.mmdb`) format. Relative to the working dir or absolute path.\n\nSee: ",
"examples": [
"path/to/GeoIP2-City.mmdb"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/jwk-aggregator.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "JWK aggregator",
"description": "Enterprise only. The JWK aggregator plugin allows KrakenD to validate tokens issued by multiple Identity Providers.\n\nSee: ",
"type": "object",
"required": [
"port",
"origins"
],
"properties": {
"cache": {
"title": "Cache",
"description": "When `true`, it stores the response of the Identity provider for the time specified in its `Cache-Control` header.\n\nSee: ",
"type": "boolean"
},
"origins": {
"title": "Origins",
"description": "The list of all JWK URLs recognized as valid Identity Providers by the gateway.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"port": {
"title": "Port",
"description": "The port of the local server doing the aggregation. The port is only accessible within the gateway machine using localhost, and it's never exposed to the external network. Choose any port that is free in the system.\n\nSee: ",
"examples": [
9876
],
"type": "integer"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/redis-ratelimit.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "DEPRECATED. Redis ratelimit",
"description": "Enterprise only. The global rate limit functionality enables a Redis database store to centralize all KrakenD node counters. Instead of having each KrakenD node count its hits, the counters are global and stored in the database.\n\nSee: ",
"deprecated": true,
"type": "object",
"required": [
"host",
"tokenizer",
"burst",
"rate",
"period"
],
"properties": {
"burst": {
"title": "Burst",
"description": "How many requests a client can make above the rate specified during a peak.\n\nSee: ",
"type": "integer"
},
"host": {
"title": "Redis host",
"description": "The URL to the Redis instance that stores the counters using the format `host:port`.\n\nSee: ",
"examples": [
"redis",
"redis:6379"
],
"type": "string"
},
"period": {
"title": "Period",
"description": "For how long the content lives in the cache. Usually in seconds, minutes, or hours. E.g., use `120s` or `2m` for two minutes\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"rate": {
"title": "Rate",
"description": "Number of allowed requests during the observed period.\n\nSee: ",
"type": "integer"
},
"tokenizer": {
"title": "Tokenizer",
"description": "One of the preselected strategies to rate-limit users.\n\nSee: ",
"enum": [
"jwt",
"ip",
"url",
"path",
"header",
"param",
"cookie"
]
},
"tokenizer_field": {
"title": "Tokenizer field",
"description": "The field used to set a custom field for the tokenizer (e.g., extracting the token from a custom header other than Authorization or using a claim from a JWT other than the jti).\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/static-filesystem.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Static Filesystem",
"description": "Enterprise only. Allows you to fetch and serve static content in two different use cases. When the plugin is used as an http server handler, the static content is for your end-users, giving them CSS, JS, images, or JSON files, to name a few examples. On the other side, when the plugin is used as an http client executor, the KrakenD endpoints use static content as if it were a backend.\n\nSee: ",
"deprecated": true,
"type": "object",
"required": [
"prefix",
"path"
],
"properties": {
"path": {
"title": "Path",
"description": "The folder in the filesystem containing the static files. Relative to the working dir where KrakenD config is (e.g.: `./assets`) or absolute (e.g.: `/var/www/assets`).\n\nSee: ",
"examples": [
"./static/"
],
"type": "string"
},
"prefix": {
"title": "Prefix",
"description": "This is the beginning (prefix) of all URLs that are resolved using this plugin. All matching URLs won't be passed to the router, meaning that they are not considered endpoints. Make sure you are not overwriting valid endpoints. When the `prefix` is `/`, then **all traffic is served as static** and you must declare a prefix under `skip` (e.g.: `/api`) to match endpoints.\n\nSee: ",
"examples": [
"/media/assets"
],
"type": "string"
},
"skip": {
"title": "Skip paths",
"description": "An array with all the prefix URLs that despite they could match with the `prefix`, you don't want to treat them as static content and pass them to the router.\n\nSee: ",
"examples": [
[
"/media/ignore/this/directory",
"/media/file.json"
]
],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/url-rewrite.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "URL rewrite",
"description": "Enterprise only. Allows you to declare additional URLs other than the ones defined under the endpoints configuration, used as aliases of existing endpoints.\n\nSee: ",
"type": "object",
"anyOf": [
{
"required": [
"literal"
]
},
{
"required": [
"regexp"
]
}
],
"properties": {
"literal": {
"title": "Literal match",
"description": "A map with the exact desired url and its mapping to an endpoint. If the endpoint has `{placeholders}` you need to write them, but the literal value `{placeholders}` is passed.\n\nSee: ",
"examples": [
{
"/hi-there": "/hello",
"/whatsup": "/hello"
}
],
"type": "object"
},
"regexp": {
"title": "Regexp match",
"description": "A list of lists, containing the regular expression that defines the URL to be rewritten, and its endpoint destination. You can use the capturing groups with the syntax `${1}`, `${2}`, etc.\n\nSee: ",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/virtualhost.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "VirtualHost",
"description": "Enterprise only. The Virtual Host plugin allows you to run different configurations of KrakenD endpoints based on the host accessing the server.\n\nSee: ",
"deprecated": true,
"type": "object",
"required": [
"hosts"
],
"properties": {
"hosts": {
"title": "Virtualhosts",
"description": "All recognized virtual hosts by KrakenD must be listed here. The values declared here must match the content of the `Host` header when passed by the client.\n\nSee: ",
"examples": [
[
"api-a.host.com",
"api-b.host.com"
]
],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/wildcard.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Wildcard",
"description": "Enterprise only. Enables wildcard processing of requests without declaring all endpoint subresrouces.\n\nSee: ",
"type": "object",
"required": [
"endpoints"
],
"properties": {
"endpoints": {
"title": "Endpoints",
"description": "The key of the map is the KrakenD endpoint that receives all the wildcard traffic. The value is an array with all the user paths that match this wildcard (you don't need to declare the subresources).\n\nSee: ",
"examples": [
{
"/__wildcard/foo": [
"/foo",
"/aliasfoo"
]
}
],
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/plugin/http-server.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "HTTP Server plugins.\n\nSee: https://www.krakend.io/docs/extending/http-server-plugins/",
"type": "object",
"required": [
"name"
],
"properties": {
"geoip": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1geoip.json"
},
"ip-filter": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1ip-filter.json"
},
"jwk-aggregator": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1jwk-aggregator.json"
},
"name": {
"title": "Plugin name",
"description": "An array with the names of plugins to load. The names are defined inside your plugin.\n\nSee: ",
"examples": [
[
"myplugin"
]
],
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"redis-ratelimit": {
"deprecated": true,
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1redis-ratelimit.json"
},
"static-filesystem": {
"deprecated": true,
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1static-filesystem.json"
},
"url-rewrite": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1url-rewrite.json"
},
"virtualhost": {
"deprecated": true,
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1virtualhost.json"
},
"wildcard": {
"deprecated": true,
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1wildcard.json"
}
}
},
"https://www.krakend.io/schema/v2.13/redis.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Redis configuration",
"description": "Defines the Redis connection pools available to any functionality requiring Redis.\n\nSee: /docs/enterprise/throttling/global-rate-limit/",
"type": "object",
"properties": {
"clusters": {
"title": "Cluster definitions",
"description": "Defines all the clusters available to Redis functionality. The different components requiring Redis will access the pool based on its name",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"addresses"
],
"properties": {
"addresses": {
"title": "Addresses",
"description": "The list of redis members that conform the cluster using the format `host:port`. All members must be WRITEABLE",
"examples": [
[
"192.168.1.45:6379",
"192.168.1.52:6379"
]
],
"type": "array",
"items": {
"title": "Redis member",
"description": "The address of a Redis member in the cluster",
"type": "string"
}
},
"client_name": {
"title": "Client name",
"description": "You can set how this connection shows in Redis when listing all the connections `CONN LIST`",
"examples": [
"krakend_pool"
],
"type": "string"
},
"conn_max_idle_time": {
"title": "Connection Max Idle Time",
"description": "The maximum amount of time a connection may be idle. Should be less than server's timeout.Expired connections may be closed lazily before reuse. If <= 0, connections are not closed due to a connection's idle time.",
"default": "30m",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"conn_max_life_time": {
"title": "conn_max_life_time",
"description": "The maximum amount of time a connection may be reused. When the attribute is not declared, the connection does not expire",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"dial_timeout": {
"title": "Dial Timeout",
"description": "Dial timeout for establishing new connections",
"default": "5s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"max_active_conns": {
"title": "Max active conns",
"description": "Maximum number of connections allocated by the pool at a given time. When zero, there is no limit on the number of connections in the pool.",
"default": 0,
"type": "integer"
},
"max_idle_conns": {
"title": "Max idle conns",
"description": "Maximum number of idle connections. The value `0` means connections not closed",
"default": 0,
"type": "integer"
},
"max_redirects": {
"title": "Max redirects",
"description": "The maximum number of redirects to follow when requesting a key that is in another instance",
"default": 3,
"type": "integer"
},
"max_retries": {
"title": "Max retries",
"description": "The number of times you want to retry a Redis command using a different connection from the pool, applying a random delay between `min_retry_backoff` and `max_retry_backoff`. Use `-1` to never retry (it might not be a good idea)",
"default": 3,
"type": "integer"
},
"max_retry_backoff": {
"title": "Max retry backoff",
"description": "Every retry is executed increasing randomly starting at the `min_retry_backoff` until the `max_retry_backoff` is reached. This is the longest possible time.",
"default": "512ms",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"min_idle_conns": {
"title": "min_idle_conns",
"description": "Minimum number of idle connections which is useful when establishing new connection is slow. `0` means connections are not closed.",
"default": 0,
"type": "integer"
},
"min_retry_backoff": {
"description": "Every retry is executed increasing randomly starting at the `min_retry_backoff` until the `max_retry_backoff` is reached. This is the shortest possible time.",
"default": "8ms",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"name": {
"title": "Connection name",
"description": "The connection pool name. This is an arbitrary name used to reference this connection in other parts of the configuration needing Redis.",
"examples": [
"shared_instance",
"Redis_for_ratelimit"
],
"type": "string"
},
"opentelemetry": {
"title": "OpenTelemetry",
"description": "The OpenTelemetry configuration establishing how to report Redis connection activity",
"type": "object",
"properties": {
"disable_metrics": {
"title": "Disable metrics",
"description": "Disables any metrics of this Redis pool",
"default": false,
"type": "boolean"
},
"disable_traces": {
"title": "Disable traces",
"description": "Disables any traces of this Redis pool",
"default": false,
"type": "boolean"
},
"traces_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for traces.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
}
},
"additionalProperties": false
},
"password": {
"title": "password",
"description": "Sets the password to connect to Redis.",
"type": "string"
},
"pool_size": {
"title": "Pool size",
"description": "The pool size defines the number of concurrent Redis commands that can be executed by this Redis pool. Take into account that this only saves the connection time to the server, but, Redis will still be a non-concurrent service. When `0` it maps to its default 10",
"default": 10,
"type": "integer"
},
"pool_timeout": {
"title": "Pool timeout",
"description": "Amount of time the client waits for a connection if all connections are busy.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"tls": {
"title": "tls",
"description": "An object with any [client TLS configuration](https://www.krakend.io/docs/enterprise/service-settings/tls/#client-tls-settings) to this connection",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1client_tls.json",
"type": "object"
},
"user_name": {
"title": "Username",
"description": "The username to connect to Redis",
"type": "string"
}
},
"additionalProperties": false
}
},
"connection_pools": {
"title": "Connection Pools",
"description": "Defines all the connetion pools available to Redis functionality. The different components requiring Redis will access the pool based on its name",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"address"
],
"properties": {
"address": {
"title": "Address",
"description": "The Redis host where you want to connect using the format `host:port`.",
"examples": [
"shared.redis.example.com"
],
"type": "string"
},
"client_name": {
"title": "Client name",
"description": "You can set how this connection shows in Redis when listing all the connections `CONN LIST`",
"examples": [
"krakend_pool"
],
"type": "string"
},
"conn_max_idle_time": {
"title": "Connection Max Idle Time",
"description": "The maximum amount of time a connection may be idle. Should be less than server's timeout.Expired connections may be closed lazily before reuse. If <= 0, connections are not closed due to a connection's idle time.",
"default": "30m",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"conn_max_life_time": {
"title": "conn_max_life_time",
"description": "The maximum amount of time a connection may be reused. When the attribute is not declared, the connection does not expire",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"db": {
"title": "DB",
"description": "The database number to select after connecting",
"default": 0,
"type": "integer"
},
"dial_timeout": {
"title": "Dial Timeout",
"description": "Dial timeout for establishing new connections",
"default": "5s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"max_active_conns": {
"title": "Max active conns",
"description": "Maximum number of connections allocated by the pool at a given time. When zero, there is no limit on the number of connections in the pool.",
"default": 0,
"type": "integer"
},
"max_idle_conns": {
"title": "Max idle conns",
"description": "Maximum number of idle connections. The value `0` means connections not closed",
"default": 0,
"type": "integer"
},
"max_retries": {
"title": "Max retries",
"description": "The number of times you want to retry a Redis command using a different connection from the pool, applying a random delay between `min_retry_backoff` and `max_retry_backoff`. Use `-1` to never retry (it might not be a good idea)",
"default": 3,
"type": "integer"
},
"max_retry_backoff": {
"title": "Max retry backoff",
"description": "Every retry is executed increasing randomly starting at the `min_retry_backoff` until the `max_retry_backoff` is reached. This is the longest possible time.",
"default": "512ms",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"min_idle_conns": {
"title": "min_idle_conns",
"description": "Minimum number of idle connections which is useful when establishing new connection is slow. `0` means connections are not closed.",
"default": 0,
"type": "integer"
},
"min_retry_backoff": {
"description": "Every retry is executed increasing randomly starting at the `min_retry_backoff` until the `max_retry_backoff` is reached. This is the shortest possible time.",
"default": "8ms",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"name": {
"title": "Connection name",
"description": "The connection pool name. This is an arbitrary name used to reference this connection in other parts of the configuration needing Redis.",
"examples": [
"shared_instance",
"Redis_for_ratelimit"
],
"type": "string"
},
"opentelemetry": {
"title": "OpenTelemetry",
"description": "The OpenTelemetry configuration establishing how to report Redis connection activity",
"type": "object",
"properties": {
"disable_metrics": {
"title": "Disable metrics",
"description": "Disables any metrics of this Redis pool",
"default": false,
"type": "boolean"
},
"disable_traces": {
"title": "Disable traces",
"description": "Disables any traces of this Redis pool",
"default": false,
"type": "boolean"
},
"traces_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for traces.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
}
},
"additionalProperties": false
},
"password": {
"title": "password",
"description": "Sets the password to connect to Redis.",
"type": "string"
},
"pool_size": {
"title": "Pool size",
"description": "The pool size defines the number of concurrent Redis commands that can be executed by this Redis pool. Take into account that this only saves the connection time to the server, but, Redis will still be a non-concurrent service. When `0` it maps to its default 10",
"default": 10,
"type": "integer"
},
"pool_timeout": {
"title": "Pool timeout",
"description": "Amount of time the client waits for a connection if all connections are busy.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"tls": {
"title": "tls",
"description": "An object with any [client TLS configuration](https://www.krakend.io/docs/enterprise/service-settings/tls/#client-tls-settings) to this connection",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1client_tls.json",
"type": "object"
},
"user_name": {
"title": "Username",
"description": "The username to connect to Redis",
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/router.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Router Options",
"description": "The optional router configuration allows you to set global flags that change the way KrakenD processes the requests at the router layer.\n\nSee: ",
"type": "object",
"properties": {
"app_engine": {
"title": "App Engine integration",
"description": "The app_engine boolean trusts headers starting with X-AppEngine... for better integration with that PaaS.\n\nSee: ",
"type": "boolean"
},
"auto_options": {
"title": "Automatic OPTIONS",
"description": "When true, enables the autogenerated OPTIONS endpoint for all the registered paths\n\nSee: ",
"type": "boolean"
},
"decompress_gzip": {
"title": "Decompress Gzip",
"description": "Enterprise only. Decompresses any Gzipped content before sending it to the backend when the `Content-Encoding` has `gzip` in the first position. You can also set this value [per endpoint](https://www.krakend.io/docs/enterprise/endpoints/maximum-request-size/).\n\nSee: ",
"default": 0,
"type": "integer"
},
"disable_access_log": {
"title": "Disable Access Log",
"description": "Stops registering access requests to KrakenD in the logs. You can still have a [Backend Log](https://www.krakend.io/docs/logging/#backend) if needed.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_gzip": {
"title": "Disable gzip compression",
"description": "Enterprise only. All the output to the end user on the Enterprise Edition uses gzip when accepted by the client. Use this flag to remove gzip compression.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_handle_method_not_allowed": {
"title": "Disable method not allowed",
"description": "Whether to checks if another method is allowed for the current route, if the current request can not be routed. If this is the case, the request is answered with Method Not Allowed and HTTP status code 405. If no other Method is allowed, the request is a 404.\n\nSee: ",
"type": "boolean"
},
"disable_health": {
"title": "Disable Health",
"description": "When true you don't have any exposed health endpoint. You can still use a TCP checker or build an endpoint yourself.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_path_decoding": {
"title": "Disable method not allowed",
"description": "Disables automatic validation of the url params looking for url encoded ones.\n\nSee: ",
"type": "boolean"
},
"disable_redirect_fixed_path": {
"title": "Disable redirect fixed path",
"description": "If true, the router tries to fix the current request path, if no handle is registered for it\n\nSee: ",
"type": "boolean"
},
"disable_redirect_trailing_slash": {
"title": "Disable redirect trailing slash",
"description": "Disables automatic redirection if the current route can't be matched but a handler for the path with (without) the trailing slash exists. Only works if `disable_redirect_fixed_path` is also set to true.\n\nSee: ",
"type": "boolean"
},
"error_body": {
"title": "Custom error body",
"description": "Sets custom error bodies for 404 and 405 errors.\n\nSee: ",
"type": "object",
"properties": {
"404": {
"title": "404 errors",
"description": "Write any JSON object structure you would like to return to users when they request an endpoint not known by KrakenD. 404 Not Found errors.",
"type": "object"
},
"405": {
"title": "405 errors",
"description": "Write any JSON object structure you would like to return to users",
"type": "object"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"forwarded_by_client_ip": {
"title": "Forwarded by client IP",
"description": "When set to true, the client IP will be parsed from the default request's headers, or the custom ones (`remote_ip_headers`). If the IP has passed through a **trusted proxy** (e.g.: a proxy, load balancer, or a third party application) it will be extracted. If no IP can be fetched, it falls back to the IP obtained from the request's remote address. When declared **you must** configure `trusted_proxies` too.\n\nSee: ",
"default": false,
"type": "boolean"
},
"health_path": {
"title": "Health endpoint path",
"description": "The path where you'd like to expose the health endpoint.\n\nSee: ",
"default": "/__health",
"type": "string"
},
"hide_version_header": {
"title": "Hide version header",
"description": "Removes the version of KrakenD used in the X-KrakenD-version headers.\n\nSee: ",
"default": false,
"type": "boolean"
},
"logger_skip_paths": {
"title": "Remove requests from logs",
"description": "Defines the set of paths that are removed from the logging.\n\nSee: ",
"type": "array",
"items": {
"title": "Paths",
"type": "string"
}
},
"max_multipart_memory": {
"title": "Memory available for Multipart forms",
"description": "Sets the maxMemory param that is given to http.Request's Multipart Form method call.\n\nSee: ",
"type": "integer"
},
"max_payload": {
"title": "Maximum Payload",
"description": "Enterprise only. Limits the maximum number of bytes a user can send to the gateway. `0` means no limit. You can also set this value [per endpoint](https://www.krakend.io/docs/enterprise/endpoints/maximum-request-size/).\n\nSee: ",
"default": 0,
"type": "integer"
},
"remote_ip_headers": {
"title": "Remote IP headers",
"description": "List of headers used to obtain the client IP when `forwarded_by_client_ip` is set to `true` and the remote address is matched by at least one of the network origins of `trusted_proxies`.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"remove_extra_slash": {
"title": "Remove extra slash",
"description": "A parameter can be parsed from the URL even with extra slashes.\n\nSee: ",
"default": false,
"type": "boolean"
},
"return_error_msg": {
"title": "Returning the gateway error message",
"description": "When there is an error in the gateway (such as a timeout, a non-200 status code, etc.) it returns to the client the reason for the failure. The error is written in the body as is.\n\nSee: ",
"default": false,
"type": "boolean"
},
"trusted_proxies": {
"title": "Trusted Proxies",
"description": "List of network origins (IPv4 addresses, IPv4 CIDRs, IPv6 addresses or IPv6 CIDRs) from which to trust request's headers that contain alternative client IP when `forwarded_by_client_ip` is `true`. When declared **you must** configure `forwarded_by_client_ip` set to `true`, and optionally `remote_ip_headers`.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/server/static-filesystem.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Static Filesystem",
"description": "Enterprise only. Allows you to fetch and serve static content by registering a static web server for a set of defined paths (the prefixes).\n\nSee: ",
"type": "object",
"required": [
"prefix",
"path"
],
"properties": {
"directory_listing": {
"description": "Whether to allow directory listings or not",
"default": false,
"type": "boolean"
},
"path": {
"title": "Path",
"description": "The folder in the filesystem containing the static files. Relative to the working dir where KrakenD config is (e.g.: `./assets`) or absolute (e.g.: `/var/www/assets`).\n\nSee: ",
"examples": [
"./static/"
],
"type": "string"
},
"prefix": {
"title": "Prefix",
"description": "This is the beginning (prefix) of all URLs that are resolved using this plugin. All matching URLs won't be passed to the router, meaning that they are not considered endpoints. Make sure you are not overwriting valid endpoints. When the `prefix` is `/`, then **all traffic is served as static** and you must declare a prefix under `skip` (e.g.: `/api`) to match endpoints.\n\nSee: ",
"examples": [
"/media/assets"
],
"type": "string"
},
"skip": {
"title": "Skip paths",
"description": "An array with all the prefix URLs that despite they could match with the `prefix`, you don't want to treat them as static content and pass them to the router.\n\nSee: ",
"examples": [
[
"/media/ignore/this/directory",
"/media/file.json"
]
],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/server/virtualhost.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "VirtualHost",
"description": "Enterprise only. The Virtual Host server allows you to run different configurations of KrakenD endpoints based on the host accessing the server.\n\nSee: ",
"type": "object",
"oneOf": [
{
"required": [
"hosts"
]
},
{
"required": [
"aliased_hosts"
]
}
],
"properties": {
"aliased_hosts": {
"title": "Virtualhosts with alias",
"description": "A map of all recognized virtual hosts where the key is the alias and the value the host name, including the port if it's not 443 or 80. The values declared here must match the content of the `Host` header passed by the client. The alias must be an alphanumeric string.\n\nSee: ",
"examples": [
{
"user_api": "users.svc.example.com:9000"
}
],
"type": "object",
"properties": {
"[a-z0-9_]+": {
"title": "Virtualhost",
"description": "The key of this map must compile with the regexp `a-z0-9_` and the host name is the string that matches the value sent by the user in the `Host` header.",
"type": "string"
}
}
},
"hosts": {
"title": "Virtualhosts",
"description": "All recognized virtual hosts by KrakenD must be listed here. The values declared here must match the content of the `Host` header when passed by the client.\n\nSee: ",
"examples": [
[
"api-a.example.com",
"api-b.example.com"
]
],
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/gelf.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "GELF",
"description": "Send structured events in GELF format to your Graylog Cluster.\n\nSee: ",
"type": "object",
"required": [
"address",
"enable_tcp"
],
"properties": {
"address": {
"title": "Address",
"description": "The address (including the port) of your Graylog cluster (or any other service that receives GELF inputs). E.g., `myGraylogInstance:12201`\n\nSee: ",
"type": "string"
},
"enable_tcp": {
"title": "Enable TCP",
"description": "Set to false (recommended) to use UDP, or true to use TCP. TCP performance is worst than UDP under heavy load.\n\nSee: ",
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/influx.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Telemetry via influx",
"description": "Enables the extended logging capabilities.\n\nSee: ",
"type": "object",
"required": [
"address",
"ttl"
],
"properties": {
"address": {
"title": "Address",
"description": "The complete url of the influxdb including the port if different from defaults in http/https.\n\nSee: ",
"type": "string"
},
"buffer_size": {
"title": "Points in buffer",
"description": "The buffer size is a protection mechanism that allows you to temporarily store datapoints for later reporting when Influx is unavailable. If the buffer is `0`, reported metrics that fail are discarded immediately. If the buffer is a positive number, KrakenD creates a buffer with the number of datapoints set. When the buffer is full because the Influx server keeps failing, newer datapoints replace older ones in the buffer.\n\nSee: ",
"type": "integer",
"minimum": 0
},
"db": {
"title": "DB name",
"description": "Name of the InfluxDB database (Influx v1) or the bucket name (Influx v2).\n\nSee: ",
"default": "krakend",
"type": "string"
},
"password": {
"title": "Password",
"description": "Password to authenticate to InfluxDB. In Influx v2, you also need to add grant access with `influx v1 auth`.\n\nSee: ",
"type": "string"
},
"ttl": {
"title": "TTL",
"description": "TTL against Influx.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit"
},
"username": {
"title": "Username",
"description": "Username to authenticate to InfluxDB.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/logging.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Logging",
"description": "Enables the extended logging capabilities.\n\nSee: ",
"type": "object",
"required": [
"level"
],
"properties": {
"format": {
"title": "Application log format",
"description": "Specify the format of the application logs: default, logstash, or custom.\nThe custom format needs an additional key \"custom_format\".\n\nSee: ",
"examples": [
"default",
"logstash",
"custom"
],
"default": "default",
"type": "string"
},
"access_log_custom_format": {
"title": "Access log custom format",
"description": "Enterprise only. You can write the access log pattern you would like to use. Add a newline `\\n` at the end of the pattern. See the variables you can use.\n\nSee: ",
"examples": [
"%{prefix} %{time} [AccessLog] |%{statusCode}| %{latencyMs} | %{clientIP} | %{method} %{path}\n"
],
"default": "",
"type": "string"
},
"access_log_format": {
"title": "Access log format",
"description": "Enterprise only. Enable a formatter for the access log. You can write your own pattern using the `custom` value, or you can use one of the predefined ones.\n\nSee: ",
"default": "",
"enum": [
"",
"default",
"httpdCommon",
"httpdCombine",
"json",
"custom"
]
},
"access_log_missing_key_marker": {
"title": "Access log format missing key",
"description": "Enterprise only. When you use a custom access log format, the variable you are trying to print could be empty. For instance, you have added in the format `%{header.Authorization}` but the header is missing in the request. In this case, the printed value is what you configure here. If the string is set to an empty value, a dash `-` is printed. \n\nSee: ",
"examples": [
"%{default}",
"%{httpdCommon}",
"%{prefix} %{time} [AccessLog] |%{statusCode}| %{latencyMs} | %{clientIP} | %{method} %{path}\n"
],
"default": "-",
"type": "string"
},
"backend": {
"title": "Backend log format",
"description": "Enterprise only. Add a specific [Backend Log](https://www.krakend.io/docs/enterprise/logging/#backend-log). Useful to see status codes, headers, and other information that come from your backends.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1backend_log.json",
"type": "object"
},
"custom_format": {
"title": "Custom format",
"description": "Lets you write a custom logging pattern using variables, e.g: `%{message}`.\n\nSee: ",
"type": "string"
},
"level": {
"title": "Log Level",
"description": "What type of **reporting level** do you expect from the application? The options below go from more verbose to least. Use the `DEBUG` level in the development stages but not in production. Some components can add extra verbosity while in DEBUG mode and send **multiline content**, which is not always suitable for automated log parsing.\n\nSee: ",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
]
},
"prefix": {
"title": "Prefix",
"description": "Adds the defined string at the beginning of every logged line, so you can quickly filter messages with external tools later on. It's recommended to always add a prefix `[INSIDE BRACKETS]` to make use of predefined dashboards.\n\nSee: ",
"type": "string"
},
"stdout": {
"title": "Logs to stdout",
"description": "Set to true to send logs to stdout.\n\nSee: ",
"default": false,
"type": "boolean"
},
"syslog": {
"title": "Logs to syslog",
"description": "Set to true to send logs to syslog.\n\nSee: ",
"default": false,
"type": "boolean"
},
"syslog_facility": {
"title": "Syslog facility",
"description": "When using syslog, the facility tells KrakenD where to send the messages as set by the locals of the [syslog standard](https://www.rfc-editor.org/rfc/rfc5424.html).\n\nSee: ",
"default": "local3",
"enum": [
"local0",
"local1",
"local2",
"local3",
"local4",
"local5",
"local6",
"local7"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/logstash.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Logstash",
"description": "Enables logstash when the extra_config \"telemetry/logging\" is also present.\n\nSee: ",
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"title": "Enabled",
"default": true,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/metrics.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Extended metrics",
"description": "Collects extended metrics to push to InfluxDB or expose them in the /__stats/ endpoint.\n\nSee: ",
"type": "object",
"properties": {
"backend_disabled": {
"title": "Backend disabled",
"description": "Skip any metrics happening in the backend layer. Disabling layers saves memory consumption but reduces visibility.\n\nSee: ",
"default": false,
"type": "boolean"
},
"collection_time": {
"title": "Collection time",
"description": "The time window to consolidate collected metrics. Metrics are updated in their internal counters all the time, but the `/__stats/` endpoint, or the Influx reporter, won't see them updated until this window completes.\n\nSee: ",
"default": "60s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"endpoint_disabled": {
"title": "Endpoint disabled",
"description": "When true do not publish the /__stats/ endpoint. Metrics won't be accessible via the endpoint but still collected (and you can send them to Influx for instance).\n\nSee: ",
"default": false,
"type": "boolean"
},
"listen_address": {
"title": "Listen address",
"description": "Change the listening address where the metrics endpoint is exposed.\n\nSee: ",
"default": ":8090",
"type": "string",
"pattern": "^:[0-9]+$"
},
"proxy_disabled": {
"title": "Proxy disabled",
"description": "Skip any metrics happening in the proxy layer (traffic against your backends). Disabling layers saves memory consumption but reduces visibility.\n\nSee: ",
"default": false,
"type": "boolean"
},
"router_disabled": {
"title": "Router disabled",
"description": "Skip any metrics happening in the router layer (activity in KrakenD endpoints). Disabling layers saves memory consumption but reduces visibility.\n\nSee: ",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/moesif.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Moesif integration",
"description": "The Moesif integration helps you understand and monetize API usage with a robust analytics and billing platform.\n\nSee: ",
"type": "object",
"required": [
"application_id",
"user_id_headers"
],
"properties": {
"application_id": {
"title": "Collector Application ID",
"description": "The Collector Application ID is used to send events, actions, users, and companies to Moesif's Collector API. Moesif provides it under the 'API Keys' section.\n\nSee: ",
"type": "string"
},
"batch_size": {
"title": "Batch Size",
"description": "Number of events you will send on every batch reporting asynchronously to Moesif. For high throughput you will need to increase this value.\n\nSee: ",
"default": 200,
"type": "integer"
},
"debug": {
"title": "Enable debug",
"description": "Set to true when configuring Moesif for the first time while in development, to see the activity in the logs. Set to false in production.\n\nSee: ",
"default": false,
"type": "boolean"
},
"event_queue_size": {
"title": "Event Queue Size",
"description": "Sends the number of events you can hold in-memory to send them asynchronously to Moesif. If the throughput of your API generates more events than the size of the queue, the exceeding events will be discarded and not reported.\n\nSee: ",
"default": 1000000,
"type": "integer"
},
"identify_company": {
"title": "Identify company",
"description": "It sets which strategy you want to use to identify the company. Identifying the company helps you efficiently govern your API. Choose the system you wish to apply (**declare only one property**). The claim value you access must be of type string. You can access nested structured using the dot `.` separator. When using dots, literals with an exact match containing the dot are checked first.\n\nSee: ",
"type": "object",
"maxProperties": 1,
"properties": {
"header": {
"title": "Company in Header",
"description": "The company is identified using a header. Provide the header name.\n\nSee: ",
"examples": [
"X-Tenant"
],
"type": "string"
},
"jwt_claim": {
"title": "Company in Claim",
"description": "The company is stored in a claim inside the JWT. The claim must return a string.\n\nSee: ",
"examples": [
"company_id"
],
"type": "string"
},
"query_string": {
"title": "Company in Query String",
"description": "The company is always passed inside a query string when calling any URL. Provide the query string name.\n\nSee: ",
"examples": [
"company"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"log_body": {
"title": "Send the body",
"description": "Send the body of all endpoints and requests to Moesif.\n\nSee: ",
"default": true,
"type": "boolean"
},
"metadata": {
"title": "Metadata",
"description": "A free-form object that allows you to push custom metadata along with events. The custom metadata appears in Moesif under a key `krakend`, you can use nesting if needed.\n\nSee: ",
"examples": [
{
"instance_id": "1234abcd",
"region": "us-west-1"
}
],
"type": "object"
},
"request_body_masks": {
"title": "Request body masks",
"description": "The list of fields in the request body that you want to mask before sending them to Moesif. You can set `log_body` to `false` to prevent any body being sent.\n\nSee: ",
"examples": [
[
"password",
"credit_card"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"request_header_masks": {
"title": "Request header masks",
"description": "The list of request headers that you want to mask their values before sending them to Moesif.\n\nSee: ",
"examples": [
[
"Authorization"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"response_body_masks": {
"title": "Response body masks",
"description": "The list of fields in the response body that you want to mask before sending them to Moesif. You can set `log_body` to `false` to prevent any body being sent.\n\nSee: ",
"examples": [
[
"password",
"credit_card"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"response_header_masks": {
"title": "Response header masks",
"description": "The list of response headers that you want to mask their values before sending them to Moesif.\n\nSee: ",
"examples": [
[
"Cookie"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"should_skip": {
"title": "Should Skip",
"description": "Defines an expression expressed as [Security Policy](https://www.krakend.io/docs/enterprise/security-policies/) that avoids reporting to Moesif when the result of the evaluation is `true`.\n\nSee: ",
"examples": [
"( req_method=='GET' || req_path.startsWith('/bar/')) && hasHeader('X-Something')"
],
"type": "string"
},
"timer_wake_up_seconds": {
"title": "Timer Wake Up",
"description": "Specifies how often a background thread runs to send events to Moesif. Value in seconds.\n\nSee: ",
"default": 2,
"type": "integer"
},
"user_id_headers": {
"title": "User ID headers",
"description": "Defines the list of possible headers that can identify a user uniquely. When the header is `Authorization`, it automatically extracts the username if it contains an `Authorization: Basic` value with no additional configuration. If, on the other hand, you use tokens and pass an `Authorization: Bearer`, it will extract the user ID from the JWT claim defined under `user_id_jwt_claim`. If there are multiple headers in the list, all of them are tested in the given order, and the first existing header in the list is used to extract the user ID (successfully or not).\n\nSee: ",
"examples": [
[
"X-User-ID",
"Authorization"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"user_id_jwt_claim": {
"title": "User ID JWT claim",
"description": "When using JWT tokens, it defines which claim contains the user ID. The claim value you access must be of type string. You can access nested structured using the dot `.` separator. When using dots, literals with an exact match containing the dot are checked first.\n\nSee: ",
"examples": [
"sub",
"user.id"
],
"default": "sub",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/newrelic.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "NewRelic exporter",
"description": "The New Relic integration lets you push KrakenD metrics and distributed traces to your New Relic dashboard. It uses internally the official New Relic SDK and brings its features to your APM dashboard.\n\nSee: ",
"type": "object",
"required": [
"license"
],
"properties": {
"debug": {
"title": "Enable debug",
"description": "Set to true when configuring New Relic for the first time while in development, to see the activity in the logs. Set to false in production.\n\nSee: ",
"default": false,
"type": "boolean"
},
"headers_to_pass": {
"title": "Headers to pass",
"description": "Defines an explicit list of headers sent during the client request that will be reported to NewRelic, in addition to the default headers NewRelic sets. Setting the `[\"*\"]` value will send all headers sent by the client to NewRelic. Whether you declare this setting or not, you will usually receive from the NewRelic SDK the `Accept`, `Content-Type`, `User-Agent`, and `Referer` headers.\n\nSee: ",
"examples": [
[
"*"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"license": {
"title": "License key",
"description": "The API key provided by New Relic to push data into your account.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/opencensus.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Telemetry via Opencensus",
"description": "Enables the extended logging capabilities.\n\nSee: ",
"type": "object",
"required": [
"exporters"
],
"properties": {
"enabled_layers": {
"title": "Enabled Layers",
"description": "Lets you specify what data you want to export. All layers are enabled by default unless you declare this section.",
"properties": {
"backend": {
"title": "Report backend",
"description": "Reports the activity between KrakenD and your services",
"default": false,
"type": "boolean"
},
"pipe": {
"title": "Report pipe",
"description": "Reports the activity at the beginning of the proxy layer. It gives a more detailed view of the internals of the pipe between end-users and KrakenD, having into account merging of different backends.",
"default": false,
"type": "boolean"
},
"router": {
"title": "Report router",
"description": "Reports the activity between end-users and KrakenD",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
},
"exporters": {
"title": "Exporters",
"description": "The exporter(s) you would like to enable. See each exporter configuration in its own section.",
"type": "object",
"minProperties": 1,
"properties": {
"datadog": {
"title": "Datadog",
"description": "Datadog is a monitoring and security platform for developers, IT operations teams and business in the cloud.\n\nSee: ",
"type": "object",
"required": [
"namespace",
"service",
"trace_address",
"stats_address",
"tags",
"global_tags",
"disable_count_per_buckets"
],
"properties": {
"disable_count_per_buckets": {
"title": "Disable count per buckets",
"description": "Specifies whether to emit count_per_bucket metrics.\n\nSee: ",
"default": false,
"type": "boolean"
},
"global_tags": {
"title": "Global tags",
"description": "A set of tags (key/value) that will automatically be applied to all exported spans.\n\nSee: ",
"examples": [
{
"env": "prod"
}
],
"type": "object"
},
"namespace": {
"title": "Namespace",
"description": "The namespace to which metric keys are appended.\n\nSee: ",
"type": "string"
},
"service": {
"title": "Service",
"description": "Service specifies the service name used for tracing\n\nSee: ",
"examples": [
"gateway"
],
"type": "string"
},
"stats_address": {
"title": "Stats address",
"description": "Specifies the host[:port] address for DogStatsD. To enable ingestion using Unix Domain Socket (UDS) mount your UDS path and reference it in the stats_address using a path like `unix:///var/run/datadog/dsd.socket`.\n\nSee: ",
"examples": [
"localhost:8125"
],
"default": "localhost:8125",
"type": "string"
},
"tags": {
"title": "Tags",
"description": "Specifies a set of global tags to attach to each metric.\n\nSee: ",
"type": "array",
"items": {
"type": "string"
}
},
"trace_address": {
"title": "Trace address",
"description": "Specifies the host[:port] address of the Datadog Trace Agent.\n\nSee: ",
"default": "localhost:8126",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"influxdb": {
"title": "Influxdb",
"description": "Exports data to InfluxDB: A time series database designed to handle high write and query loads.\n\nSee: ",
"type": "object",
"required": [
"address",
"db"
],
"properties": {
"address": {
"title": "Address",
"description": "The URL (including port) where your InfluxDB is installed.\n\nSee: ",
"examples": [
"http://192.168.99.100:8086"
],
"type": "string"
},
"db": {
"title": "DB name",
"description": "The database name\n\nSee: ",
"examples": [
"krakend"
],
"type": "string"
},
"password": {
"title": "Password",
"description": "The password to access the database\n\nSee: ",
"examples": [
"kr4k3nd"
],
"type": "string"
},
"timeout": {
"title": "Timeout",
"description": "The maximum time you will wait for InfluxDB to respond.\n\nSee: ",
"examples": [
"2s"
],
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"username": {
"title": "Username",
"description": "The influxdb username to access the database\n\nSee: ",
"examples": [
"krakend"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"jaeger": {
"title": "Jaeger",
"description": "Submit spans to a Jaeger Collector (HTTP) with `endpoint` or to a Jaeger Agent (UDP) with `agent_endpoint`. \n\nSee ",
"type": "object",
"oneOf": [
{
"required": [
"endpoint",
"service_name"
]
},
{
"required": [
"agent_endpoint",
"service_name"
]
}
],
"properties": {
"agent_endpoint": {
"title": "Agent Endpoint",
"description": "The address where the Jaeger Agent is (Thrift over UDP), e.g., `jaeger:6831`\n\nSee: ",
"examples": [
"http://192.168.99.100:14268/api/traces"
],
"type": "string"
},
"buffer_max_count": {
"title": "Buffer max count",
"description": "Total number of traces to buffer in memory\n\nSee: ",
"type": "integer"
},
"endpoint": {
"title": "Collector Endpoint",
"description": "The full URL including port indicating where your Jaeger Collector is (Thrift over HTTP/S), e.g., ``\n\nSee: ",
"examples": [
"http://192.168.99.100:14268/api/traces"
],
"type": "string"
},
"service_name": {
"title": "Service name",
"description": "The service name registered in Jaeger\n\nSee: ",
"examples": [
"krakend"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"logger": {
"title": "Logger",
"description": "Opencensus can export data to the system logger as another exporter. Recommended to use `telemetry/logging` instead.\n\nSee: ",
"type": "object",
"properties": {
"spans": {
"title": "Spans",
"description": "Whether to log the spans or not",
"default": false,
"type": "boolean"
},
"stats": {
"title": "Stats",
"description": "Whether to log the statistics or not",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"ocagent": {
"title": "Ocagent",
"description": "Exporting metrics, logs, and events to the OpenCensus Agent.\n\nSee: ",
"type": "object",
"required": [
"address",
"service_name"
],
"properties": {
"address": {
"title": "Address",
"description": "The address of your Azure Monitor collector.\n\nSee: ",
"examples": [
"localhost:55678"
],
"type": "string"
},
"enable_compression": {
"title": "Enable compression",
"description": "Whether to send data compressed or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"headers": {
"title": "Headers",
"description": "List of keys and values for the headers sent. Keys and values must be of type string.\n\nSee: ",
"examples": [
{
"header1": "value1"
}
],
"type": "object"
},
"insecure": {
"title": "Insecure",
"description": "Whether the connection can be established in plain (insecure) or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"reconnection": {
"title": "Reconnection",
"description": "The reconnection time\n\nSee: ",
"default": "2s",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
},
"service_name": {
"title": "Service name",
"description": "An identifier of your service, e.g, `krakend`.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"prometheus": {
"title": "Prometheus",
"description": "Prometheus is an open-source systems monitoring and alerting toolkit.",
"type": "object",
"required": [
"port"
],
"properties": {
"namespace": {
"title": "Namespace",
"description": "Sets the domain the metric belongs to.\n\nSee: ",
"type": "string"
},
"port": {
"title": "Port",
"description": "Port on which the Prometheus exporter should listen\n\nSee: ",
"examples": [
9091
],
"type": "integer"
},
"tag_host": {
"title": "Tag host",
"description": "Whether to send the host as a metric or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"tag_method": {
"title": "Tag method",
"description": "Whether to send the HTTP method as a metric or not.\n\nSee: ",
"default": true,
"type": "boolean"
},
"tag_path": {
"title": "Tag path",
"description": "Whether to send the path as a metric or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"tag_statuscode": {
"title": "Tag status code",
"description": "Whether to send the status code as a metric or not.\n\nSee: ",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"stackdriver": {
"title": "Stackdriver",
"description": "Export metrics and traces to Google Cloud",
"type": "object",
"required": [
"project_id",
"default_labels"
],
"properties": {
"default_labels": {
"title": "Default_labels",
"description": "A map object. Enter here any label that will be assigned by default to the reported metric so you can filter later on Stack Driver.\n\nSee: ",
"examples": [
{
"env": "production"
}
],
"type": "object"
},
"metric_prefix": {
"title": "Metric_prefix",
"description": "A prefix that you can add to all your metrics for better organization.\n\nSee: ",
"type": "string"
},
"project_id": {
"title": "Project_id",
"description": "The identifier of your Google Cloud project. The `project_id` **is not the project name**. You can omit this value from the configuration if you have an application credential file for Google.\n\nSee: ",
"examples": [
"ID"
],
"default": "",
"type": "string",
"pattern": "^.*$"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"xray": {
"title": "AWS X-ray",
"description": "AWS X-Ray is a service offered by Amazon that provides an end-to-end view of requests as they travel through your application, and shows a map of your application's underlying components.",
"type": "object",
"oneOf": [
{
"required": [
"region",
"version",
"access_key_id",
"secret_access_key"
]
},
{
"required": [
"region",
"version",
"use_env"
]
}
],
"required": [
"region",
"version"
],
"properties": {
"access_key_id": {
"title": "AWS access key id",
"description": "Your access key ID provided by Amazon. Needed when `use_env` is unset or set to false.\n\nSee: ",
"type": "string"
},
"region": {
"title": "Region",
"description": "The AWS geographical region, e.g, `us-east-1`.\n\nSee: ",
"examples": [
"eu-west-1"
],
"type": "string"
},
"secret_access_key": {
"title": "AWS secret access key",
"description": "Your secret access key provided by Amazon. Needed when `use_env` is unset or set to false.\n\nSee: ",
"type": "string"
},
"use_env": {
"title": "Use_env",
"description": "When true the AWS credentials (access_key_id and secret_access_key) are taken from environment vars. Don't specify them then.\n\nSee: ",
"default": false,
"type": "boolean"
},
"version": {
"title": "Version",
"description": "The version of the AWS X-Ray service to use.\n\nSee: ",
"default": "KrakenD-opencensus",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"zipkin": {
"title": "Zipkin",
"description": "Export telemetry data to a Zipkin collector",
"type": "object",
"required": [
"collector_url",
"service_name"
],
"properties": {
"collector_url": {
"title": "Collector URL",
"description": "The URL (including port and path) where your Zipkin is accepting the spans, e.g., ``\n\nSee: ",
"examples": [
"http://192.168.99.100:9411/api/v2/spans"
],
"type": "string"
},
"service_name": {
"title": "Service name",
"description": "The service name registered in Zipkin.\n\nSee: ",
"examples": [
"krakend"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"reporting_period": {
"title": "Reporting period",
"description": "The number of seconds passing between reports. If duration is less than or equal to zero, it enables the default behavior of each exporter.\n\nSee: ",
"default": 0,
"type": "integer"
},
"sample_rate": {
"title": "Sample rate",
"description": "A number between 0 (no requests at all) and 100 (all requests) representing the percentage of sampled requests you want to send to the exporter. **Sampling the 100% of the requests is generally discouraged** when the relationship between traffic and dedicated resources is sparse.\n\nSee: ",
"default": 0,
"type": "integer",
"maximum": 100,
"minimum": 0
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/opentelemetry.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "OpenTelemetry",
"description": "Enables metrics and traces using OpenTelemetry.\n\nSee: ",
"type": "object",
"required": [
"exporters"
],
"properties": {
"deploy_env": {
"title": "Deploy Environment",
"description": "The environment you are deploying, this can be useful for deployment tracking. The string can have any value that makes sense to you to identify the running environment.\n\nSee: ",
"examples": [
"development",
"testing",
"staging",
"production"
],
"default": "",
"type": "string"
},
"exporters": {
"title": "Exporters",
"description": "The places where you will send telemetry data. You can declare multiple exporters even when they are of the same type. For instance, when you have a self-hosted Grafana and would like to migrate to its cloud version and check the double reporting during the transition. There are two families of exporters: `otlp` or `prometheus`.\n\nSee: ",
"type": "object",
"minProperties": 1,
"properties": {
"otlp": {
"title": "OTLP exporters",
"description": "The list of OTLP exporters you want to use. Set at least one object to push metrics and traces to an external collector using OTLP.\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"required": [
"name",
"host"
],
"properties": {
"custom_metric_reporting_period": {
"title": "Custom metric reporting period",
"description": "Whether you want to override the global `metric_reporting_period` attribute set for all exporters or not. Value in seconds. A missing attribute, or set to `0` means using whatever value was used in `metric_reporting_period` at the global level.\n\nSee: ",
"default": 0,
"type": "integer"
},
"disable_metrics": {
"title": "Disable metrics",
"description": "Disable metrics in this exporter (leaving only traces if any). It won't report any metrics when the flag is `true`.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_traces": {
"title": "Disable traces",
"description": "Disable traces in this exporter (leaving only metrics if any). It won't report any metrics when the flag is `true`.\n\nSee: ",
"default": false,
"type": "boolean"
},
"host": {
"title": "Host",
"description": "The host where you want to push the data. It can be a sidecar or a remote collector.\n\nSee: ",
"type": "string"
},
"name": {
"title": "Name",
"description": "A unique name to identify this exporter.\n\nSee: ",
"examples": [
"local_prometheus",
"remote_grafana"
],
"type": "string"
},
"port": {
"title": "Port",
"description": "A custom port to send the data. The port defaults to 4317 for gRPC unless you enable `use_http`, which defaults to 4318.\n\nSee: ",
"default": 4317,
"type": "integer",
"maximum": 65535,
"minimum": 0
},
"use_http": {
"title": "Use HTTP",
"description": "Whether this exporter uses HTTP instead of gRPC.\n\nSee: ",
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
}
},
"prometheus": {
"title": "Prometheus exporter",
"description": "Set here at least the settings for one Prometheus exporter. Each exporter will start a local port that offers metrics to be pulled from KrakenD.\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"required": [
"name"
],
"properties": {
"custom_metric_reporting_period": {
"title": "Custom metric reporting period",
"description": "Whether you want to override the global `metric_reporting_period` attribute set for all exporters or not. Value in seconds. A missing attribute, or set to `0` means using whatever value was used in `metric_reporting_period` at the global level.\n\nSee: ",
"default": 0,
"type": "integer"
},
"disable_metrics": {
"title": "Disable metrics",
"description": "Leave this exporter declared but disabled (useful in development). It won't report any metrics when the flag is `true`.\n\nSee: ",
"default": false,
"type": "boolean"
},
"go_metrics": {
"title": "Go Metrics",
"description": "Whether you want fine-grained details of Go language metrics or not.\n\nSee: ",
"type": "boolean"
},
"listen_ip": {
"title": "Listen IP",
"description": "The IP address that KrakenD listens to in IPv4 or IPv6. You can, for instance, expose the Prometheus metrics only in a private IP address. An empty string, or no declaration means listening on all interfaces. The inclusion of `::` is intended for IPv6 format only (**this is not the port**). Examples of valid addresses are `192.0.2.1` (IPv4), `2001:db8::68` (IPv6). The values `::` and `0.0.0.0` listen to all addresses, which are valid for IPv4 and IPv6 simultaneously.",
"examples": [
"172.12.1.1",
"::1"
],
"default": "0.0.0.0",
"type": "string"
},
"name": {
"title": "Name",
"description": "A unique name to identify this exporter.\n\nSee: ",
"examples": [
"local_prometheus",
"remote_grafana"
],
"type": "string"
},
"port": {
"title": "Port",
"description": "The port in KrakenD where Prometheus will connect to.\n\nSee: ",
"default": 9090,
"type": "integer",
"maximum": 65535,
"minimum": 0
},
"process_metrics": {
"title": "Process Metrics",
"description": "Whether this exporter shows detailed metrics about the running process like CPU or memory usage or not.\n\nSee: ",
"type": "boolean"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"histograms": {
"title": "Histograms",
"description": "Use an histogram bucket configuration different from the defaults to define the detail of histogram metrics (decrease or increase their size). You don't need to set this attribute unless you want full control of the histogram definition.\n\nSee: ",
"type": "object",
"properties": {
"size_buckets": {
"title": "Size buckets",
"description": "The size of the buckets in bytes you want to use for the histograms.\n\nSee: ",
"default": [
128,
256,
512,
1024,
4096,
8192,
16384,
32768,
65536,
262144,
524288,
1048576,
4194304,
16777216,
67108864
],
"type": "array",
"items": {
"type": "number"
}
},
"time_buckets": {
"title": "Time buckets",
"description": "The duration of buckets in seconds you want to use for the histograms.\n\nSee: ",
"default": [
0.01,
0.02,
0.05,
0.075,
0.1,
0.125,
0.15,
0.175,
0.2,
0.25,
0.3,
0.35,
0.5,
0.75,
1.0,
1.5,
2.0,
3.5,
5.0,
10.0
],
"type": "array",
"items": {
"type": "number"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"layers": {
"title": "Layers",
"description": "A request and response flow passes through three different layers. This attribute lets you specify what data you want to export in each layer. All layers are enabled by default unless you declare this section.\n\nSee: ",
"type": "object",
"properties": {
"backend": {
"title": "Report backend activity",
"description": "Reports the activity between KrakenD and each of your backend services. This is the more granular layer.\n\nSee: ",
"type": "object",
"properties": {
"metrics": {
"type": "object",
"properties": {
"detailed_connection": {
"title": "Detailed HTTP connection metrics",
"description": "Whether you want to enable detailed metrics for the HTTP connection phase or not. Includes times to connect, DNS querying, and the TLS handshake.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_stage": {
"title": "Disable this stage",
"description": "Whether to turn off the metrics or not. Setting this to `true` means stop reporting any data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"read_payload": {
"title": "Detailed payload read",
"description": "Whether you want to enable metrics for the response reading payload or not (HTTP connection not taken into account).\n\nSee: ",
"default": false,
"type": "boolean"
},
"round_trip": {
"title": "Detailed Round Trip",
"description": "Whether you want to enable metrics for the actual HTTP request for the backend or not (manipulation not taken into account). This is the time your backend needs to produce a result.\n\nSee: ",
"default": false,
"type": "boolean"
},
"static_attributes": {
"title": "Static attributes",
"description": "A list of tags or labels you want to associate with these metrics.\n\nSee: ",
"examples": [
[
{
"key": "my_metric_attr",
"value": "my_metric_val"
}
]
],
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"title": "Key",
"description": "The key, tag, or label name you want to use.\n\nSee: ",
"type": "string"
},
"value": {
"title": "Value",
"description": "The static value you want to assign to this key.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"traces": {
"type": "object",
"properties": {
"detailed_connection": {
"title": "Detailed HTTP connection",
"description": "Whether you want to add detailed trace attributes for the HTTP connection phase or not. Includes times to connect, DNS querying, and the TLS handshake.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_stage": {
"title": "Disable this stage",
"description": "Whether to turn off the traces or not. Setting this to `true` means stop reporting any data.\n\nSee: ",
"default": false,
"type": "boolean"
},
"read_payload": {
"title": "Detailed payload read",
"description": "Whether you want to add trace attributes for the response reading payload or not (HTTP connection not taken into account).\n\nSee: ",
"default": false,
"type": "boolean"
},
"report_headers": {
"title": "Report headers",
"description": "Whether you want to report the final headers that reached the backend.\n\nSee: ",
"default": false,
"type": "boolean"
},
"round_trip": {
"title": "Detailed Round Trip",
"description": "Whether you want to add trace attributes for the actual HTTP request for the backend or not (manipulation not taken into account). This is the time your backend needs to produce a result.\n\nSee: ",
"default": false,
"type": "boolean"
},
"skip_headers": {
"title": "Skip headers",
"description": "A list of headers you want to skip when reporting the headers that reached the backend. This is useful to avoid reporting sensitive data.\n\nSee: ",
"examples": [
[
"X-Backend-Secret",
"X-All-Secret"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"static_attributes": {
"title": "Static attributes",
"description": "A list of tags or labels you want to associate to these traces.\n\nSee: ",
"examples": [
[
{
"key": "my_trace_attr",
"value": "my_trace_val"
}
]
],
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"title": "Key",
"description": "The key, tag, or label name you want to use.\n\nSee: ",
"type": "string"
},
"value": {
"title": "Value",
"description": "The static value you want to assign to this key.\n\nSee: ",
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"global": {
"title": "Report global activity",
"description": "Reports the activity between end-users and KrakenD\n\nSee: ",
"type": "object",
"properties": {
"disable_metrics": {
"title": "Disable global metrics",
"description": "Whether you want to disable all metrics happening in the global layer or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_propagation": {
"title": "Disable propagation",
"description": "Whether you want to ignore previous propagation headers to KrakenD. When the flag is set to `true`, spans from a previous layer will never be linked to the KrakenD trace.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_traces": {
"title": "Disable global trace",
"description": "Whether you want to disable all traces happening in the global layer or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"metrics_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for metrics.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
},
"report_headers": {
"title": "Report headers",
"description": "Whether you want to send all headers that the consumer passed in the request or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"skip_headers": {
"title": "Skip headers",
"description": "A list of headers you want to skip when reporting the headers from the request. This is useful to avoid reporting sensitive data.\n\nSee: ",
"examples": [
[
"X-Request-Api-Key",
"X-Signature"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"semantic_convention": {
"title": "Semantic convention naming",
"description": "The semantic convention naming you want to use. The default is an empty string which uses the original naming convention prior to 1.27. For the semantic convention of 1.27 and higher, use `1.27`\n\nSee: ",
"enum": [
"",
"1.27"
]
},
"traces_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for traces.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"proxy": {
"title": "Report proxy activity",
"description": "Reports the activity at the beginning of the proxy layer, including spawning the required requests to multiple backends, merging, endpoint transformation and any other internals of the proxy between the request processing and the backend communication\n\nSee: ",
"type": "object",
"properties": {
"disable_metrics": {
"title": "Disable proxy metrics",
"description": "Whether you want to disable all metrics happening in the proxy layer or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disable_traces": {
"title": "Disable proxy trace",
"description": "Whether you want to disable all traces happening in the proxy layer or not.\n\nSee: ",
"default": false,
"type": "boolean"
},
"metrics_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for metrics.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
},
"report_headers": {
"title": "Report headers",
"description": "Whether you want to report all headers that passed from the request to the proxy layer (`input_headers` policy in the endpoint plus KrakenD's headers).\n\nSee: ",
"default": false,
"type": "boolean"
},
"skip_headers": {
"title": "Skip headers",
"description": "A list of headers you want to skip when reporting headers passed to the proxy layer. This is useful to avoid reporting sensitive data.\n\nSee: ",
"examples": [
[
"X-Sensitive-Data",
"X-Signature"
]
],
"type": "array",
"items": {
"type": "string"
}
},
"traces_static_attributes": {
"title": "Static attributes",
"description": "Static attributes you want to pass for traces.",
"type": "array",
"items": {
"properties": {
"key": {
"title": "Key",
"description": "The key of the static attribute you want to send",
"type": "string"
},
"value": {
"title": "Value",
"description": "The value of the static attribute you want to send",
"type": "string"
}
},
"additionalProperties": false,
"type": "object"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"metric_reporting_period": {
"title": "Reporting period",
"description": "How often you want to report and flush the metrics in seconds. This setting is only used by `otlp` exporters.\n\nSee: ",
"default": 30,
"type": "integer"
},
"service_name": {
"title": "Service Name",
"description": "A friendly name identifying metrics reported by this installation. When unset, it uses the `name` attribute in the root level of the configuration.\n\nSee: ",
"type": "string"
},
"service_version": {
"title": "Service Version",
"description": "The version you are deploying, this can be useful for deployment tracking.\n\nSee: ",
"type": "string"
},
"skip_paths": {
"title": "Skip Paths",
"description": "The paths you don't want to report. Use the literal value used in the `endpoint` definition, including any `{placeholders}`. In the `global` layer, this attribute works only on metrics, because traces are initiated before there is an endpoint to match against. If you do not want any path skipped, just add an array with an empty string `[\"\"]`.\n\nSee: ",
"examples": [
[
"/foo/{bar}"
]
],
"default": [
"/__health",
"/__debug/",
"/__echo/",
"/__stats/"
],
"type": "array",
"items": {
"type": "string"
}
},
"trace_sample_rate": {
"title": "Trace sample rate",
"description": "The sample rate for traces defines the percentage of reported traces. This option is key to reduce the amount of data generated (and resource usage), while you still can debug and troubleshoot issues. For instance, a number of `0.25` will report a 25% of the traces seen in the system.\n\nSee: ",
"examples": [
0.25
],
"default": 1,
"type": "number",
"maximum": 1,
"minimum": 0
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/telemetry/opentelemetry-security.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "OpenTelemetry Security",
"description": "Enables the security layer needed to use OpenTelemetry through the Internet, like pushing data to a SaaS provider.\n\nSee: ",
"type": "object",
"required": [
"otlp"
],
"properties": {
"otlp": {
"title": "OTLP exporters",
"description": "The list of OTLP exporters that require authentication. Set at least one object to push metrics and traces to an external collector using OTLP.\n\nSee: ",
"type": "array",
"minItems": 1,
"items": {
"required": [
"name",
"headers"
],
"properties": {
"headers": {
"title": "Headers",
"description": "The custom headers you will send to authenticate requests. Each key is the header name you will add to all outgoing reports.\n\nSee: ",
"type": "object",
"properties": {
".*": {
"title": "Header value",
"description": "The value of the header, usually an API token.",
"type": "string"
}
}
},
"name": {
"title": "Name",
"description": "The **exact name** you used to define the exporter under `telemetry/opentelemetry`.\n\nSee: ",
"examples": [
"newrelic",
"remote_datadog"
],
"type": "string"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
}
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/service_extra_config.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "Schema definition for service extra_config",
"type": "object",
"properties": {
"ai/mcp": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1ai~1mcp.json"
},
"auth/api-keys": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1api-keys.json"
},
"auth/basic": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1basic.json"
},
"auth/revoker": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1revoker.json"
},
"auth/validator": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1auth~1jose.json"
},
"documentation/openapi": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1documentation~1openapi.json"
},
"documentation/postman": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1documentation~1postman.json"
},
"governance/processors": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1governance~1processors.json"
},
"governance/quota": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1governance~1quota.json"
},
"grpc": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1grpc.json"
},
"modifier/lua-endpoint": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1lua.json"
},
"modifier/request-body-extractor": {
"title": "Request Body Extractor",
"description": "Enterprise only. [Extracts fields from the incoming request body](https://www.krakend.io/docs/enterprise/endpoints/request-body-extractor/) and promotes them to request headers or query strings at the service level, applying to every incoming request.",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1request-body-extractor.json"
},
"modifier/response-headers": {
"title": "Response Headers modifier",
"description": "Enterprise only. Allows you to transform response headers declaratively.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1modifier~1response-headers.json"
},
"plugin/http-server": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1plugin~1http-server.json"
},
"qos/ratelimit/service": {
"title": "Service Rate-limiting",
"description": "Enterprise only. The service rate limit feature allows you to set the maximum requests per second a user or group of users can do to KrakenD and works analogously to the endpoint rate limit.\n\nSee: ",
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1router.json"
},
"qos/ratelimit/service/redis": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1redis.json"
},
"qos/ratelimit/tiered": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1qos~1ratelimit~1tiered.json"
},
"redis": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1redis.json"
},
"router": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1router.json"
},
"security/bot-detector": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1security~1bot-detector.json"
},
"security/cors": {
"title": "Cross Origin Resource Sharing",
"description": "When KrakenD endpoints are consumed from a browser, you might need to enable the Cross-Origin Resource Sharing (CORS) module as browsers restrict cross-origin HTTP requests initiated from scripts.\n\nSee: ",
"default": {
"allow_methods": [
"POST",
"GET"
],
"allow_origins": [
"http://foobar.com"
],
"max_age": "12h"
},
"type": "object",
"required": [
"allow_origins"
],
"properties": {
"allow_credentials": {
"title": "Allow_credentials",
"description": "When requests can include user credentials like cookies, HTTP authentication or client side SSL certificates\n\nSee: ",
"default": true,
"type": "boolean"
},
"allow_headers": {
"title": "Allowed headers",
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"allow_methods": {
"title": "Allowed methods",
"description": "The array of all HTTP methods accepted, in uppercase.\n\nSee: ",
"type": "array",
"uniqueItems": true,
"items": {
"title": "Object in array",
"description": "See: ",
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS"
]
}
},
"allow_origins": {
"title": "Allowed origins",
"description": "An array with all the origins allowed, examples of values are , or * (any origin).\n\nSee: ",
"type": "array",
"items": {
"title": "Allowed origins list",
"examples": [
"*",
"https://example.com"
],
"type": "string"
}
},
"debug": {
"title": "Show debug",
"description": "Show debugging information in the logger, to be used only during development.\n\nSee: ",
"default": true,
"type": "boolean"
},
"expose_headers": {
"title": "Expose headers",
"description": "Headers that are safe to expose to the API of a CORS API specification-\n\nSee: ",
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"max_age": {
"title": "Max age",
"description": "For how long the response can be cached.\n\nSee: ",
"examples": [
"12h"
],
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1timeunits.json/$defs/timeunit",
"type": "string"
}
}
},
"security/http": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1security~1http.json"
},
"server/static-filesystem": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1server~1static-filesystem.json"
},
"server/virtualhost": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1server~1virtualhost.json"
},
"telemetry/gelf": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1gelf.json"
},
"telemetry/influx": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1influx.json"
},
"telemetry/logging": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1logging.json"
},
"telemetry/logstash": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1logstash.json"
},
"telemetry/metrics": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1metrics.json"
},
"telemetry/moesif": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1moesif.json"
},
"telemetry/newrelic": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1newrelic.json"
},
"telemetry/opencensus": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1opencensus.json"
},
"telemetry/opentelemetry": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1opentelemetry.json"
},
"telemetry/opentelemetry-security": {
"$ref": "#/$defs/https:~1~1www.krakend.io~1schema~1v2.13~1telemetry~1opentelemetry-security.json"
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
}
},
"https://www.krakend.io/schema/v2.13/tls.json": {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"title": "TLS/SSL",
"description": "Enabling TLS for HTTPS and HTTP/2.\n\nSee: ",
"anyOf": [
{
"type": "object",
"required": [
"keys"
]
},
{
"type": "null"
}
],
"properties": {
"ca_certs": {
"title": "CA certificates (for mTLS)",
"description": "An array with all the CA certificates you would like to load to KrakenD **when using mTLS**, in addition to the certificates present in the system's CA. Each certificate in the list is a relative or absolute path to the PEM file. If you have a format other than PEM, you must convert the certificate to PEM using a conversion tool. See also `disable_system_ca_pool` to avoid system's CA.\n\nSee: ",
"examples": [
[
"ca.pem"
]
],
"default": [],
"type": "array",
"items": {
"type": "string"
}
},
"cipher_suites": {
"title": "Cipher Suites",
"description": "The list of cipher suites as defined in the documentation.\n\nSee: ",
"default": [
4865,
4866,
4867
],
"type": "array",
"uniqueItems": true,
"items": {
"type": "integer"
}
},
"curve_preferences": {
"title": "Curve identifiers",
"description": "The list of all the identifiers for the curve preferences. Use `23` for CurveP256, `24` for CurveP384 or `25` for CurveP521.\n\nSee: ",
"default": [
23,
24,
25
],
"type": "array",
"uniqueItems": true,
"items": {
"enum": [
23,
24,
25
]
}
},
"disable_system_ca_pool": {
"title": "Disable system's CA",
"description": "Ignore any certificate in the system's CA. The only certificates loaded will be the ones in the `ca_certs` list when true.\n\nSee: ",
"default": false,
"type": "boolean"
},
"disabled": {
"title": "Disable TLS",
"description": "A flag to disable TLS (useful while in development).\n\nSee: ",
"default": false,
"type": "boolean"
},
"enable_mtls": {
"title": "Enable Mutual Authentication",
"description": "Whether to enable or not Mutual Authentication. When mTLS is enabled, **all KrakenD endpoints** require clients to provide a known client-side X.509 authentication certificate. KrakenD relies on the system’s CA to validate certificates.\n\nSee: ",
"default": false,
"type": "boolean"
},
"keys": {
"description": "An array with all the key pairs you want the TLS to work with. You can support multiple and unrelated domains in a single process.",
"type": "array",
"minItems": 1,
"items": {
"properties": {
"private_key": {
"title": "Private key",
"description": "Absolute path to the private key, or relative to the current [working directory](https://www.krakend.io/docs/configuration/working-directory/).\n\nSee: ",
"examples": [
"/path/to/key.pem",
"./certs/key.pem"
],
"default": "./certs/key.pem",
"type": "string"
},
"public_key": {
"title": "Public key",
"description": "Absolute path to the public key, or relative to the current [working directory](https://www.krakend.io/docs/configuration/working-directory/).\n\nSee: ",
"examples": [
"/path/to/cert.pem",
"./certs/cert.pem"
],
"default": "./certs/cert.pem",
"type": "string"
}
}
}
},
"max_version": {
"title": "Maximum TLS version",
"description": "Maximum TLS version supported.\n\nSee: ",
"default": "TLS13",
"enum": [
"SSL3.0",
"TLS10",
"TLS11",
"TLS12",
"TLS13"
]
},
"min_version": {
"title": "Minimum TLS version",
"description": "Minimum TLS version supported. When specifiying very old and insecure versions under TLS12 you must provide the `ciphers_list`.\n\nSee: ",
"default": "TLS13",
"enum": [
"SSL3.0",
"TLS10",
"TLS11",
"TLS12",
"TLS13"
]
}
},
"additionalProperties": false,
"patternProperties": {
"^[@$_#]": true
},
"type": "object"
}
},
"additionalProperties": false,
"required": [
"version"
]
}