Proteside Endpoint referencePolicies
Create a policy
POST
bearerAuthheader
AuthorizationBearer <token>API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.
org_id?stringPartners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.
Format
uuidIdempotency-Key?stringReplays the original response for 24 h
Length
1 <= length <= 255application/json- body
name*stringLength
2 <= length <= 120description?stringLength
length <= 1000store_id?stringOmit for an organization-level policy
Format
uuidmode?stringDefault
"recommend"Value in
"recommend""auto"priority?integerRange
1 <= value <= 10000Default
100match?conditions?action*stringValue in
"authorize""needs_review""block"justification_template?stringLength
length <= 1000expires_days?|Range
1 <= value <= 3650active?booleanDefault
truePolicy
application/json- response
id?stringFormat
uuidorg_id?stringFormat
uuidstore_id?|Format
uuidname?stringdescription?string|nullversion?integeractive?booleanmode?stringValue in
"recommend""auto"priority?integerLower = evaluated first; first match decides
match?conditions?action?stringValue in
"authorize""needs_review""block"justification_template?|Supports {domain} {vendor} {path}
expires_days?integer|nullis_default?booleancreated_at?stringFormat
date-timeupdated_at?stringFormat
date-timecurl -X POST "https://example.com/policies" \ -H "Content-Type: application/json" \ -d '{ "name": "Analytics approved by marketing", "match": { "origin": "known_vendor", "category": [ "analytics" ] }, "conditions": { "no_sensitive_field_access": true, "not_in_threat_list": true }, "action": "authorize", "mode": "recommend", "priority": 60, "justification_template": "{vendor} analytics ({domain}) — no access to payment fields in the last 30 days.", "expires_days": 90 }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0", "name": "string", "description": "string", "version": 0, "active": true, "mode": "recommend", "priority": 0, "match": { "origin": "first_party", "domain": [ "string" ], "path_glob": [ "string" ], "category": [ "string" ], "vendor_id": [ "string" ] }, "conditions": { "same_origin": true, "prevalence_min": 0, "no_sensitive_field_access": true, "not_in_threat_list": true, "in_threat_list": true, "store_provider": true, "max_size_kb": 0, "has_integrity_attr": true }, "action": "authorize", "justification_template": "string", "expires_days": 0, "is_default": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}