Saltar al contenido principal
GET
/
v1
/
rules
Listar Reglas
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.

Autorizaciones

​
X-API-Key
string
header
requerido

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

Encabezados

​
Content-Type
string
requerido

El tipo de medio del recurso. Debe ser application/json.

​
X-API-Key
string
requerido

La clave API para autenticacion. Este encabezado es requerido para todos los endpoints excepto verificaciones de salud.

​
X-Request-Id
string<uuid>

Un identificador unico usado para rastrear y seguir cada solicitud.

Parámetros de consulta

​
limit
integer
predeterminado:10

El numero maximo de elementos a incluir en la respuesta. Predeterminado: 10, Maximo: 100

Rango requerido: 1 <= x <= 100
​
cursor
string

Cursor de paginacion de la respuesta anterior.

​
name
string

Filtrar por nombre (coincidencia parcial sin distincion de mayusculas/minusculas).

Maximum string length: 255
​
status
enum<string>

Filtrar por estado (DRAFT, ACTIVE, INACTIVE). Las reglas DELETED no son listables.

Opciones disponibles:
DRAFT,
ACTIVE,
INACTIVE
​
action
enum<string>

Filtrar por accion (ALLOW, DENY, REVIEW).

Opciones disponibles:
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.

Opciones disponibles:
CARD,
WIRE,
PIX,
CRYPTO
​
sub_type
string

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

Maximum string length: 50
​
sort_by
enum<string>
predeterminado:created_at

El campo usado para ordenar los resultados.

Opciones disponibles:
created_at,
updated_at,
name,
status
​
sort_order
enum<string>
predeterminado:DESC

El orden usado para ordenar los resultados.

Opciones disponibles:
ASC,
DESC

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

Lista paginada de reglas.

​
rules
object[]

Lista de registros de reglas.

​
hasMore
boolean

Si hay mas resultados disponibles.

​
nextCursor
string | null

Cursor para obtener la siguiente pagina. Null si no hay mas resultados.