Skip to main content

API reference

Fyma API tries to be as RESTful as possible, meaning that it

  • consumes and produces JSON
  • tries to have predictable URLs such as /tracking-cameras, /parking-lots etc.

In example snippets such as these we use the httpie CLI:



Our API reference tries to adhere to TypeScript.

  • Primitive types refer to TypeScript types (number, boolean, string etc).
  • Optional properties are denoted with a ?.