You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[Get user overrides](#get-user-overrides)| Overrides ||`GET /api/v1/user-overrides`|
71
+
|[Set user overrides](#set-user-overrides)| Overrides ||`POST /api/v1/user-overrides`|
72
+
|[Delete user overrides](#delete-user-overrides)| Overrides ||`DELETE /api/v1/user-overrides`|
70
73
|[Store-gateway ring status](#store-gateway-ring-status)| Store-gateway ||`GET /store-gateway/ring`|
71
74
|[Compactor ring status](#compactor-ring-status)| Compactor ||`GET /compactor/ring`|
72
75
|[Get rule files](#get-rule-files)| Configs API (deprecated) ||`GET /api/prom/configs/rules`|
@@ -888,6 +891,64 @@ Returns status of tenant deletion. Output format to be defined. Experimental.
888
891
889
892
_Requires [authentication](#authentication)._
890
893
894
+
## Overrides
895
+
896
+
The Overrides service provides an API for managing user overrides.
897
+
898
+
### Get user overrides
899
+
900
+
```
901
+
GET /api/v1/user-overrides
902
+
```
903
+
904
+
Get the current overrides for the authenticated tenant. Returns the overrides in JSON format.
905
+
906
+
_Requires [authentication](#authentication)._
907
+
908
+
### Set user overrides
909
+
910
+
```
911
+
POST /api/v1/user-overrides
912
+
```
913
+
914
+
Set or update overrides for the authenticated tenant. The request body should contain a JSON object with the override values.
915
+
916
+
_Requires [authentication](#authentication)._
917
+
918
+
### Delete user overrides
919
+
920
+
```
921
+
DELETE /api/v1/user-overrides
922
+
```
923
+
924
+
Delete all overrides for the authenticated tenant. This will revert the tenant to using default values.
925
+
926
+
_Requires [authentication](#authentication)._
927
+
928
+
#### Example request body for PUT
929
+
930
+
```json
931
+
{
932
+
"ingestion_rate": 50000,
933
+
"max_global_series_per_user": 1000000,
934
+
"ruler_max_rules_per_rule_group": 100
935
+
}
936
+
```
937
+
938
+
#### Supported limits
939
+
940
+
The following limits can be modified via the API:
941
+
-`max_global_series_per_user`
942
+
-`max_global_series_per_metric`
943
+
-`ingestion_rate`
944
+
-`ingestion_burst_size`
945
+
-`ruler_max_rules_per_rule_group`
946
+
-`ruler_max_rule_groups_per_tenant`
947
+
948
+
#### Hard limits
949
+
950
+
Overrides are validated against hard limits defined in the runtime configuration file. If a requested override exceeds the hard limit for the tenant, the request will be rejected with a 400 status code.
0 commit comments