Reference

This section will give you an insight on every resource supported by the Perses API. While it can give you some explanations about the purpose of each resource, this documentation is mainly for users that would like to interact directly with the API and manipulate the resources without using the UI.

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#

1. Project
2. Dashboard
   1. Specification
   2. API definition
3. Datasource
   1. Choose a scope
   2. Specification
   3. API definition
4. EphemeralDashboard
   1. Specification
   2. API definition
5. Secret
   1. Specification
   2. API definition
6. User
   1. Specification
   2. API definition
7. Variable
   1. Choose a scope
   2. Specification
   3. API definition
8. Role
   1. Choose a scope
   2. Specification
   3. API definition
9. RoleBinding
   1. Choose a scope
   2. Specification
   3. API definition
10. Plugin
    1. Panel
       1. BarChart
       2. GaugeChart
       3. Markdown
       4. StatChart
       5. TimeSeriesChart
    2. Prometheus
       1. Datasource
       2. Query
       3. Variable