Skip to main content
POST
devices.filter.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
ref
string
required

The ref returned by devices.filter.create or a row of devices.filters.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
label
string

Filter name.

Required string length: 1 - 255
condition
string

Exact request-rule expression; never approximate filtering.

Required string length: 1 - 8192
action
enum<string>

Allow or deny matching requests.

Available options:
allow,
deny
status
enum<string>

Filter status.

Available options:
enabled,
disabled
denyWith
string

Response message for a denied request.

Allowed value: "Forbidden"
position
integer

Position in the ordered rules, beginning at zero.

Required range: 0 <= x <= 9007199254740991

Response

The result

filter
object
required

Updated request filter.