Cockpit Global API

Introduction

Scaleway's Observability Cockpit allows you to monitor your applications and their infrastructure by giving you insights and context into their behavior. With Cockpit, you can visualize your resources' and applications' metrics, logs, and traces in Grafana dashboards. Cockpit is automatically activated when you are using Scaleway resources that are integrated into it.

The Global API allows you to perform Cockpit visualization actions such as retrieving your dashboard URLs, managing Grafana users, and synchronizing your data through Grafana dashboards. Refer to the Cockpit API for data-related management.

Concepts

Refer to our dedicated concepts page to find definitions of the different terms referring to Cockpit.

Quickstart

Configure your environment variables.

Note

This is an optional step that seeks to simplify your usage of the API.

export SCW_SECRET_KEY="<API secret key>"
export SCW_PROJECT_ID="<Scaleway Project ID>"

Create a Grafana user with the editor role.

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"login":"user-name","role":"editor","project_id":"<Scaleway Project ID>"}' \
  "https://api.scaleway.com/cockpit/v1/grafana/users"

Note

The admin username is not available for creation.

Your user's password displays in the output. Make sure that you store it securely.

Retrieve a list of available dashboards in Grafana for all Scaleway resources integrated with Cockpit.

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/cockpit/v1/grafana/product-dashboards?project_id=<Scaleway Project ID>"

The list of available dashboards displays in the output.

Requirements

You have a Scaleway account
You have created an API key and that the API key has sufficient IAM permissions to perform the actions described on this page
You have installed curl
You have created Scaleway resources integrated with Cockpit

Troubleshooting

Refer to our troubleshooting documentation if your pusher does not support HTTP headers or if you want to reset your Grafana password.

Technical limitations

It is not possible to create an admin Grafana user.
Available roles for Grafana users are viewer and editor.
The Scaleway preconfigured dashboards canot be edited.

Going further

For more information about Cockpit, you can check out the following pages:

Cockpit Documentation
Scaleway Slack Community join the #observability channel
Contact our support team.

Grafana

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/cockpit/v1/grafana

GET/cockpit/v1/grafana/product-dashboards

GET/cockpit/v1/grafana/product-dashboards/{dashboard_name}

POST/cockpit/v1/grafana/sync-data-sources

GET/cockpit/v1/grafana/users

POST/cockpit/v1/grafana/users

DELETE/cockpit/v1/grafana/users/{grafana_user_id}

POST/cockpit/v1/grafana/users/{grafana_user_id}/reset-password

Pricing Plans (deprecated)

(Deprecated) A pricing plan is associated with each Cockpit. Pricing plans give you information on how you are billed for the Cockpit product.

GET/cockpit/v1/current-plan

GET/cockpit/v1/plans

PATCH/cockpit/v1/plans