Perses

Perses is an open-source monitoring and dashboarding tool designed as a modern alternative for visualizing time-series data with a focus on performance, extensibility, and GitOps. Perses exposes a REST API for managing dashboards, datasources, ephemeral dashboards, projects, roles, role bindings, secrets, users, variables, plugins, validation, and migrations. It is a CNCF sandbox project.

1 APIs 0 Features

CNCFDashboardsMonitoringObservabilityOpen SourceTime SeriesVisualization

APIs

Perses API

The Perses REST API provides programmatic access to dashboards, datasources, ephemeral dashboards, projects, roles, role bindings, secrets, users, variables, plugins, validation...

Collections

Perses API

OPEN

Pricing Plans

Perses Plans Pricing

3 plans

PLANS

Rate Limits

Perses Rate Limits

5 limits

RATE LIMITS

FinOps

Perses Finops

FINOPS

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Perses API
  version: 1.0.0
items:
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: List projects
      type: http
    http:
      method: GET
      url: http://{persesHost}/api/v1/projects
      params:
      - name: name
        value: ''
        type: query
        description: Optional name prefix filter.
    docs: List projects
  - info:
      name: Create a project
      type: http
    http:
      method: POST
      url: http://{persesHost}/api/v1/projects
      body:
        type: json
        data: '{}'
    docs: Create a project
  - info:
      name: Get a project by name
      type: http
    http:
      method: GET
      url: http://{persesHost}/api/v1/projects/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Get a project by name
  - info:
      name: Update a project
      type: http
    http:
      method: PUT
      url: http://{persesHost}/api/v1/projects/:name
      params:
      - name: name
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a project
  - info:
      name: Delete a project
      type: http
    http:
      method: DELETE
      url: http://{persesHost}/api/v1/projects/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Delete a project
- info:
    name: Dashboards
    type: folder
  items:
  - info:
      name: List dashboards in a project
      type: http
    http:
      method: GET
      url: http://{persesHost}/api/v1/projects/:projectName/dashboards
      params:
      - name: projectName
        value: ''
        type: path
      - name: name
        value: ''
        type: query
        description: Optional name prefix filter.
    docs: List dashboards in a project
  - info:
      name: Create a dashboard
      type: http
    http:
      method: POST
      url: http://{persesHost}/api/v1/projects/:projectName/dashboards
      params:
      - name: projectName
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create a dashboard
  - info:
      name: Get a dashboard
      type: http
    http:
      method: GET
      url: http://{persesHost}/api/v1/projects/:projectName/dashboards/:dashboardName
      params:
      - name: projectName
        value: ''
        type: path
      - name: dashboardName
        value: ''
        type: path
    docs: Get a dashboard
  - info:
      name: Update a dashboard
      type: http
    http:
      method: PUT
      url: http://{persesHost}/api/v1/projects/:projectName/dashboards/:dashboardName
      params:
      - name: projectName
        value: ''
        type: path
      - name: dashboardName
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a dashboard
  - info:
      name: Delete a dashboard
      type: http
    http:
      method: DELETE
      url: http://{persesHost}/api/v1/projects/:projectName/dashboards/:dashboardName
      params:
      - name: projectName
        value: ''
        type: path
      - name: dashboardName
        value: ''
        type: path
    docs: Delete a dashboard
- info:
    name: Datasources
    type: folder
  items:
  - info:
      name: List project datasources
      type: http
    http:
      method: GET
      url: http://{persesHost}/api/v1/projects/:projectName/datasources
      params:
      - name: projectName
        value: ''
        type: path
      - name: name
        value: ''
        type: query
      - name: kind
        value: ''
        type: query
      - name: default
        value: ''
        type: query
    docs: List project datasources
  - info:
      name: Create a project datasource
      type: http
    http:
      method: POST
      url: http://{persesHost}/api/v1/projects/:projectName/datasources
      params:
      - name: projectName
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create a project datasource
  - info:
      name: Get a project datasource
      type: http
    http:
      method: GET
      url: http://{persesHost}/api/v1/projects/:projectName/datasources/:datasourceName
      params:
      - name: projectName
        value: ''
        type: path
      - name: datasourceName
        value: ''
        type: path
    docs: Get a project datasource
  - info:
      name: Update a project datasource
      type: http
    http:
      method: PUT
      url: http://{persesHost}/api/v1/projects/:projectName/datasources/:datasourceName
      params:
      - name: projectName
        value: ''
        type: path
      - name: datasourceName
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a project datasource
  - info:
      name: Delete a project datasource
      type: http
    http:
      method: DELETE
      url: http://{persesHost}/api/v1/projects/:projectName/datasources/:datasourceName
      params:
      - name: projectName
        value: ''
        type: path
      - name: datasourceName
        value: ''
        type: path
    docs: Delete a project datasource
- info:
    name: Global Datasources
    type: folder
  items:
  - info:
      name: List global datasources
      type: http
    http:
      method: GET
      url: http://{persesHost}/api/v1/globaldatasources
      params:
      - name: name
        value: ''
        type: query
      - name: kind
        value: ''
        type: query
      - name: default
        value: ''
        type: query
    docs: List global datasources
  - info:
      name: Create a global datasource
      type: http
    http:
      method: POST
      url: http://{persesHost}/api/v1/globaldatasources
      body:
        type: json
        data: '{}'
    docs: Create a global datasource
  - info:
      name: Get a global datasource
      type: http
    http:
      method: GET
      url: http://{persesHost}/api/v1/globaldatasources/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Get a global datasource
  - info:
      name: Update a global datasource
      type: http
    http:
      method: PUT
      url: http://{persesHost}/api/v1/globaldatasources/:name
      params:
      - name: name
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a global datasource
  - info:
      name: Delete a global datasource
      type: http
    http:
      method: DELETE
      url: http://{persesHost}/api/v1/globaldatasources/:name
      params:
      - name: name
        value: ''
        type: path
    docs: Delete a global datasource
bundled: true