Skip to content

API Reference#

This section will give you insights into every resource supported by the Perses API, as well as the available API endpoints in general. While it offers explanations about the purpose of each resource, this documentation is mainly intended for users who want to interact directly with the API — whether to manipulate resources without using the UI or to perform other operations.

On the different documentations, you will find the definition of each resource in the yaml format. Brackets indicate that a parameter is optional.

Generic placeholders are defined as follows:

  • <boolean>: a boolean that can take the values true or false
  • <duration>: a duration matching the regular expression ((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0), e.g. 1d, 1h30m, 5m, 10s
  • <filename>: a valid path in the current working directory
  • <path>: a valid URL path
  • <int>: an integer value
  • <secret>: a regular string that is a secret, such as a password
  • <string>: a regular string

Table of contents#