Skip to content

Commit cee331c

Browse files
committed
docs(cpt): add menu
1 parent 98f5f95 commit cee331c

File tree

2 files changed

+58
-54
lines changed

2 files changed

+58
-54
lines changed

menu/navigation.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3849,6 +3849,10 @@
38493849
{
38503850
"label": "Cockpit capabilities and limits",
38513851
"slug": "cockpit-limitations"
3852+
},
3853+
{
3854+
"label": "Cockpit supported API endpoints for data source management",
3855+
"slug": "cockpit-supported-endpoints"
38523856
}
38533857
],
38543858
"label": "Additional Content",
Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
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
3+
title: Cockpit supported API endpoints for data source management
4+
description: Discover how to manage your telemetry data sources using the Scaleway-supported Mimir, Loki, Tempo and Prometheus endpoints
55
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
6+
h1: Cockpit supported API endpoints for data source management
7+
paragraph: Discover how to manage your telemetry data sources using the Scaleway-supported Mimir, Loki, Tempo and Prometheus endpoints
8+
tags: observability cockpit endpoints mimir loki telemetry prometheus tempo datasource-management
99
dates:
1010
validation: 2025-04-25
1111
posted: 2025-04-25
@@ -18,7 +18,7 @@ Cockpit supports telemetry ingestion and querying using the following open-sourc
1818
- [Mimir](https://grafana.com/oss/mimir/) for metrics
1919
- [Loki](https://grafana.com/oss/loki/) for logs
2020
- [Tempo](https://grafana.com/oss/tempo/) for traces
21-
- Prometheus for the alert manager
21+
- [Prometheus](https://grafana.com/oss/prometheus/) for the alert manager
2222

2323
Cockpit exposes a subset of their HTTP APIs so users can push, query, and manage telemetry data from Cockpit.
2424

@@ -42,45 +42,45 @@ The base URL pattern for metrics is the following: `https://<data-source-id>.met
4242

4343
Method: `POST`.
4444

45-
Path: `/api/v1/push`
46-
Path: `/otlp/v1/metrics`
45+
- Path: `/api/v1/push`
46+
- Path: `/otlp/v1/metrics`
4747
</Concept>
4848

4949
<Concept>
5050
## Mimir query endpoints
5151

5252
Methods: `GET` and `POST`.
5353

54-
Path: `/prometheus/api/v1/query`
55-
Path: `/prometheus/api/v1/query_range`
56-
Path: `/prometheus/api/v1/query_exemplars`
57-
Path: `/prometheus/api/v1/series`
58-
Path: `/prometheus/api/v1/labels`
59-
Path: `/prometheus/api/v1/label/*`
60-
Path: `/prometheus/api/v1/metadata`
61-
Path: `/prometheus/api/v1/read`
62-
Path: `/prometheus/api/v1/status/buildinfo`
54+
- Path: `/prometheus/api/v1/query`
55+
- Path: `/prometheus/api/v1/query_range`
56+
- Path: `/prometheus/api/v1/query_exemplars`
57+
- Path: `/prometheus/api/v1/series`
58+
- Path: `/prometheus/api/v1/labels`
59+
- Path: `/prometheus/api/v1/label/*`
60+
- Path: `/prometheus/api/v1/metadata`
61+
- Path: `/prometheus/api/v1/read`
62+
- Path: `/prometheus/api/v1/status/buildinfo`
6363
</Concept>
6464

6565
<Concept>
6666
## Mimir rules endpoints
6767

6868
Methods: `GET`, `POST`, and `DELETE`.
6969

70-
Path: `/prometheus/api/v1/rules`
71-
Path: `/prometheus/api/v1/alerts`
72-
Path: `/prometheus/config/v1/rules`
73-
Path: `/prometheus/config/v1/rules/*`
70+
- Path: `/prometheus/api/v1/rules`
71+
- Path: `/prometheus/api/v1/alerts`
72+
- Path: `/prometheus/config/v1/rules`
73+
- Path: `/prometheus/config/v1/rules/*`
7474
</Concept>
7575

7676
<Concept>
7777
## Mimir admin endpoints
7878

7979
Methods: `GET` and `POST`.
8080

81-
Path: `/ruler/delete_tenant_config`
82-
Path: `/compactor/delete_tenant`
83-
Path: `/compactor/delete_tenant_status`
81+
- Path: `/ruler/delete_tenant_config`
82+
- Path: `/compactor/delete_tenant`
83+
- Path: `/compactor/delete_tenant_status`
8484
</Concept>
8585

8686

@@ -93,35 +93,35 @@ The base URL pattern for logs is the following: `https://<data-source-id>.logs.c
9393

9494
Method: `POST`.
9595

96-
Path: /loki/api/v1/push
97-
Path: /otlp/v1/logs
96+
- Path: `/loki/api/v1/push`
97+
- Path: `/otlp/v1/logs`
9898
</Concept>
9999

100100
<Concept>
101101
## Loki query endpoints
102102

103103
Methods: `GET` and `POST`.
104104

105-
path /loki/api/v1/query
106-
path /loki/api/v1/query_range
107-
path /loki/api/v1/labels
108-
path /loki/api/v1/label
109-
path /loki/api/v1/label/*
110-
path /loki/api/v1/tail
111-
path /loki/api/v1/series
105+
- Path: `/loki/api/v1/query`
106+
- Path: `/loki/api/v1/query_range`
107+
- Path: `/loki/api/v1/labels`
108+
- Path: `/loki/api/v1/label`
109+
- Path: `/loki/api/v1/label/*`
110+
- Path: `/loki/api/v1/tail`
111+
- Path: `/loki/api/v1/series`
112112
</Concept>
113113

114114
<Concept>
115115
## Loki rules endpoints
116116

117117
Methods: `GET`, `POST`, and `DELETE`.
118118

119-
path /loki/api/v1/rules
120-
path /loki/api/v1/rules/*
121-
path /api/prom/rules
122-
path /api/prom/rules/*
123-
path /prometheus/api/v1/rules
124-
path /prometheus/api/v1/alerts
119+
- Path: `/loki/api/v1/rules`
120+
- Path: `/loki/api/v1/rules/*`
121+
- Path: `/api/prom/rules`
122+
- Path: `/api/prom/rules/*`
123+
- Path: `/prometheus/api/v1/rules`
124+
- Path: `/prometheus/api/v1/alerts`
125125
</Concept>
126126

127127
## Tempo supported endpoints (traces)
@@ -133,29 +133,29 @@ The base URL pattern for traces is the following: `https://<data-source-id>.trac
133133

134134
Method: `POST`.
135135

136-
path /otlp/v1/traces
137-
path /opentelemetry.proto.collector.trace.v1.TraceService/Export
138-
path /jaeger
139-
path /zipkin
136+
- Path: `/otlp/v1/traces`
137+
- Path: `/opentelemetry.proto.collector.trace.v1.TraceService/Export`
138+
- Path: `/jaeger`
139+
- Path: `/zipkin`
140140
</Concept>
141141

142142
<Concept>
143143
## Tempo query endpoints
144144

145145
Method: `GET`.
146146

147-
Path: /api/echo
148-
Path: /api/traces/*
149-
Path: /api/search
150-
Path: /api/search/tags
151-
Path: /api/v2/search/tags
152-
Path: /api/search/tag/*/values
153-
Path: /api/v2/search/tag/*/values
147+
- Path: `/api/echo`
148+
- Path: `/api/traces/*`
149+
- Path: `/api/search`
150+
- Path: `/api/search/tags`
151+
- Path: `/api/v2/search/tags`
152+
- Path: `/api/search/tag/*/values`
153+
- Path: `/api/v2/search/tag/*/values`
154154
</Concept>
155155

156156
## Pometheus supported endpoints
157157

158-
The base URL pattern for the alert manager is the following: `https://<data-source-id>.alertmanager.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`).
158+
The base URL pattern for the alert manager is the following: `https://<data-source-id>.alertmanager.cockpit.<region>.scw.cloud`. You must replace `<data-source-id>` with the ID of your data source and `<region>` with the region where the alert manager is enabled (`fr-par`, `nl-ams`, or `pl-waw`).
159159

160160
<Message type="important">
161161
You must use the [Cockpit API](https://www.scaleway.com/en/developers/api/cockpit/regional-api/#path-alert-manager-get-the-alert-manager) to retrieve the URL.
@@ -166,16 +166,16 @@ The base URL pattern for the alert manager is the following: `https://<data-sour
166166

167167
Methods: `GET`, `POST`, and `DELETE`.
168168

169-
Path: /alertmanager/*
170-
Path: /api/v1/alerts
169+
- Path: `/alertmanager/*`
170+
- Path: `/api/v1/alerts`
171171
</Concept>
172172

173173
<Concept>
174174
## Alert manager admin endpoints
175175

176176
Method: `POST`.
177177

178-
Path: /multitenant_alertmanager/delete_tenant_config
178+
Path: `/multitenant_alertmanager/delete_tenant_config`
179179
</Concept>
180180

181181

0 commit comments

Comments
 (0)