Referência de endpointsRegras
Criar uma regra
POST
bearerAuthheader
Autorizaçã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.
org_id?stringSomente parceiros (orgs:manage): atua sobre esta organização filha. Também pode ser enviado como org_id em corpos JSON.
Formato
uuidIdempotency-Key?stringReproduz a resposta original por 24 h
Tamanho
1 <= length <= 255application/json- body
store_id*stringFormato
uuidtype*stringValor em
"block""allow"target*stringValor em
"domain""src""hash"value*stringTamanho
length <= 512label?|Tamanho
length <= 120Regra
application/json- response
id?stringFormato
uuidstore_id?stringFormato
uuidtype?stringValor em
"block""allow"target?stringValor em
"domain""src""hash"value?stringlabel?string|nullactive?booleancreated_at?stringFormato
date-timecurl -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"}