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

# Replace a dashboard's name, description and definition.

> A full replacement, not a patch: send every field you want to keep, because
an omitted `description` is written back as empty. Tiles and their layout
are not touched — change those through the tile endpoints.



## OpenAPI

````yaml /reference/openapi.json put /dashboards/{id}
openapi: 3.1.0
info:
  title: AgentEye API
  description: >-
    The AgentEye observability API.


    Every path below is relative to `/v1` on your deployment's dashboard origin
    — e.g. `https://app.example.com/v1/sessions`. Authenticate with a scoped API
    key as a bearer token.


    Organization scoping: a key belongs to one organization and acts on it
    automatically. An instance-scoped key selects one per request with the
    `X-AgentEye-Org` header; without it, such a key resolves to the default
    organization, so set it explicitly on a multi-org deployment.
  license:
    name: MIT
    identifier: MIT
  version: 0.0.1-beta.77
servers:
  - url: /v1
    description: This deployment
security:
  - api_key: []
tags:
  - name: Events
    description: Ingest and query the event store.
  - name: Sessions
    description: Agent sessions and their evaluations.
  - name: Evaluations
    description: Evaluation results and re-runs.
  - name: Dashboards
    description: Dashboards and their tiles.
  - name: Queries
    description: Saved SQL and ad-hoc query execution.
  - name: Keys
    description: Mint and manage scoped API keys.
  - name: Users
    description: Dashboard members and access.
  - name: Settings
    description: Operational settings and context-window overrides.
  - name: Permission sets
    description: Named permission roles.
  - name: Alerts
    description: Alert rules and their recipients.
  - name: Issues
    description: Open, triage, assign and resolve issues.
  - name: Audits
    description: Recurring audits and their findings.
  - name: Usage
    description: Organization usage and billing windows.
  - name: Health
    description: Liveness.
  - name: Auth
    description: Describe the key you are calling with.
paths:
  /dashboards/{id}:
    put:
      tags:
        - Dashboards
      summary: Replace a dashboard's name, description and definition.
      description: >-
        A full replacement, not a patch: send every field you want to keep,
        because

        an omitted `description` is written back as empty. Tiles and their
        layout

        are not touched — change those through the tile endpoints.
      operationId: update_dashboard
      parameters:
        - name: id
          in: path
          description: Dashboard id.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertDashboardRequest'
        required: true
      responses:
        '200':
          description: The updated dashboard.
        '401':
          description: Missing, unknown, or disabled key.
        '403':
          description: The key lacks `dashboards:write`.
        '404':
          description: No dashboard with that id in this organization.
        '422':
          description: '`name` is blank, or `definition` is not a JSON object.'
      security:
        - api_key: []
components:
  schemas:
    UpsertDashboardRequest:
      type: object
      required:
        - name
        - definition
      properties:
        definition:
          description: >-
            Opaque blob owned by the dashboard UI: `{ filters, display }`.
            Stored

            and returned verbatim; the server never interprets its contents.
        description:
          type: string
        name:
          type: string
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
      description: >-
        A scoped AgentEye API key. Mint one in the dashboard under Settings →
        API keys, or with `POST /v1/keys`. Each endpoint names the permission it
        requires; a key without it gets 403 and a `required_permission` field
        naming what was missing.

````