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

# Edit a dashboard

> Edit a dashboard's name or description.

Requires MEMBER role or higher in the project's workspace (the write
service decides). A null ``description`` clears it.

Args:
    request (Request): Incoming request (rate-limit plumbing).
    response (Response): Outgoing response (rate-limit plumbing).
    auth (AccountStampedAuth): Account-scope user auth (session token or
        CLI access JWT); its resolved ``user_id`` becomes the actor.
    dashboard_id (str): The dashboard to edit.
    payload (UpdateDashboardRequest): The project and the fields to change.
    _live (None): Write-path liveness gate (blocks a revoked JWT session).

Returns:
    UpdateDashboardResponse: The updated dashboard and the changed fields.

Raises:
    HTTPException: The write service's 400/403/404/409 verbatim, or a
        503 when its response is ambiguous.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/public/dashboards/{dashboard_id}
openapi: 3.1.0
info:
  title: TraceRoot Public API
  version: 0.1.0
servers:
  - description: TraceRoot Cloud
    url: https://app.traceroot.ai
  - description: Self-hosted
    url: '{baseUrl}'
    variables:
      baseUrl:
        default: http://localhost:8000
        description: Your TraceRoot backend URL
security: []
paths:
  /api/v1/public/dashboards/{dashboard_id}:
    patch:
      tags:
        - Dashboards
      summary: Edit a dashboard
      description: |-
        Edit a dashboard's name or description.

        Requires MEMBER role or higher in the project's workspace (the write
        service decides). A null ``description`` clears it.

        Args:
            request (Request): Incoming request (rate-limit plumbing).
            response (Response): Outgoing response (rate-limit plumbing).
            auth (AccountStampedAuth): Account-scope user auth (session token or
                CLI access JWT); its resolved ``user_id`` becomes the actor.
            dashboard_id (str): The dashboard to edit.
            payload (UpdateDashboardRequest): The project and the fields to change.
            _live (None): Write-path liveness gate (blocks a revoked JWT session).

        Returns:
            UpdateDashboardResponse: The updated dashboard and the changed fields.

        Raises:
            HTTPException: The write service's 400/403/404/409 verbatim, or a
                503 when its response is ambiguous.
      operationId: update_dashboard
      parameters:
        - in: path
          name: dashboard_id
          required: true
          schema:
            title: Dashboard Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDashboardRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDashboardResponse'
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Authentication failed or session revoked
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Insufficient role or wrong credential kind
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Name already in use
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Write service unavailable
      security:
        - BearerAuth: []
components:
  schemas:
    UpdateDashboardRequest:
      additionalProperties: false
      description: >-
        Body for editing a dashboard's name or description (layout stays
        UI-only).
      properties:
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: null clears the description
          title: Description
        name:
          title: Name
          type: string
        project_id:
          title: Project Id
          type: string
      required:
        - project_id
      title: UpdateDashboardRequest
      type: object
    UpdateDashboardResponse:
      description: The updated dashboard.
      properties:
        changed:
          items:
            type: string
          title: Changed
          type: array
        dashboard:
          $ref: '#/components/schemas/DashboardRow'
        updated:
          title: Updated
          type: boolean
      required:
        - updated
        - changed
        - dashboard
      title: UpdateDashboardResponse
      type: object
    ErrorResponse:
      description: >-
        The canonical public error envelope (matches the gateway's normalized
        shape).
      properties:
        detail:
          title: Detail
          type: string
      required:
        - detail
      title: ErrorResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    DashboardRow:
      description: A dashboard as the write service returns it.
      properties:
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
        project_id:
          title: Project Id
          type: string
      required:
        - id
        - name
        - project_id
      title: DashboardRow
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.