Skip to main content
POST
devices.filter.test

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
request
object
required

Synthetic request metadata; may contain an observed IP and user agent.

ref
string

The ref returned by devices.environment.create or a row of devices.environments.list.

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

Up to ten inline rules; omit to test the referenced environment rules.

Required array length: 1 - 10 elements

Response

The result

action
enum<string>
required

Evaluation result.

Available options:
allow,
deny
denyWith
string

Denial message.

Maximum string length: 5000
matchedCondition
string

Matched rule expression.

Maximum string length: 5000