> ## Documentation Index
> Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar uma regra de roteamento (substituição completa)

<Info>
  Requer a ação do IAM **`loadbalancer:UpdateRule`**. Consulte [permissões de balanceadores de carga](/loadbalancer/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/loadbalancer.yaml patch /v1/load-balancers/{id}/listeners/{listener_id}/rules/{rule_id}
openapi: 3.0.3
info:
  title: API do Basaltic Load Balancer
  version: 1.0.0
  description: >
    Relações de solicitação aceitam referências classificadas por sintaxe
    resolvidas dentro da conta e região do chamador. Referências IP flutuantes
    aceitam somente UUID ou CRN; os alvos IP permanecem literais. Balanceadores
    de carga gerenciados: ouvintes, pools de destino, verificações de
    integridade e os certificados TLS que um ouvinte encerra.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://loadbalancer.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/load-balancers/{id}/listeners/{listener_id}/rules/{rule_id}:
    patch:
      tags:
        - Load Balancers
      summary: Atualizar uma regra de roteamento (substituição completa)
      operationId: updateRule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: 4e1f8c2a-9b3d-4f6e-8a1c-2d5e7f9a0b3c
        - name: listener_id
          in: path
          required: true
          schema:
            type: string
            example: e1f2a3b4-c5d6-4789-e0f1-a2b3c4d5e6f7
        - name: rule_id
          in: path
          required: true
          schema:
            type: string
            example: a3b4c5d6-e7f8-4901-a2b3-c4d5e6f7a8b9
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRuleRequest'
      responses:
        '200':
          description: Atualizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    UpdateRuleRequest:
      additionalProperties: false
      type: object
      required:
        - priority
        - conditions
        - target_group
      description: >
        As relações de grupo de destino aceitam UUID, CRN ou nomes exatos de
        escopo de conta nessa região. Substituição completa da regra —
        prioridade, condições e grupo-alvo devem ser fornecidos (mesma forma que
        criar).
      properties:
        priority:
          type: integer
          minimum: 1
          maximum: 50000
          example: 100
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/RuleCondition'
        target_group:
          type: string
          example: b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4
    RuleResponse:
      type: object
      properties:
        rule:
          $ref: '#/components/schemas/Rule'
    RuleCondition:
      type: object
      required:
        - field
        - op
        - values
      properties:
        field:
          type: string
          enum:
            - host
            - path
            - header
            - query
            - method
          example: path
        op:
          type: string
          enum:
            - exact
            - prefix
            - glob
            - regex
          example: prefix
        name:
          type: string
          description: cabeçalho ou nome da chave de consulta
          example: X-Tenant
        values:
          type: array
          items:
            type: string
            example: /api
    Rule:
      type: object
      required:
        - crn
        - id
        - listener_id
        - priority
        - conditions
        - target_group_id
        - created_at
        - updated_at
      properties:
        crn:
          type: string
          description: >-
            CRN com escopo principal com nome de balanceador de carga imutável e
            componentes UUID filhos.
        id:
          type: string
          format: uuid
          example: a3b4c5d6-e7f8-4901-a2b3-c4d5e6f7a8b9
        listener_id:
          type: string
          format: uuid
          example: e1f2a3b4-c5d6-4789-e0f1-a2b3c4d5e6f7
        priority:
          type: integer
          minimum: 1
          maximum: 50000
          example: 100
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/RuleCondition'
        target_group_id:
          type: string
          format: uuid
          example: b8c9d0e1-f2a3-4456-b7c8-d9e0f1a2b3c4
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Página não encontrada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.