Proteside Docs
Endpoint referenceRules

Activate / deactivate a rule

PATCH
/rules/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.

Path Parameters

id*string
Formatuuid

Query Parameters

org_id?string

Partners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.

Formatuuid

Request Body

application/json
  1. body
active?boolean
label?|
Lengthlength <= 120

Response Body

Rule

application/json
  1. response
id?string
Formatuuid
store_id?string
Formatuuid
type?string
Value in"block""allow"
target?string
Value in"domain""src""hash"
value?string
label?string|null
active?boolean
created_at?string
Formatdate-time
curl -X PATCH "https://example.com/rules/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "active": false  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",  "type": "block",  "target": "domain",  "value": "string",  "label": "string",  "active": true,  "created_at": "2019-08-24T14:15:22Z"}