Pular para o conteúdo principal
GET
/
v1
/
rules
Listar Regras
curl --request GET \
  --url https://tracer.lerian.io/v1/rules \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'
{ "rules": [ { "ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "description": "<string>", "expression": "<string>", "scopes": [ { "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "subType": "<string>" } ], "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "activatedAt": "2023-11-07T05:31:56Z", "deactivatedAt": "2023-11-07T05:31:56Z", "deletedAt": "2023-11-07T05:31:56Z" } ], "hasMore": true, "nextCursor": "<string>" }

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Autorizações

​
X-API-Key
string
header
obrigatório

API Key authentication. Used by single-tenant deployments (MULTI_TENANT_ENABLED=false). Sent on every /v1/* request.

Cabeçalhos

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
X-API-Key
string
obrigatório

A chave de API para autenticação. Este header é obrigatório para todos os endpoints, exceto verificações de integridade.

​
X-Request-Id
string<uuid>

Um identificador único usado para rastrear cada requisição.

Parâmetros de consulta

​
limit
integer
padrão:10

The maximum number of items to include in the response. Default: 10, Max: 100

Intervalo obrigatório: 1 <= x <= 100
​
cursor
string

Cursor de paginação da resposta anterior.

​
name
string

Filtrar por nome (correspondência parcial, sem distinção de maiúsculas/minúsculas).

Maximum string length: 255
​
status
enum<string>

Filtrar por status (DRAFT, ACTIVE, INACTIVE). Regras com status DELETED não são listáveis.

Opções disponíveis:
DRAFT,
ACTIVE,
INACTIVE
​
action
enum<string>

Filtrar por ação (ALLOW, DENY, REVIEW).

Opções disponíveis:
ALLOW,
DENY,
REVIEW
​
account_id
string<uuid>

Filter by account ID (UUID).

​
segment_id
string<uuid>

Filter by segment ID (UUID).

​
portfolio_id
string<uuid>

Filter by portfolio ID (UUID).

​
merchant_id
string<uuid>

Filter by merchant ID (UUID).

​
transaction_type
enum<string>

Filter by transaction type.

Opções disponíveis:
CARD,
WIRE,
PIX,
CRYPTO
​
sub_type
string

Filter by transaction subtype (e.g., debit, credit, prepaid).

Maximum string length: 50
​
sort_by
enum<string>
padrão:created_at

O campo usado para ordenar os resultados.

Opções disponíveis:
created_at,
updated_at,
name,
status
​
sort_order
enum<string>
padrão:DESC

A ordem usada para ordenar os resultados.

Opções disponíveis:
ASC,
DESC

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

Lista paginada de regras.

​
rules
object[]

Lista de registros de regras.

​
hasMore
boolean

Se há mais resultados disponíveis.

​
nextCursor
string | null

Cursor para buscar a próxima página. Nulo se não houver mais resultados.