find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/perses-dashboards-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Perses Dashboards API
  description: 'Perses is an open-source monitoring and dashboarding tool (CNCF sandbox)

    that exposes a REST API for managing dashboards, datasources, and

    projects, among other resources.'
  version: 1.0.0
  contact:
    name: Perses documentation
    url: https://perses.dev/perses/docs/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://{persesHost}
  description: Perses server.
  variables:
    persesHost:
      default: localhost:8080
      description: Host and port of the Perses server.
tags:
- name: Dashboards
  description: Manage dashboards inside a project.
paths:
  /api/v1/projects/{projectName}/dashboards:
    parameters:
    - in: path
      name: projectName
      required: true
      schema:
        type: string
    get:
      tags:
      - Dashboards
      summary: List dashboards in a project
      operationId: listDashboards
      parameters:
      - in: query
        name: name
        schema:
          type: string
        description: Optional name prefix filter.
      responses:
        '200':
          description: Array of dashboards.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dashboard'
    post:
      tags:
      - Dashboards
      summary: Create a dashboard
      operationId: createDashboard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dashboard'
      responses:
        '200':
          description: Dashboard created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
  /api/v1/projects/{projectName}/dashboards/{dashboardName}:
    parameters:
    - in: path
      name: projectName
      required: true
      schema:
        type: string
    - in: path
      name: dashboardName
      required: true
      schema:
        type: string
    get:
      tags:
      - Dashboards
      summary: Get a dashboard
      operationId: getDashboard
      responses:
        '200':
          description: Dashboard.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
    put:
      tags:
      - Dashboards
      summary: Update a dashboard
      operationId: updateDashboard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dashboard'
      responses:
        '200':
          description: Dashboard updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
    delete:
      tags:
      - Dashboards
      summary: Delete a dashboard
      operationId: deleteDashboard
      responses:
        '204':
          description: Dashboard removed.
components:
  schemas:
    Dashboard:
      type: object
      properties:
        kind:
          type: string
          enum:
          - Dashboard
        metadata:
          $ref: '#/components/schemas/Metadata'
        spec:
          type: object
          additionalProperties: true
          description: Dashboard specification including panels and layouts.
    Metadata:
      type: object
      properties:
        name:
          type: string
        project:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        version:
          type: integer
externalDocs:
  description: Perses API reference
  url: https://perses.dev/perses/docs/api/