> ## 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. # Listar Regras > Use este endpoint para listar regras de validação com paginação baseada em cursor e filtros opcionais. Regras com status DELETED não são retornadas nas listagens. ## OpenAPI ````yaml pt/openapi/v3-current/tracer.yaml get /v1/rules openapi: 3.1.0 info: title: API Tracer description: >- Referência completa da API para os serviços do Tracer, incluindo validação de transações, gerenciamento de regras, limites de gastos e eventos de auditoria para conformidade SOX/GLBA. version: 1.0.1 servers: - url: https://tracer.sandbox.lerian.net security: - ApiKeyAuth: [] - BearerAuth: [] tags: - name: Health API description: >- Endpoints de verificação de integridade para sondas de vivacidade e prontidão. Estes endpoints não requerem autenticação. - name: Validations API description: >- Endpoints de validação de transações. A meta de desempenho é inferior a 80ms (p99). As validações são idempotentes por `requestId` — uma requisição duplicada retorna o resultado em cache com HTTP 200, enquanto uma requisição nova retorna HTTP 201. Nenhum header de idempotência é necessário. - name: Rules API description: >- Endpoints de gerenciamento de regras de validação. As regras utilizam expressões CEL (Common Expression Language). - name: Limits API description: >- Endpoints de gerenciamento de limites de gastos. Os limites controlam os valores das transações por escopo e período. - name: Reservations API description: >- Endpoints de reserva de capacidade de transação em duas fases. Uma reserva retém capacidade contra os limites de gastos; uma confirmação a consolida e uma liberação a devolve. Confirmar e liberar são idempotentes. - name: Audit Events API description: >- Endpoints de trilha de auditoria para conformidade SOX/GLBA. Todas as decisões de validação e alterações de configuração são registradas. paths: /v1/rules: get: tags: - Rules API summary: Listar Regras description: >- Use este endpoint para listar regras de validação com paginação baseada em cursor e filtros opcionais. Regras com status DELETED não são retornadas nas listagens. operationId: listRules parameters: - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/XApiKey' - $ref: '#/components/parameters/XRequestId' - name: limit in: query description: 'O número máximo de itens a incluir na resposta. Padrão: 10, Máx: 100' required: false example: 10 schema: type: integer minimum: 1 maximum: 100 default: 10 - name: cursor in: query description: Cursor de paginação da resposta anterior. required: false schema: type: string - name: name in: query description: >- Filtrar por nome (correspondência parcial, sem distinção de maiúsculas/minúsculas). required: false schema: type: string maxLength: 255 - name: status in: query description: >- Filtrar por status (DRAFT, ACTIVE, INACTIVE). Regras com status DELETED não são listáveis. required: false schema: type: string enum: - DRAFT - ACTIVE - INACTIVE - name: action in: query description: Filtrar por ação (ALLOW, DENY, REVIEW). required: false schema: type: string enum: - ALLOW - DENY - REVIEW - name: account_id in: query description: Filtrar por ID de conta (UUID). required: false schema: type: string format: uuid - name: segment_id in: query description: Filtrar por ID de segmento (UUID). required: false schema: type: string format: uuid - name: portfolio_id in: query description: Filtrar por ID de portfólio (UUID). required: false schema: type: string format: uuid - name: merchant_id in: query description: Filtrar por ID de merchant (UUID). required: false schema: type: string format: uuid - name: transaction_type in: query description: Filtrar por tipo de transação. required: false schema: type: string enum: - CARD - WIRE - PIX - CRYPTO - name: sub_type in: query description: 'Filtrar por subtipo de transação (ex.: débito, crédito, pré-pago).' required: false schema: type: string maxLength: 50 - name: sort_by in: query description: O campo usado para ordenar os resultados. required: false schema: type: string enum: - created_at - updated_at - name - status default: created_at - name: sort_order in: query description: A ordem usada para ordenar os resultados. required: false schema: type: string enum: - ASC - DESC default: DESC responses: '200': description: >- Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados. content: application/json: schema: $ref: '#/components/schemas/ListRulesResponse' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0001: $ref: '#/components/examples/Error0001' Error0006: $ref: '#/components/examples/Error0006' Error0040: $ref: '#/components/examples/Error0040' Error0041: $ref: '#/components/examples/Error0041' Error0042: $ref: '#/components/examples/Error0042' Error0043: $ref: '#/components/examples/Error0043' Error0044: $ref: '#/components/examples/Error0044' Error0045: $ref: '#/components/examples/Error0045' '401': description: Não Autorizado content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorUnauthenticated: $ref: '#/components/examples/ErrorUnauthenticated' '500': description: Erro Interno do Servidor content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0004: $ref: '#/components/examples/Error0004' components: parameters: ContentType: name: Content-Type in: header description: O tipo de mídia do recurso. Deve ser `application/json`. required: true example: application/json schema: type: string XApiKey: name: X-API-Key in: header description: >- A chave de API para autenticação. **Este header é obrigatório para todos os endpoints, exceto verificações de integridade**. required: true schema: type: string XRequestId: name: X-Request-Id in: header description: Um identificador único usado para rastrear cada requisição. required: false example: 019c96a0-10ce-75fc-a273-dc799079a99c schema: type: string format: uuid schemas: ListRulesResponse: type: object description: Lista paginada de regras. properties: rules: type: array items: $ref: '#/components/schemas/Rule' description: Lista de registros de regras. hasMore: type: boolean description: Se há mais resultados disponíveis. nextCursor: type: - string - 'null' description: >- Cursor para buscar a próxima página. Nulo se não houver mais resultados. ErrorFormat: type: object description: A mensagem de erro da resposta. required: - code - title - message properties: code: type: string description: Um identificador único e estável para o erro. title: type: string description: Um breve resumo do problema. message: type: string description: Orientação detalhada para resolver o erro. fields: type: object additionalProperties: true description: Informações adicionais sobre os campos que causaram o erro. Rule: type: object description: Regra de validação. properties: ruleId: type: string format: uuid description: Identificador único da regra. name: type: string description: Nome legível da regra (globalmente único). maxLength: 255 description: type: string description: Propósito e explicação da lógica da regra. maxLength: 1000 expression: type: string description: Expressão CEL que deve avaliar para booleano. maxLength: 5000 action: type: string enum: - ALLOW - DENY - REVIEW description: Ação tomada quando a expressão da regra avalia como verdadeira. scopes: type: array items: $ref: '#/components/schemas/Scope' description: Escopos que determinam a quais transações esta regra se aplica. status: type: string enum: - DRAFT - ACTIVE - INACTIVE - DELETED description: Status do ciclo de vida da regra. createdAt: type: string format: date-time description: Quando a regra foi criada. updatedAt: type: string format: date-time description: Quando a regra foi modificada pela última vez. activatedAt: type: - string - 'null' format: date-time description: Quando a regra foi ativada pela última vez (nulo se nunca ativada). deactivatedAt: type: - string - 'null' format: date-time description: >- Quando a regra foi desativada pela última vez (nulo se nunca desativada). deletedAt: type: - string - 'null' format: date-time description: Quando a regra foi excluída (nulo se não excluída). Scope: type: object description: >- Definição de escopo para regras e limites. Pelo menos um campo deve ser definido. properties: segmentId: type: string format: uuid description: Aplicar a transações deste segmento. portfolioId: type: string format: uuid description: Aplicar a transações deste portfólio. accountId: type: string format: uuid description: Aplicar a transações desta conta específica. merchantId: type: string format: uuid description: Aplicar a transações para este estabelecimento específico. transactionType: type: string enum: - CARD - WIRE - PIX - CRYPTO description: Aplicar apenas a este tipo de transação. subType: type: string maxLength: 50 description: Aplicar apenas a este subtipo de transação. examples: Error0001: summary: Generic Validation Error value: code: TRC-0001 title: Validation Error message: >- Field validation failed. Please verify the provided data and try again. Error0006: summary: Invalid Query Parameters value: code: TRC-0006 title: Invalid Query Parameters message: >- One or more query parameters are invalid. Please verify the parameters and try again. Error0040: summary: Limit Exceeds Maximum value: code: TRC-0040 title: Limit Exceeds Maximum message: >- The limit parameter exceeds the maximum allowed value. Please reduce the limit and try again. Error0041: summary: Limit Below Minimum value: code: TRC-0041 title: Limit Below Minimum message: >- The limit parameter must be at least 1. Please provide a valid limit and try again. Error0042: summary: Invalid Sort Order value: code: TRC-0042 title: Invalid Sort Order message: Sort order must be ASC or DESC. Please provide a valid value. Error0043: summary: Invalid Sort Column value: code: TRC-0043 title: Invalid Sort Column message: >- The specified sort column is not supported. Please check the allowed fields. Error0044: summary: Invalid Pagination Cursor value: code: TRC-0044 title: Invalid Pagination Cursor message: >- The provided pagination cursor is invalid or expired. Please start a new query without a cursor. Error0045: summary: Sort Parameters Locked value: code: TRC-0045 title: Sort Parameters Locked message: >- Cannot change sortBy or sortOrder when using a pagination cursor. Please start a new query to change sort parameters. ErrorUnauthenticated: summary: Unauthorized value: code: Unauthenticated title: Unauthorized message: >- API Key missing or invalid. Provide a valid API Key in the X-API-Key header. Error0004: summary: Internal Server Error value: code: TRC-0004 title: Internal Server Error message: >- An unexpected error occurred. Please try again later or contact support if the issue persists. securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: >- Autenticação por API Key. Usada por implantações single-tenant (`MULTI_TENANT_ENABLED=false`). Enviada em todas as requisições `/v1/*`. BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Autenticação JWT bearer. Usada por implantações multi-tenant (`MULTI_TENANT_ENABLED=true`). O JWT é emitido pelo Access Manager e deve conter o claim `tenantId` — o Tracer resolve o tenant a partir do token, não de qualquer cabeçalho ou campo do corpo. ````