Fetch User Limits

GET

Return the system default limits, user-level overrides, and final “effective” limit settings for the specified user.

Only superusers or the user themself may fetch these values.

Path parameters

idstringRequired

ID of the user to fetch limits for

Headers

X-API-KeystringRequired

Response

Returns system default limits, user overrides, and final effective settings.

resultsobject

Errors

GET

1                             from r2r import R2RClient
2 
3                             client = R2RClient()
4                             # client.login(...)
5 
6                             user_limits = client.users.get_limits("550e8400-e29b-41d4-a716-446655440000")
7

200Retrieved

1 {
2   "results": {
3     "storage_limits": {
4       "chunks": {
5         "limit": 1,
6         "used": 1,
7         "remaining": 1
8       },
9       "documents": {
10         "limit": 1,
11         "used": 1,
12         "remaining": 1
13       },
14       "collections": {
15         "limit": 1,
16         "used": 1,
17         "remaining": 1
18       }
19     },
20     "system_defaults": {
21       "global_per_min": 1,
22       "monthly_limit": 1,
23       "route_per_min": 1
24     },
25     "user_overrides": {
26       "key": "value"
27     },
28     "effective_limits": {
29       "global_per_min": 1,
30       "monthly_limit": 1,
31       "route_per_min": 1
32     },
33     "usage": {
34       "global_per_min": {
35         "used": 1,
36         "limit": 1,
37         "remaining": 1
38       },
39       "monthly_limit": {
40         "used": 1,
41         "limit": 1,
42         "remaining": 1
43       },
44       "routes": {
45         "key": {
46           "route_per_min": {
47             "used": 1,
48             "limit": 1,
49             "remaining": 1
50           },
51           "monthly_limit": {
52             "used": 1,
53             "limit": 1,
54             "remaining": 1
55           }
56         }
57       }
58     }
59   }
60 }

Built with

1	from r2r import R2RClient
2
3	client = R2RClient()
4	# client.login(...)
5
6	user_limits = client.users.get_limits("550e8400-e29b-41d4-a716-446655440000")
7

1	{
2	"results": {
3	"storage_limits": {
4	"chunks": {
5	"limit": 1,
6	"used": 1,
7	"remaining": 1
8	},
9	"documents": {
10	"limit": 1,
11	"used": 1,
12	"remaining": 1
13	},
14	"collections": {
15	"limit": 1,
16	"used": 1,
17	"remaining": 1
18	}
19	},
20	"system_defaults": {
21	"global_per_min": 1,
22	"monthly_limit": 1,
23	"route_per_min": 1
24	},
25	"user_overrides": {
26	"key": "value"
27	},
28	"effective_limits": {
29	"global_per_min": 1,
30	"monthly_limit": 1,
31	"route_per_min": 1
32	},
33	"usage": {
34	"global_per_min": {
35	"used": 1,
36	"limit": 1,
37	"remaining": 1
38	},
39	"monthly_limit": {
40	"used": 1,
41	"limit": 1,
42	"remaining": 1
43	},
44	"routes": {
45	"key": {
46	"route_per_min": {
47	"used": 1,
48	"limit": 1,
49	"remaining": 1
50	},
51	"monthly_limit": {
52	"used": 1,
53	"limit": 1,
54	"remaining": 1
55	}
56	}
57	}
58	}
59	}
60	}