> ## 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.

# Update a routing rule (full replace)



## OpenAPI

````yaml /api-reference/specs/loadbalancer.yaml patch /v1/load-balancers/{id}/listeners/{listener_id}/rules/{rule_id}
openapi: 3.0.3
info:
  title: Basaltic Load Balancer API
  version: 1.0.0
  description: |
    Managed load balancers: listeners, target pools, health checks and the
    TLS certificates a listener terminates.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://loadbalancer.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
paths:
  /v1/load-balancers/{id}/listeners/{listener_id}/rules/{rule_id}:
    patch:
      tags:
        - Load Balancers
      summary: Update a routing rule (full replace)
      operationId: updateRule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: 4e1f8c2a-9b3d-4f6e-8a1c-2d5e7f9a0b3c
        - name: listener_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: e1f2a3b4-c5d6-4789-e0f1-a2b3c4d5e6f7
        - name: rule_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: a3b4c5d6-e7f8-4901-a2b3-c4d5e6f7a8b9
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRuleRequest'
      responses:
        '200':
          description: Updated
          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:
      type: object
      required:
        - priority
        - conditions
        - target_group_id
      description: |
        Full replace of the rule — priority, conditions, and target group
        must all be supplied (same shape as create).
      properties:
        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
    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: header or query key name
          example: X-Tenant
        values:
          type: array
          items:
            type: string
            example: /api
    Rule:
      type: object
      required:
        - id
        - listener_id
        - priority
        - conditions
        - target_group_id
        - created_at
        - updated_at
      properties:
        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: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    BadRequest:
      description: Invalid request parameters
      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: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      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: Resource not found
      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:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````