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

# Update a workspace

> Update a workspace's display name and/or description. The workspace is identified by the
`workspace_id` path parameter alone; the `x-hh-workspace-id` header does not participate.
Only fields included in the request body are modified.

The workspace's internal slug is not part of this contract and cannot be changed here.




## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/control_plane_openapi.yaml put /v1/workspaces/{workspace_id}
openapi: 3.1.0
info:
  title: HoneyHive Control Plane API
  description: >
    Manage HoneyHive control-plane resources: workspaces, projects and alerts.


    Authentication requires a fine-grained control-plane API key (values

    start with `hh_fgcp_`), sent as `Authorization: Bearer <api-key>`.

    Project API keys used with the Data Plane API will not work here. Create

    a key in the HoneyHive app under an organization's or workspace's

    **Settings → API Keys**, or see

    [Authorization](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript#authorization)

    for details.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.9.0
servers:
  - url: https://api.cp.us.honeyhive.ai
security:
  - BearerAuth: []
tags:
  - name: Alerts
    description: >
      Define and manage alerts. Alerts evaluate event metrics on a schedule and
      trigger notifications when configured thresholds are crossed.
  - name: Projects
    description: >
      Create and manage projects within a workspace. A project is the container
      for the events, datasets, evaluations, and alerts logged against it.
  - name: Virtual Dataplanes
    description: >
      Create and manage virtual data planes. A virtual data plane is a logical
      tenant boundary inside an organization, hosted on a physical cluster;
      several virtual data planes commonly share one cluster. Workspaces live
      inside a virtual data plane.
  - name: Workspaces
    description: >
      Read and manage workspaces. A workspace groups the projects belonging to
      one team or environment, and owns the API keys and AI provider secrets its
      projects share.
paths:
  /v1/workspaces/{workspace_id}:
    put:
      tags:
        - Workspaces
      summary: Update a workspace
      description: >
        Update a workspace's display name and/or description. The workspace is
        identified by the

        `workspace_id` path parameter alone; the `x-hh-workspace-id` header does
        not participate.

        Only fields included in the request body are modified.


        The workspace's internal slug is not part of this contract and cannot be
        changed here.
      operationId: updateWorkspace
      parameters:
        - in: path
          name: workspace_id
          required: true
          schema:
            type: string
          description: The unique identifier of the workspace to update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutWorkspaceRequest'
      responses:
        '200':
          description: Workspace updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceResponse'
        '400':
          description: Invalid request body
        '404':
          description: Workspace not found
components:
  schemas:
    PutWorkspaceRequest:
      type: object
      properties:
        name:
          type: string
          maxLength: 200
          description: >-
            Workspace display name. Allowed characters are letters, digits,
            space, underscore, hyphen, apostrophe and ampersand. The name must
            contain at least one letter or digit, and must not start with a
            space.
        description:
          type: string
          description: Workspace description
      additionalProperties: false
      description: Request body for updating a workspace
    UpdateWorkspaceResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/WorkspaceItem'
      required:
        - success
        - data
      additionalProperties: false
      description: The updated workspace
    WorkspaceItem:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          description: Workspace display name
        description:
          type: string
          description: Workspace description
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
            - type: 'null'
      required:
        - id
        - name
        - description
        - created_at
      additionalProperties: false
      description: Workspace object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

## Related topics

- [Workspaces](/v2/cli-reference/ref/workspaces.md)
- [Workspaces Methods](/v2/control-plane-sdk-reference/typescript/ref/workspaces/index.md)
- [UpdateWorkspaceRequest](/v2/control-plane-sdk-reference/typescript/ref/workspaces/UpdateWorkspaceRequest.md)