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 Annotations API

Manage dashboard annotations

Tableaux De Bord Annotations 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 Annotations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 1 path, and defines 3 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.

2 operations 1 paths 3 schemas 1 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 Annotations 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 2

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

Annotations 2

Manage dashboard annotations

GET
/annotations
List Annotations
listAnnotations 6 params → 200
POST
/annotations
Create Annotation
createAnnotation body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Annotation (8 properties), PostAnnotationsCmd (6 properties), CreateAnnotationResponse (2 properties). Each schema is shown below with its type and property counts.

CreateAnnotationResponse
object
2 properties
Annotation
object
8 properties
PostAnnotationsCmd
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Tableaux De Bord publishes across the network.

Metabase API
Tableaux De Bord Alerting API
Tableaux De Bord Dashboards 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