Skip to content

Commit 18ef50b

Browse files
alvinlin123alvinlin123
authored
Add build info API to doc (#5227)
* Add build info API to documentataion Signed-off-by: Alvin Lin <[email protected]> * remove trailing space Signed-off-by: Alvin Lin <[email protected]> --------- Signed-off-by: Alvin Lin <[email protected]>
1 parent 909a090 commit 18ef50b

File tree

1 file changed

+69
-57
lines changed

1 file changed

+69
-57
lines changed

‎docs/api/_index.md

Lines changed: 69 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -15,63 +15,64 @@ For the sake of clarity, in this document we have grouped API endpoints by servi
1515

1616
## Endpoints
1717

18-
| API | Service | Endpoint |
19-
| --- | ------- | -------- |
20-
| [Index page](#index-page) | _All services_ | `GET /` |
21-
| [Configuration](#configuration) | _All services_ | `GET /config` |
22-
| [Runtime Configuration](#runtime-configuration) | _All services_ | `GET /runtime_config` |
23-
| [Services status](#services-status) | _All services_ | `GET /services` |
24-
| [Readiness probe](#readiness-probe) | _All services_ | `GET /ready` |
25-
| [Metrics](#metrics) | _All services_ | `GET /metrics` |
26-
| [Pprof](#pprof) | _All services_ | `GET /debug/pprof` |
27-
| [Fgprof](#fgprof) | _All services_ | `GET /debug/fgprof` |
28-
| [Remote write](#remote-write) | Distributor | `POST /api/v1/push` |
29-
| [Tenants stats](#tenants-stats) | Distributor | `GET /distributor/all_user_stats` |
30-
| [HA tracker status](#ha-tracker-status) | Distributor | `GET /distributor/ha_tracker` |
31-
| [Flush blocks](#flush-blocks) | Ingester | `GET,POST /ingester/flush` |
32-
| [Shutdown](#shutdown) | Ingester | `GET,POST /ingester/shutdown` |
33-
| [Ingesters ring status](#ingesters-ring-status) | Ingester | `GET /ingester/ring` |
34-
| [Instant query](#instant-query) | Querier, Query-frontend | `GET,POST <prometheus-http-prefix>/api/v1/query` |
35-
| [Range query](#range-query) | Querier, Query-frontend | `GET,POST <prometheus-http-prefix>/api/v1/query_range` |
36-
| [Exemplar query](#exemplar-query) | Querier, Query-frontend | `GET,POST <prometheus-http-prefix>/api/v1/query_exemplars` |
37-
| [Get series by label matchers](#get-series-by-label-matchers) | Querier, Query-frontend | `GET,POST <prometheus-http-prefix>/api/v1/series` |
38-
| [Get label names](#get-label-names) | Querier, Query-frontend | `GET,POST <prometheus-http-prefix>/api/v1/labels` |
39-
| [Get label values](#get-label-values) | Querier, Query-frontend | `GET <prometheus-http-prefix>/api/v1/label/{name}/values` |
40-
| [Get metric metadata](#get-metric-metadata) | Querier, Query-frontend | `GET <prometheus-http-prefix>/api/v1/metadata` |
41-
| [Remote read](#remote-read) | Querier, Query-frontend | `POST <prometheus-http-prefix>/api/v1/read` |
42-
| [Get tenant ingestion stats](#get-tenant-ingestion-stats) | Querier | `GET /api/v1/user_stats` |
43-
| [Ruler ring status](#ruler-ring-status) | Ruler | `GET /ruler/ring` |
44-
| [Ruler rules ](#ruler-rule-groups) | Ruler | `GET /ruler/rule_groups` |
45-
| [List rules](#list-rules) | Ruler | `GET <prometheus-http-prefix>/api/v1/rules` |
46-
| [List alerts](#list-alerts) | Ruler | `GET <prometheus-http-prefix>/api/v1/alerts` |
47-
| [List rule groups](#list-rule-groups) | Ruler | `GET /api/v1/rules` |
48-
| [Get rule groups by namespace](#get-rule-groups-by-namespace) | Ruler | `GET /api/v1/rules/{namespace}` |
49-
| [Get rule group](#get-rule-group) | Ruler | `GET /api/v1/rules/{namespace}/{groupName}` |
50-
| [Set rule group](#set-rule-group) | Ruler | `POST /api/v1/rules/{namespace}` |
51-
| [Delete rule group](#delete-rule-group) | Ruler | `DELETE /api/v1/rules/{namespace}/{groupName}` |
52-
| [Delete namespace](#delete-namespace) | Ruler | `DELETE /api/v1/rules/{namespace}` |
53-
| [Delete tenant configuration](#delete-tenant-configuration) | Ruler | `POST /ruler/delete_tenant_config` |
54-
| [Alertmanager status](#alertmanager-status) | Alertmanager | `GET /multitenant_alertmanager/status` |
55-
| [Alertmanager configs](#alertmanager-configs) | Alertmanager | `GET /multitenant_alertmanager/configs` |
56-
| [Alertmanager ring status](#alertmanager-ring-status) | Alertmanager | `GET /multitenant_alertmanager/ring` |
57-
| [Alertmanager UI](#alertmanager-ui) | Alertmanager | `GET /<alertmanager-http-prefix>` |
58-
| [Alertmanager Delete Tenant Configuration](#alertmanager-delete-tenant-configuration) | Alertmanager | `POST /multitenant_alertmanager/delete_tenant_config` |
59-
| [Get Alertmanager configuration](#get-alertmanager-configuration) | Alertmanager | `GET /api/v1/alerts` |
60-
| [Set Alertmanager configuration](#set-alertmanager-configuration) | Alertmanager | `POST /api/v1/alerts` |
61-
| [Delete Alertmanager configuration](#delete-alertmanager-configuration) | Alertmanager | `DELETE /api/v1/alerts` |
62-
| [Tenant delete request](#tenant-delete-request) | Purger | `POST /purger/delete_tenant` |
63-
| [Tenant delete status](#tenant-delete-status) | Purger | `GET /purger/delete_tenant_status` |
64-
| [Store-gateway ring status](#store-gateway-ring-status) | Store-gateway | `GET /store-gateway/ring` |
65-
| [Compactor ring status](#compactor-ring-status) | Compactor | `GET /compactor/ring` |
66-
| [Get rule files](#get-rule-files) | Configs API (deprecated) | `GET /api/prom/configs/rules` |
67-
| [Set rule files](#set-rule-files) | Configs API (deprecated) | `POST /api/prom/configs/rules` |
68-
| [Get template files](#get-template-files) | Configs API (deprecated) | `GET /api/prom/configs/templates` |
69-
| [Set template files](#set-template-files) | Configs API (deprecated) | `POST /api/prom/configs/templates` |
70-
| [Get Alertmanager config file](#get-alertmanager-config-file) | Configs API (deprecated) | `GET /api/prom/configs/alertmanager` |
71-
| [Set Alertmanager config file](#set-alertmanager-config-file) | Configs API (deprecated) | `POST /api/prom/configs/alertmanager` |
72-
| [Validate Alertmanager config](#validate-alertmanager-config-file) | Configs API (deprecated) | `POST /api/prom/configs/alertmanager/validate` |
73-
| [Deactivate configs](#deactivate-configs) | Configs API (deprecated) | `DELETE /api/prom/configs/deactivate` |
74-
| [Restore configs](#restore-configs) | Configs API (deprecated) | `POST /api/prom/configs/restore` |
18+
| API | Service | Available Since | Endpoint |
19+
| --- | ------- | --------------- | ---------|
20+
| [Index page](#index-page) | _All services_ || `GET /` |
21+
| [Configuration](#configuration) | _All services_ || `GET /config` |
22+
| [Runtime Configuration](#runtime-configuration) | _All services_ || `GET /runtime_config` |
23+
| [Services status](#services-status) | _All services_ || `GET /services` |
24+
| [Readiness probe](#readiness-probe) | _All services_ || `GET /ready` |
25+
| [Metrics](#metrics) | _All services_ || `GET /metrics` |
26+
| [Pprof](#pprof) | _All services_ || `GET /debug/pprof` |
27+
| [Fgprof](#fgprof) | _All services_ || `GET /debug/fgprof` |
28+
| [Remote write](#remote-write) | Distributor || `POST /api/v1/push` |
29+
| [Tenants stats](#tenants-stats) | Distributor || `GET /distributor/all_user_stats` |
30+
| [HA tracker status](#ha-tracker-status) | Distributor || `GET /distributor/ha_tracker` |
31+
| [Flush blocks](#flush-blocks) | Ingester || `GET,POST /ingester/flush` |
32+
| [Shutdown](#shutdown) | Ingester || `GET,POST /ingester/shutdown` |
33+
| [Ingesters ring status](#ingesters-ring-status) | Ingester || `GET /ingester/ring` |
34+
| [Instant query](#instant-query) | Querier, Query-frontend || `GET,POST <prometheus-http-prefix>/api/v1/query` |
35+
| [Range query](#range-query) | Querier, Query-frontend || `GET,POST <prometheus-http-prefix>/api/v1/query_range` |
36+
| [Exemplar query](#exemplar-query) | Querier, Query-frontend || `GET,POST <prometheus-http-prefix>/api/v1/query_exemplars` |
37+
| [Get series by label matchers](#get-series-by-label-matchers) | Querier, Query-frontend || `GET,POST <prometheus-http-prefix>/api/v1/series` |
38+
| [Get label names](#get-label-names) | Querier, Query-frontend || `GET,POST <prometheus-http-prefix>/api/v1/labels` |
39+
| [Get label values](#get-label-values) | Querier, Query-frontend || `GET <prometheus-http-prefix>/api/v1/label/{name}/values` |
40+
| [Get metric metadata](#get-metric-metadata) | Querier, Query-frontend || `GET <prometheus-http-prefix>/api/v1/metadata` |
41+
| [Remote read](#remote-read) | Querier, Query-frontend || `POST <prometheus-http-prefix>/api/v1/read` |
42+
| [Build information](#build-information) | Querier, Query-frontend |v1.15.0| `GET <prometheus-http-prefix>/api/v1/status/buildinfo` |
43+
| [Get tenant ingestion stats](#get-tenant-ingestion-stats) | Querier || `GET /api/v1/user_stats` |
44+
| [Ruler ring status](#ruler-ring-status) | Ruler || `GET /ruler/ring` |
45+
| [Ruler rules ](#ruler-rule-groups) | Ruler || `GET /ruler/rule_groups` |
46+
| [List rules](#list-rules) | Ruler || `GET <prometheus-http-prefix>/api/v1/rules` |
47+
| [List alerts](#list-alerts) | Ruler || `GET <prometheus-http-prefix>/api/v1/alerts` |
48+
| [List rule groups](#list-rule-groups) | Ruler || `GET /api/v1/rules` |
49+
| [Get rule groups by namespace](#get-rule-groups-by-namespace) | Ruler || `GET /api/v1/rules/{namespace}` |
50+
| [Get rule group](#get-rule-group) | Ruler || `GET /api/v1/rules/{namespace}/{groupName}` |
51+
| [Set rule group](#set-rule-group) | Ruler || `POST /api/v1/rules/{namespace}` |
52+
| [Delete rule group](#delete-rule-group) | Ruler || `DELETE /api/v1/rules/{namespace}/{groupName}` |
53+
| [Delete namespace](#delete-namespace) | Ruler || `DELETE /api/v1/rules/{namespace}` |
54+
| [Delete tenant configuration](#delete-tenant-configuration) | Ruler || `POST /ruler/delete_tenant_config` |
55+
| [Alertmanager status](#alertmanager-status) | Alertmanager || `GET /multitenant_alertmanager/status` |
56+
| [Alertmanager configs](#alertmanager-configs) | Alertmanager || `GET /multitenant_alertmanager/configs` |
57+
| [Alertmanager ring status](#alertmanager-ring-status) | Alertmanager || `GET /multitenant_alertmanager/ring` |
58+
| [Alertmanager UI](#alertmanager-ui) | Alertmanager || `GET /<alertmanager-http-prefix>` |
59+
| [Alertmanager Delete Tenant Configuration](#alertmanager-delete-tenant-configuration) | Alertmanager || `POST /multitenant_alertmanager/delete_tenant_config` |
60+
| [Get Alertmanager configuration](#get-alertmanager-configuration) | Alertmanager || `GET /api/v1/alerts` |
61+
| [Set Alertmanager configuration](#set-alertmanager-configuration) | Alertmanager || `POST /api/v1/alerts` |
62+
| [Delete Alertmanager configuration](#delete-alertmanager-configuration) | Alertmanager || `DELETE /api/v1/alerts` |
63+
| [Tenant delete request](#tenant-delete-request) | Purger || `POST /purger/delete_tenant` |
64+
| [Tenant delete status](#tenant-delete-status) | Purger || `GET /purger/delete_tenant_status` |
65+
| [Store-gateway ring status](#store-gateway-ring-status) | Store-gateway || `GET /store-gateway/ring` |
66+
| [Compactor ring status](#compactor-ring-status) | Compactor || `GET /compactor/ring` |
67+
| [Get rule files](#get-rule-files) | Configs API (deprecated) || `GET /api/prom/configs/rules` |
68+
| [Set rule files](#set-rule-files) | Configs API (deprecated) || `POST /api/prom/configs/rules` |
69+
| [Get template files](#get-template-files) | Configs API (deprecated) || `GET /api/prom/configs/templates` |
70+
| [Set template files](#set-template-files) | Configs API (deprecated) || `POST /api/prom/configs/templates` |
71+
| [Get Alertmanager config file](#get-alertmanager-config-file) | Configs API (deprecated) || `GET /api/prom/configs/alertmanager` |
72+
| [Set Alertmanager config file](#set-alertmanager-config-file) | Configs API (deprecated) || `POST /api/prom/configs/alertmanager` |
73+
| [Validate Alertmanager config](#validate-alertmanager-config-file) | Configs API (deprecated) || `POST /api/prom/configs/alertmanager/validate` |
74+
| [Deactivate configs](#deactivate-configs) | Configs API (deprecated) || `DELETE /api/prom/configs/deactivate` |
75+
| [Restore configs](#restore-configs) | Configs API (deprecated) || `POST /api/prom/configs/restore` |
7576

7677

7778
### Path prefixes
@@ -409,6 +410,17 @@ _For more information, please check out Prometheus [Remote storage integrations]
409410

410411
_Requires [authentication](#authentication)._
411412

413+
### Build Information
414+
415+
```
416+
GET <prometheus-http-prefix>/api/v1/status/buildinfo
417+
# Legacy
418+
GET <legacy-http-prefix>/api/v1/status/buildinfo
419+
```
420+
421+
Prometheus-compatible [build information](https://prometheus.io/docs/prometheus/latest/querying/api/#build-information) endpoint.
422+
423+
_Requires [authentication](#authentication)._
412424

413425
## Querier
414426

0 commit comments

Comments
 (0)