Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tableaux De Bord Dashboards API

Create and manage Grafana dashboards

Tableaux De Bord Dashboards API is one of 9 APIs that Tableaux De Bord publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 10.0.0.

Requests are made against a single base URL, https://{grafana-host}/api.

4 operations 3 paths 6 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
10.0.0
Base URL
https://your-grafana-instance.com
Authentication
HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 2

Tableaux De Bord Dashboards API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • BasicAuth — Basic auth with Grafana username and password
  • ApiKeyAuth — API key authentication using 'Bearer {api-key}'

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Dashboards 4

Create and manage Grafana dashboards

POST
/dashboards/db
Create Or Update Dashboard
createOrUpdateDashboard body → 200400401403
GET
/dashboards/uid/{uid}
Get Dashboard By UID
getDashboardByUID 1 param → 200404
DELETE
/dashboards/uid/{uid}
Delete Dashboard By UID
deleteDashboardByUID 1 param → 200
GET
/search
Search Dashboards
searchDashboards 5 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Hit (11 properties), PostDashboardOKResponse (6 properties), SaveDashboardCommand (5 properties), DeleteDashboardResponse (3 properties). Each schema is shown below with its type and property counts.

PostDashboardOKResponse
object
6 properties
ErrorResponse
object
1 property
Hit
object
11 properties
DeleteDashboardResponse
object
3 properties
SaveDashboardCommand
object
5 properties 1 required
DashboardFullWithMeta
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableaux-de-bord-dashboards-api-openapi.yml Raw ↑

Other APIs Tableaux De Bord publishes across the network.

Metabase API
Tableaux De Bord Alerting API
Tableaux De Bord Annotations API
Tableaux De Bord Datasources API
Tableaux De Bord Folders API
Tableaux De Bord Organizations API
Tableaux De Bord Teams API
Tableaux De Bord Users API