Set the bucket drain order

PUT /api/v1/users/{id}/bucket-order prm_users_buckets

Replaces the subscriber's custom drain order. Every id must be one of their active buckets, except the sentinel 0, which stands for the plan's own main quota and may be placed anywhere in the sequence.

The 0 in that array is meaningful and positional. It is the main plan quota, so stripping non-positive ids as "empty" would silently reorder the drain sequence rather than reject it.

At a glance

Authentication: Staff token or session
Requires permission: prm_users_buckets Manage quota buckets
Rate limit: t_mutate

Parameters

Parameter	Description
`id`required path · integer	Subscriber id.
`order`required body · array	Bucket ids in drain order. 0 is the main quota, not a missing value.

Errors

Code	When it is returned
`ERR_VALIDATION`400	an id is not one of this subscriber's active buckets, or the array is too long

Request

curl -X PUT "$BASE/api/v1/users/{id}/bucket-order" \
  -H "Authorization: Bearer $XR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "order": [331, 0, 402]
}'

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us