Cockpit supported API endpoints for data source management
Cockpit supports telemetry ingestion and querying using the following open-source technologies:
- Mimir for metrics
- Loki for logs
- Tempo for traces
- Prometheus for the alert manager
Cockpit exposes a subset of their HTTP APIs so users can push, query, and manage telemetry data from Cockpit.
Before you start
To complete the actions presented below, you must have:
- A Scaleway account logged into the console
- Owner status or IAM permissions allowing you to perform actions in the intended Organization or Project
- Created a Cockpit token with the right permissions
- Retrieved the URL of your data source from the Scaleway console or the API
Mimir supported endpoints (metrics)
The base URL pattern for metrics is the following: https://<data-source-id>.metrics.cockpit.<region>.scw.cloud
. You must replace <data-source-id>
with the ID of your data source and <region>
with the region where your data source is located (fr-par
, nl-ams
, or pl-waw
).
Refer to the official Mimir documentation for more details about the endpoints below.
Mimir write endpoints
Method: POST
.
- Path:
/api/v1/push
- Path:
/otlp/v1/metrics
Mimir query endpoints
Methods: GET
and POST
.
- Path:
/prometheus/api/v1/query
- Path:
/prometheus/api/v1/query_range
- Path:
/prometheus/api/v1/query_exemplars
- Path:
/prometheus/api/v1/series
- Path:
/prometheus/api/v1/labels
- Path:
/prometheus/api/v1/label/*
- Path:
/prometheus/api/v1/metadata
- Path:
/prometheus/api/v1/read
- Path:
/prometheus/api/v1/status/buildinfo
Additional endpoints
Methods: GET
- Path:
/federate
The /federate
endpoint aims to replicate the behavior of the classic Prometheus /federate
endpoint, but it is not an official Mimir endpoint.
Refer to the How to federate metrics documentation page for more information.
Mimir rules endpoints
Methods: GET
, POST
, and DELETE
.
- Path:
/prometheus/api/v1/rules
- Path:
/prometheus/api/v1/alerts
- Path:
/prometheus/config/v1/rules
- Path:
/prometheus/config/v1/rules/*
Loki supported endpoints (logs)
The base URL pattern for logs is the following: https://<data-source-id>.logs.cockpit.<region>.scw.cloud
. You must replace <data-source-id>
with the ID of your data source and <region>
with the region where your data source is located (fr-par
, nl-ams
, or pl-waw
).
Refer to the official Loki documentation for more details about the endpoints below.
Loki write endpoints
Method: POST
.
- Path:
/loki/api/v1/push
- Path:
/otlp/v1/logs
Loki query endpoints
Methods: GET
and POST
.
- Path:
/loki/api/v1/query
- Path:
/loki/api/v1/query_range
- Path:
/loki/api/v1/labels
- Path:
/loki/api/v1/label
- Path:
/loki/api/v1/label/*
- Path:
/loki/api/v1/tail
- Path:
/loki/api/v1/series
Loki rules endpoints
Methods: GET
, POST
, and DELETE
.
- Path:
/loki/api/v1/rules
- Path:
/loki/api/v1/rules/*
- Path:
/api/prom/rules
- Path:
/api/prom/rules/*
- Path:
/prometheus/api/v1/rules
- Path:
/prometheus/api/v1/alerts
Tempo supported endpoints (traces)
The base URL pattern for traces is the following: https://<data-source-id>.traces.cockpit.<region>.scw.cloud
. You must replace <data-source-id>
with the ID of your data source and <region>
with the region where your data source is located (fr-par
, nl-ams
, or pl-waw
).
Refer to the official Tempo documentation for more details about the endpoints below.
Tempo write endpoints
Method: POST
.
- Path:
/otlp/v1/traces
- Path:
/opentelemetry.proto.collector.trace.v1.TraceService/Export
- Path:
/jaeger
- Path:
/zipkin
Tempo query endpoints
Method: GET
.
- Path:
/api/echo
- Path:
/api/traces/*
- Path:
/api/search
- Path:
/api/search/tags
- Path:
/api/v2/search/tags
- Path:
/api/search/tag/*/values
- Path:
/api/v2/search/tag/*/values
Prometheus alert manager supported endpoints
The base URL pattern for the alert manager is the following: https://<alert-manager-id>.alertmanager.cockpit.<region>.scw.cloud
. You must replace <alert-manager-id>
with the ID of your alert manager and <region>
with the region where the alert manager is enabled (fr-par
, nl-ams
, or pl-waw
).
Refer to the official Prometheus alert manager documentation for more details about the endpoints below.
Alert manager endpoints
Methods: GET
, POST
, and DELETE
.
- Path:
/alertmanager/*
- Path:
/api/v1/alerts