KrakenD framework joins the Linux Foundation. Read more.

Community docs (current)

Recent changes

KrakenD file supported formats

The expected configuration file format by default is json, but KrakenD can parse different formats if one of the following is found:

  • krakend.json
  • krakend.toml
  • krakend.yaml
  • krakend.yml
  • krakend.props
  • krakend.prop
  • krakend.hcl

Nevertheless, our recommendation is to choose JSON.

Validate the syntax (not the logic) with krakend check

Why choosing json?

You are free to choose YAML, TOML or any of the other formats at your best convenience. But have in mind the following logic when choosing a file format other than json.

Using the UI: If you intend to generate or edit your configuration file using the KrakenDesigner, the input and output are always a .json file.

Flexible Configuration: If you want to split the configuration file into different pieces or use variables inside the configuration, the flexible configuration needs JSON.

Documentation: All our examples in the documentation and repositories are today shown in JSON format, so it’s always more convenient to reuse snippets of code.

Unresolved issues?

The documentation is only a piece of the help you can get! Whether you are looking for Open Source or Enterprise support, see more support channels that can help you.

We use cookies to understand how you use our site and to improve your overall experience. By continuing to use our site, you accept our Privacy Policy. More information