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

# Rename or re-describe a firewall

> Updates the name and/or description. Rule and binding edits use their dedicated sub-resources.



## OpenAPI

````yaml https://api.vmarea.com/api/public/v1/openapi.json patch /api/public/v1/firewalls/{id}
openapi: 3.1.0
info:
  title: VMArea Public API
  version: 1.0.0
  description: >-
    The VMArea Public API lets you provision and manage VMs, networks,
    firewalls, SSH keys, backups, and webhooks programmatically. Authenticate
    every request with an API token (`x-api-key` header) created in the
    dashboard. Tokens carry coarse scopes (e.g. `vms:write`); endpoints reject
    calls that lack the scope they require.
  contact:
    name: VMArea Support
    url: https://vmarea.com/support
servers:
  - url: https://api.vmarea.com/api/v1
    description: Production
security:
  - ApiKey: []
paths:
  /api/public/v1/firewalls/{id}:
    patch:
      tags:
        - Firewalls
      summary: Rename or re-describe a firewall
      description: >-
        Updates the name and/or description. Rule and binding edits use their
        dedicated sub-resources.
      operationId: updateFirewall
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                description:
                  type: string
                  maxLength: 500
                  nullable: true
              additionalProperties: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      description:
                        type: string
                        nullable: true
                      rules:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            firewallId:
                              type: string
                            position:
                              type: integer
                            direction:
                              type: string
                              enum:
                                - IN
                                - OUT
                            action:
                              type: string
                              enum:
                                - ACCEPT
                                - DROP
                                - REJECT
                            protocol:
                              type: string
                              enum:
                                - TCP
                                - UDP
                                - ICMP
                                - ESP
                                - GRE
                                - ANY
                            port:
                              type: string
                              nullable: true
                            sourceIps:
                              type: array
                              items:
                                type: string
                            destIps:
                              type: array
                              items:
                                type: string
                            description:
                              type: string
                              nullable: true
                            createdAt:
                              type: string
                              format: date-time
                            updatedAt:
                              type: string
                              format: date-time
                          required:
                            - id
                            - firewallId
                            - position
                            - direction
                            - action
                            - protocol
                            - port
                            - sourceIps
                            - destIps
                            - description
                            - createdAt
                            - updatedAt
                          additionalProperties: false
                      bindings:
                        type: array
                        items:
                          type: object
                          properties:
                            vmId:
                              type: string
                            attachedAt:
                              type: string
                              format: date-time
                            vm:
                              type: object
                              properties:
                                id:
                                  type: string
                                name:
                                  type: string
                                hostname:
                                  type: string
                                  nullable: true
                                status:
                                  type: string
                              required:
                                - id
                                - name
                                - hostname
                                - status
                              additionalProperties: false
                          required:
                            - vmId
                            - attachedAt
                            - vm
                          additionalProperties: false
                      bindingCount:
                        type: integer
                      ruleCount:
                        type: integer
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                    required:
                      - id
                      - name
                      - description
                      - rules
                      - bindings
                      - bindingCount
                      - ruleCount
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: string
                required:
                  - success
                  - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: string
                required:
                  - success
                  - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: string
                required:
                  - success
                  - error
                additionalProperties: false
      security:
        - ApiKey: []
components:
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        Long-lived API token created at
        https://vmarea.com/dashboard/settings/api-keys. Tokens are
        scope-restricted; this spec lists the scope each endpoint requires.

````