Skip to content

Commit 98f5f95

Browse files
nerda-codesnerda-codes
committed
docs(add): all endpoints
1 parent f1ae8d7 commit 98f5f95

File tree

1 file changed

+137
-69
lines changed

1 file changed

+137
-69
lines changed

‎pages/cockpit/reference-content/cockpit-supported-endpoints.mdx‎

Lines changed: 137 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ content:
77
paragraph: Discover how to manage your telemetry data sources using the Scaleway-supported Mimir and Loki endpoints
88
tags: observability cockpit endpoints mimir loki telemetry
99
dates:
10-
validation: 2025-05-17
11-
posted: 2025-05-17
10+
validation: 2025-04-25
11+
posted: 2025-04-25
1212
categories:
1313
- observability
1414
---
@@ -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 Alertmanager for alerting.
21+
- 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

@@ -35,79 +35,147 @@ Cockpit exposes a subset of their HTTP APIs so users can push, query, and manage
3535

3636
## Mimir supported endpoints (metrics)
3737

38-
The base URL pattern for metrics is the following: `https://<data-source-id>.metrics.cockpit.<region>.scw.cloud`.
38+
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`).
3939

40+
<Concept>
41+
## Mimir write endpoints
4042

41-
### Mimir remote write endpoints
42-
43-
method GET POST DELETE
43+
Method: `POST`.
4444

4545
Path: `/api/v1/push`
4646
Path: `/otlp/v1/metrics`
47+
</Concept>
4748

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
49+
<Concept>
50+
## Mimir query endpoints
51+
52+
Methods: `GET` and `POST`.
53+
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`
63+
</Concept>
64+
65+
<Concept>
66+
## Mimir rules endpoints
67+
68+
Methods: `GET`, `POST`, and `DELETE`.
69+
70+
Path: `/prometheus/api/v1/rules`
71+
Path: `/prometheus/api/v1/alerts`
72+
Path: `/prometheus/config/v1/rules`
73+
Path: `/prometheus/config/v1/rules/*`
74+
</Concept>
75+
76+
<Concept>
77+
## Mimir admin endpoints
78+
79+
Methods: `GET` and `POST`.
80+
81+
Path: `/ruler/delete_tenant_config`
82+
Path: `/compactor/delete_tenant`
83+
Path: `/compactor/delete_tenant_status`
84+
</Concept>
85+
86+
87+
## Loki supported endpoints (logs)
88+
89+
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`).
90+
91+
<Concept>
92+
## Loki write endpoints
93+
94+
Method: `POST`.
95+
96+
Path: /loki/api/v1/push
97+
Path: /otlp/v1/logs
98+
</Concept>
99+
100+
<Concept>
101+
## Loki query endpoints
102+
103+
Methods: `GET` and `POST`.
104+
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
112+
</Concept>
113+
114+
<Concept>
115+
## Loki rules endpoints
116+
117+
Methods: `GET`, `POST`, and `DELETE`.
118+
119+
path /loki/api/v1/rules
120+
path /loki/api/v1/rules/*
121+
path /api/prom/rules
122+
path /api/prom/rules/*
92123
path /prometheus/api/v1/rules
93124
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
125+
</Concept>
126+
127+
## Tempo supported endpoints (traces)
128+
129+
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`).
130+
131+
<Concept>
132+
## Tempo write endpoints
133+
134+
Method: `POST`.
135+
136+
path /otlp/v1/traces
137+
path /opentelemetry.proto.collector.trace.v1.TraceService/Export
138+
path /jaeger
139+
path /zipkin
140+
</Concept>
141+
142+
<Concept>
143+
## Tempo query endpoints
144+
145+
Method: `GET`.
146+
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
154+
</Concept>
155+
156+
## Pometheus supported endpoints
157+
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`).
159+
160+
<Message type="important">
161+
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.
162+
</Message>
163+
164+
<Concept>
165+
## Alert manager endpoints
166+
167+
Methods: `GET`, `POST`, and `DELETE`.
168+
169+
Path: /alertmanager/*
170+
Path: /api/v1/alerts
171+
</Concept>
172+
173+
<Concept>
174+
## Alert manager admin endpoints
175+
176+
Method: `POST`.
177+
178+
Path: /multitenant_alertmanager/delete_tenant_config
179+
</Concept>
112180

113181

0 commit comments

Comments
 (0)