Grafana is an open-source analytics and monitoring solution that is used to visualize data available in your Cockpit
You need to create a Grafana user to access your Cockpit's Grafana. Note that the admin username is not available for creation.
On Grafana you can also interact with the Scaleway alert manager and create alert rules.
Get your Cockpit's Grafana
Retrieve information on your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to. The output returned displays the URL to access your Cockpit's Grafana.
query Parameters
project_idID of the Project. (UUID format)
Get your Cockpit's Grafana › Responses
grafana_urlURL to access your Cockpit's Grafana.
List Scaleway resources dashboards
Retrieve a list of available dashboards in Grafana, for all Scaleway resources which are integrated with Cockpit.
query Parameters
project_idID of the Project to target. (UUID format)
pagePage number.
page_sizePage size.
tagsTags to filter for.
List Scaleway resources dashboards › Responses
total_countTotal count of Grafana dashboards.
Grafana dashboards information.
Get Scaleway resource dashboard
Retrieve information about the dashboard of a Scaleway resource in Grafana, specified by the ID of the Project the Cockpit belongs to, and the name of the dashboard.
path Parameters
dashboard_nameName of the dashboard.
query Parameters
project_idID of the Project the dashboard belongs to. (UUID format)
Get Scaleway resource dashboard › Responses
nameDashboard name.
titleDashboard title.
urlDashboard URL.
tagsDashboard tags.
variablesDashboard variables.
Synchronize Grafana data sources
Trigger the synchronization of all your data sources and the alert manager in the relevant regions. The alert manager will only be synchronized if you have enabled it.
Synchronize Grafana data sources › Request Body
project_idID of the Project to target. (UUID format)
Synchronize Grafana data sources › Responses
(Deprecated) EOL 2026-01-20
List Grafana users List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
query Parameters
project_idID of the Project to target. (UUID format)
pagePage number.
page_sizePage size.
order_byOrder of the Grafana users.
(Deprecated) EOL 2026-01-20 › Responses
total_countTotal count of Grafana users.
Grafana users information.
(Deprecated) EOL 2026-01-20
Create a Grafana user
Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it.
Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the admin username is not available for creation.
(Deprecated) EOL 2026-01-20 › Request Body
project_idID of the Project in which to create the Grafana user. (UUID format)
loginUsername of the Grafana user. Note that the admin username is not available for creation.
roleRole assigned to the Grafana user.
(Deprecated) EOL 2026-01-20 › Responses
idID of the Grafana user.
loginUsername of the Grafana user.
roleRole assigned to the Grafana user.
passwordGrafana user's password.
(Deprecated) EOL 2026-01-20
Delete a Grafana user Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
path Parameters
grafana_user_idID of the Grafana user.
query Parameters
project_idID of the Project to target. (UUID format)
(Deprecated) EOL 2026-01-20 › Responses
(Deprecated) EOL 2026-01-20
Reset a Grafana user password Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user. A new password regenerates and only displays once. Make sure that you save it.
path Parameters
grafana_user_idID of the Grafana user.
(Deprecated) EOL 2026-01-20 › Request Body
project_idID of the Project to target. (UUID format)
(Deprecated) EOL 2026-01-20 › Responses
idID of the Grafana user.
loginUsername of the Grafana user.
roleRole assigned to the Grafana user.
passwordGrafana user's password.