> ## 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. # Criar uma Regra > Use este endpoint para criar uma regra de validação com uma expressão CEL e array de escopos. As regras são sempre criadas com status DRAFT. Use o endpoint de ativação para iniciar a avaliação. ## OpenAPI ````yaml pt/openapi/v3-current/tracer.yaml post /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: post: tags: - Rules API summary: Criar uma Regra description: >- Use este endpoint para criar uma regra de validação com uma expressão CEL e array de escopos. As regras são sempre criadas com status DRAFT. Use o endpoint de ativação para iniciar a avaliação. operationId: createRule parameters: - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/XApiKey' - $ref: '#/components/parameters/XRequestId' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRuleInput' example: name: Block high-value transactions description: Deny transactions above BRL 10,000 for card payments expression: amount > 1000000 action: DENY scopes: - transactionType: CARD responses: '201': description: Indica que a regra foi criada com sucesso com status DRAFT. content: application/json: schema: $ref: '#/components/schemas/Rule' example: ruleId: 019c96a0-1071-7a0d-9916-a831221de252 name: Block high-value transactions description: Deny transactions above BRL 10,000 for card payments expression: amount > 1000000 action: DENY scopes: - transactionType: CARD status: DRAFT createdAt: '2026-01-30T10:00:00Z' updatedAt: '2026-01-30T10:00:00Z' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0003: $ref: '#/components/examples/Error0003' Error0083: $ref: '#/components/examples/Error0083' Error0084: $ref: '#/components/examples/Error0084' Error0085: $ref: '#/components/examples/Error0085' Error0106: $ref: '#/components/examples/Error0106' Error0107: $ref: '#/components/examples/Error0107' Error0108: $ref: '#/components/examples/Error0108' Error0109: $ref: '#/components/examples/Error0109' Error0110: $ref: '#/components/examples/Error0110' Error0111: $ref: '#/components/examples/Error0111' Error0112: $ref: '#/components/examples/Error0112' Error0113: $ref: '#/components/examples/Error0113' '401': description: Não Autorizado content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorUnauthenticated: $ref: '#/components/examples/ErrorUnauthenticated' '409': description: Conflito content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0101: $ref: '#/components/examples/Error0101' '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: CreateRuleInput: type: object description: Entrada para criar uma nova regra. required: - name - expression - action properties: name: type: string minLength: 1 maxLength: 255 description: Nome legível da regra (deve ser globalmente único). description: type: string description: Propósito e explicação da lógica da regra. maxLength: 1000 expression: type: string minLength: 1 maxLength: 5000 description: Expressão CEL que deve avaliar para booleano. action: type: string enum: - ALLOW - DENY - REVIEW description: Ação tomada quando a expressão da regra avalia como verdadeira. scopes: type: array maxItems: 100 items: $ref: '#/components/schemas/Scope' description: Escopos que determinam a quais transações esta regra se aplica. 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). 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. 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: Error0003: summary: Invalid Request Body value: code: TRC-0003 title: Invalid Request Body message: >- The request body is invalid or malformed. Please verify the JSON format and try again. Error0083: summary: Invalid CEL Expression Syntax value: code: TRC-0083 title: Expression Syntax Error message: >- The CEL expression contains a syntax error. Please verify the expression syntax and try again. Error0084: summary: Expression Must Return Boolean value: code: TRC-0084 title: Expression Type Error message: >- The CEL expression must evaluate to a boolean value. Please modify the expression to return true or false. Error0085: summary: Expression Cost Exceeded value: code: TRC-0085 title: Expression Cost Exceeded message: >- The CEL expression computational cost exceeds the allowed limit. Please simplify the expression. Error0106: summary: Rule Name Required value: code: TRC-0106 title: Missing Required Field message: >- The name field is required. Please provide a name for the rule and try again. Error0107: summary: Rule Name Exceeds Maximum Length value: code: TRC-0107 title: Name Too Long message: >- The name exceeds the maximum length of 255 characters. Please reduce the name size. Error0108: summary: Rule Expression Required value: code: TRC-0108 title: Missing Required Field message: >- The expression field is required. Please provide a CEL expression for the rule and try again. Error0109: summary: Expression Exceeds Maximum Length value: code: TRC-0109 title: Expression Too Long message: >- The expression exceeds the maximum length of 5000 characters. Please reduce the expression size. Error0110: summary: Invalid Rule Action value: code: TRC-0110 title: Invalid Action message: >- The action must be one of ALLOW, DENY, or REVIEW. Please provide a valid action. Error0111: summary: Scope Must Have At Least One Field value: code: TRC-0111 title: Invalid Scope message: >- Each scope must have at least one field set. Please provide at least one field in the scope. Error0112: summary: Description Exceeds Maximum Length value: code: TRC-0112 title: Description Too Long message: >- The description exceeds the maximum length of 1000 characters. Please reduce the description size. Error0113: summary: Scopes Exceed Maximum Entries value: code: TRC-0113 title: Scopes Exceed Maximum message: >- The scopes exceed the maximum of 100 entries. Please reduce the number of scopes. 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. Error0101: summary: Rule Name Conflict value: code: TRC-0101 title: Rule Name Conflict message: >- A rule with this name already exists. Please choose a different name and try again. 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. ````