Listar dashboards en Grafana Cloud, con una API

Lista los dashboards del stack. Cada elemento trae metadata.name, el uid que piden las demás herramientas, el uid de la carpeta en la anotación grafana.app/folder del metadata y el JSON completo del dashboard en spec, con su title. Mantén limit pequeño; cuando llegue metadata.continue, envíalo como continue para la página siguiente.

Identificador
grafana_list_dashboards

La llamada

POST https://connect.reportei.com/api/tools/grafana_list_dashboards/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "namespace": "<namespace>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
namespacestringSístacks- followed by the instance ID shown under Details of the Grafana instance in the Grafana Cloud portal, for example stacks-123456.
limitintegerNoMaximum number of dashboards to return.
continuestringNoThe metadata.continue token of the previous response, with the same limit.

Conexiones posibles

Tu cliente conecta su cuenta de Grafana Cloud una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

Al conectar, tu cliente también indica {stack}: la dirección de su cuenta en la API de la app.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/grafana_list_dashboards. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Grafana Cloud

Ver las 7 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.