Proteside Docs
Referencia de endpointsReglas

Crear una regla

POST
/rules

Autorización

bearerAuth
headerAutorizaciónBearer <token>

Token de API creado en Ajustes → API. Los alcances están vinculados al token; cada operación indica el alcance requerido en x-scope.

Parámetros de consulta

org_id?string

Solo socios (orgs:manage): actúa sobre esta organización hija. También se puede enviar como org_id en cuerpos JSON.

Formatouuid

Parámetros de encabezado

Idempotency-Key?string

Reproduce la respuesta original durante 24 h

Longitud1 <= length <= 255

Cuerpo de la solicitud

application/json
  1. body
store_id*string
Formatouuid
type*string
Valor en"block""allow"
target*string
Valor en"domain""src""hash"
value*string
Longitudlength <= 512
label?|
Longitudlength <= 120

Cuerpo de la respuesta

Regla

application/json
  1. response
id?string
Formatouuid
store_id?string
Formatouuid
type?string
Valor en"block""allow"
target?string
Valor en"domain""src""hash"
value?string
label?string|null
active?boolean
created_at?string
Formatodate-time
curl -X POST "https://example.com/rules" \  -H "Content-Type: application/json" \  -d '{    "store_id": "0c1d2e3f-1111-4222-8333-444455556666",    "type": "block",    "target": "domain",    "value": "evil-cdn.example",    "label": "Known skimmer host"  }'
{  "id": "c9d8e7f6-6666-4777-8888-999900001111",  "store_id": "0c1d2e3f-1111-4222-8333-444455556666",  "type": "block",  "target": "domain",  "value": "evil-cdn.example",  "label": "Known skimmer host",  "active": true,  "created_at": "2026-09-27T10:10:00.000Z"}