|
| 1 | +--- |
| 2 | +meta: |
| 3 | + title: Cockpit supported API endpoints |
| 4 | + description: Discover how to manage your telemetry data sources using the Scaleway-supported Mimir and Loki endpoints |
| 5 | +content: |
| 6 | + h1: Cockpit supported API endpoints |
| 7 | + paragraph: Discover how to manage your telemetry data sources using the Scaleway-supported Mimir and Loki endpoints |
| 8 | +tags: observability cockpit endpoints mimir loki telemetry |
| 9 | +dates: |
| 10 | + validation: 2025-05-17 |
| 11 | + posted: 2025-05-17 |
| 12 | +categories: |
| 13 | + - observability |
| 14 | +--- |
| 15 | + |
| 16 | +Cockpit supports telemetry ingestion and querying using the following open-source technologies: |
| 17 | + |
| 18 | +- [Mimir](https://grafana.com/oss/mimir/) for metrics |
| 19 | +- [Loki](https://grafana.com/oss/loki/) for logs |
| 20 | +- [Tempo](https://grafana.com/oss/tempo/) for traces |
| 21 | +- Prometheus Alertmanager for alerting. |
| 22 | + |
| 23 | +Cockpit exposes a subset of their HTTP APIs so users can push, query, and manage telemetry data from Cockpit. |
| 24 | + |
| 25 | + <Message type="important"> |
| 26 | + Scaleway does not support all endpoints from these upstream APIs. refer to the exact lists below to find out which endpoints are supported. |
| 27 | + </Message> |
| 28 | + |
| 29 | +<Macro id="requirements" /> |
| 30 | + |
| 31 | + - A Scaleway account logged into the [console](https://console.scaleway.com) |
| 32 | + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization |
| 33 | + - [Created](/cockpit/how-to/create-token/) a Cockpit token with the right [permissions](/cockpit/concepts/#cockpit-tokens) |
| 34 | + - Retrieved the URL of your data source from the [Scaleway console](https://console.scaleway.com/cockpit/dataSource) or the [API](https://www.scaleway.com/en/developers/api/cockpit/regional-api/#path-data-sources-list-data-sources) |
| 35 | + |
| 36 | +## Mimir supported endpoints (metrics) |
| 37 | + |
| 38 | +The base URL pattern for metrics is the following: `https://<data-source-id>.metrics.cockpit.<region>.scw.cloud`. |
| 39 | + |
| 40 | + |
| 41 | + ### Mimir remote write endpoints |
| 42 | + |
| 43 | + method GET POST DELETE |
| 44 | + |
| 45 | + Path: `/api/v1/push` |
| 46 | + Path: `/otlp/v1/metrics` |
| 47 | + |
| 48 | + ### Mimir query endpoints |
| 49 | + path /prometheus/api/v1/query |
| 50 | + path /prometheus/api/v1/query_range |
| 51 | + path /prometheus/api/v1/query_exemplars |
| 52 | + path /prometheus/api/v1/series |
| 53 | + path /prometheus/api/v1/labels |
| 54 | + path /prometheus/api/v1/label/* |
| 55 | + path /prometheus/api/v1/metadata |
| 56 | + path /prometheus/api/v1/read |
| 57 | + path /prometheus/api/v1/status/buildinfo |
| 58 | + |
| 59 | + # Ruler endpoints |
| 60 | + path /prometheus/api/v1/rules |
| 61 | + path /prometheus/api/v1/alerts |
| 62 | + path /prometheus/config/v1/rules |
| 63 | + path /prometheus/config/v1/rules/* |
| 64 | + |
| 65 | + # Admin endpoints |
| 66 | + path /ruler/delete_tenant_config |
| 67 | + path /compactor/delete_tenant |
| 68 | + path /compactor/delete_tenant_status |
| 69 | + } |
| 70 | + |
| 71 | + @mimir_write_endpoints { |
| 72 | + method POST |
| 73 | + path /api/v1/push |
| 74 | + path /otlp/v1/metrics |
| 75 | + } |
| 76 | + |
| 77 | + @mimir_query_endpoints { |
| 78 | + method GET POST |
| 79 | + path /prometheus/api/v1/query |
| 80 | + path /prometheus/api/v1/query_range |
| 81 | + path /prometheus/api/v1/query_exemplars |
| 82 | + path /prometheus/api/v1/series |
| 83 | + path /prometheus/api/v1/labels |
| 84 | + path /prometheus/api/v1/label/* |
| 85 | + path /prometheus/api/v1/metadata |
| 86 | + path /prometheus/api/v1/read |
| 87 | + path /prometheus/api/v1/status/buildinfo |
| 88 | + } |
| 89 | +
|
| 90 | + @mimir_rules_endpoints { |
| 91 | + method GET POST DELETE |
| 92 | + path /prometheus/api/v1/rules |
| 93 | + path /prometheus/api/v1/alerts |
| 94 | + path /prometheus/config/v1/rules |
| 95 | + path /prometheus/config/v1/rules/* |
| 96 | + } |
| 97 | +
|
| 98 | + @mimir_admin_endpoints { |
| 99 | + method GET POST |
| 100 | + path /ruler/delete_tenant_config |
| 101 | + path /compactor/delete_tenant |
| 102 | + path /compactor/delete_tenant_status |
| 103 | + } |
| 104 | +
|
| 105 | + @mimir_query_range_endpoints { |
| 106 | + method GET POST |
| 107 | + path /prometheus/api/v1/query_range |
| 108 | + } |
| 109 | +
|
| 110 | + @mimir_ruler_write_endpoints { |
| 111 | + method POST DELETE |
| 112 | +
|
| 113 | +
|
0 commit comments