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

# Update Workspace

> Modifies the configuration and metadata of an existing security workspace, allowing for dynamic adjustments to workspace settings and properties.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/workspaces/{id}
openapi: 3.0.0
info:
  title: Open Attack Surface Management
  description: Open-source platform for cybersecurity Attack Surface Management (ASM)
  version: '1.0'
  contact: {}
servers:
  - url: https://{baseUrl}/api/v1
    variables:
      baseUrl:
        default: localhost:3000
        description: API server hostname with port (e.g. localhost:3000, api.example.com)
security: []
tags: []
externalDocs:
  description: Authentication Docs
  url: auth/docs
paths:
  /api/workspaces/{id}:
    patch:
      tags:
        - Workspaces
      summary: Update Workspace
      description: >-
        Modifies the configuration and metadata of an existing security
        workspace, allowing for dynamic adjustments to workspace settings and
        properties.
      operationId: WorkspacesController_updateWorkspace
      parameters:
        - name: id
          required: true
          in: path
          description: The id of the resource
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultMessageResponseDto'
                allOf:
                  - $ref: '#/components/schemas/AppResponseSerialization'
components:
  schemas:
    UpdateWorkspaceDto:
      type: object
      properties:
        name:
          type: string
          example: My Workspace
          description: The name of the workspace
        description:
          type: string
          example: This is my workspace
          description: The description of the workspace
        archivedAt:
          type: object
    DefaultMessageResponseDto:
      type: object
      properties:
        message:
          type: string
          example: Success
      required:
        - message

````