Grafana HTTP API Types (Typescript)

Grafana Developers & API
1

Hi, I’m new to Grafana and I’ve searched all over the web for a Grafana Client node module that would expose the types present in the HTTP API for use in typescript.

For example, in trying to use the Create Library Element API endpoint, the docs show an example with a model specified in the query object. However, there is no documentation on what that model’s object shape should be; it just shows model: {...}. Am I missing something? Are there indeed no type definitions available for Grafana’s HTTP API?

Thanks in advance!

3

We have a fully generated object model based on our API, you can find them here; GitHub - grafana/grafana-foundation-sdk: A set of tools, types and libraries for building and manipulating Grafana objects. , for example here is from our 11.4 release grafana-foundation-sdk/typescript at v11.4.x+cog-v0.0.x · grafana/grafana-foundation-sdk · GitHub

4

I have been working with Grafana’s HTTP API in TypeScript, and it is a great way to manage dashboards and data sources programmatically. The types help catch errors early, and it is pretty easy to integrate with existing projects. Definitely a solid choice for anyone looking to automate Grafana tasks!