List policy rules

Returns all policy rules for the current project.

GET /rules

List policy rules

cURL

curl --request GET \
  --url https://api.onecli.sh/v1/rules \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "hostPattern": "<string>",
    "pathPattern": "<string>",
    "enabled": true,
    "agentId": "<string>",
    "rateLimit": 123,
    "scope": "<string>",
    "metadata": {},
    "conditions": [
      {
        "target": "<string>",
        "operator": "<string>",
        "value": "<string>",
        "key": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

Authorization · string · header · required

API key obtained from the dashboard or GET /user/api-key

Response

200 - application/json

List of rules

id · string

name · string

hostPattern · string

pathPattern · string | null

method · enum<string> | null

Available options: GET, POST, PUT, PATCH, DELETE, null

action · enum<string>

Available options: block, rate_limit, manual_approval

enabled · boolean

agentId · string | null

rateLimit · integer | null

rateLimitWindow · enum<string> | null

Available options: minute, hour, day, null

scope · string

metadata · object

conditions · object[]

Show child attributes

createdAt · string<date-time>