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

> Update description / tags. Destination + next-hop are immutable.



## OpenAPI

````yaml /api-reference/specs/network.yaml patch /v1/route-tables/{route_table_id}/routes/{route_id}
openapi: 3.0.3
info:
  title: Basaltic Network API
  version: 1.0.0
  description: |
    The VPC surface — networks and subnets, interfaces, route tables,
    security groups, internet, NAT and egress-only gateways, and floating
    IPs.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://network.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
paths:
  /v1/route-tables/{route_table_id}/routes/{route_id}:
    patch:
      tags:
        - Networking
      summary: Update route
      description: Update description / tags. Destination + next-hop are immutable.
      operationId: updateRoute
      parameters:
        - $ref: '#/components/parameters/RouteTableId'
        - $ref: '#/components/parameters/RouteId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RouteUpdateRequest'
      responses:
        '200':
          description: Route updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - SignatureAuth: []
components:
  parameters:
    RouteTableId:
      name: route_table_id
      in: path
      description: Route Table ID
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
    RouteId:
      name: route_id
      in: path
      description: Route ID
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    RouteUpdateRequest:
      type: object
      properties:
        description:
          type: string
          nullable: true
          example: Default route to the internet gateway
        tags:
          type: object
          additionalProperties:
            type: string
    RouteResponse:
      type: object
      properties:
        route:
          $ref: '#/components/schemas/Route'
    Route:
      type: object
      required:
        - id
        - crn
        - route_table_id
        - destination
        - target_type
        - tags
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        crn:
          type: string
          readOnly: true
          example: crn:network:sa-saopaulo-1:my-account:route/<uuid>
        route_table_id:
          type: string
          format: uuid
          example: a3c9e1f4-7b2d-4a6e-8c1f-9d3b5e7a2c4f
        description:
          type: string
          example: Default route to the internet gateway
        destination:
          type: string
          example: 0.0.0.0/0
        target_type:
          $ref: '#/components/schemas/RouteTargetType'
        target_ip:
          type: string
          nullable: true
          description: >-
            Set when target_type=ip. Mutex with the target_*_id fields. Must be
            a unicast address inside this VPC's CIDR (same IP family as
            destination); internet egress uses target_internet_gateway_id /
            target_nat_gateway_id.
          example: 10.0.1.1
        target_internet_gateway_id:
          type: string
          format: uuid
          nullable: true
          description: Set when target_type=internet_gateway.
          example: c4f7a2e9-8d1b-4e6c-9a3f-5b2d7c1e8a4f
        target_nat_gateway_id:
          type: string
          format: uuid
          nullable: true
          description: Set when target_type=nat_gateway.
          example: e2a8c5f1-3b9d-4c7e-8a1f-6d4b2e9c3a5f
        target_egress_only_gateway_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Set when target_type=egress_only_gateway (IPv6 only). Gives the
            subnet outbound v6 with the internet unable to initiate inbound.
          example: b7d3f1a9-2c8e-4b6d-9f1a-3e5c7d2b8a4f
        tags:
          type: object
          additionalProperties:
            type: string
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    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
    RouteTargetType:
      type: string
      enum:
        - ip
        - internet_gateway
        - nat_gateway
        - egress_only_gateway
      description: |
        Discriminator for the route's target. New target types
        (interface, vpc_peering, …) extend this enum and add their own
        target_* field. Mirrors AWS one-field-per-target style —
        exactly one target_* property must be set on create.
  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
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              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.

````