Proteside Docs
Referência de endpointsRegras

Criar uma regra

POST
/rules

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.

Parâmetros de consulta

org_id?string

Somente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.

Formatouuid

Parâmetros de cabeçalho

Idempotency-Key?string

Reproduz a resposta original por 24 h

Tamanho1 <= length <= 255

Corpo da requisição

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

Corpo da resposta

Regra

application/json
  1. response
id?string
Formatouuid
store_id?string
Formatouuid
type?string
Valor em"block""allow"
target?string
Valor em"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"}