Explore documentation
  1. Welcome to Telemetry 👋
  2. Quick start guide
  3. Wide events vs. metrics
  4. Ingesting data
    1. Better Stack collector
    2. OpenTelemetry
    3. Vector
    4. Ingesting via HTTP API
    5. Ingesting metrics
    6. Ingesting logs
    7. Migrating to Better Stack
  5. Using the product
    1. AI SRE ↗
    2. MCP server ↗
    3. Transforming ingested data
    4. Querying data
    5. Tracing
    6. Grafana
    7. Alerts
  6. Telemetry API
    1. Getting an API token
    2. Sources & collectors
    3. Dashboards
      1. Dashboards API
        1. List all dashboards GET
        2. Get a single dashboard GET
        3. Create a dashboard POST
        4. Update a dashboard PATCH
        5. Remove a dashboard DELETE
        6. Export a dashboard GET
        7. Import a dashboard POST
        8. List templates GET
      2. Charts API
      3. Chart comments API
      4. Dashboard sections API
      5. Dashboard alerts API
      6. Dashboard groups API
    4. Explorations
    5. Alerts API
    6. Connections API
    7. Query API ↗
    8. Usage API ↗
  7. Alternative to
    1. Lightstep

Update a dashboard

Updates an existing dashboard by its ID. You only need to provide the fields you want to change.

PATCH https://telemetry.betterstack.com/api/v2/dashboards/{id}

URL parameters

id
required string

The unique identifier of the dashboard to update.

Headers

Authorization
required string

Bearer $TOKEN

Body parameters

name
string

A new name for the dashboard.

dashboard_group_id
integer

A new dashboard group ID. Use 0 or null to remove from a group.

refresh_interval
integer

A new refresh interval in seconds.

date_range_from
string

A new start for the dashboard's date range.

date_range_to
string

A new end for the dashboard's date range.

source_eligibility_sql
string

A new SQL filter for source eligibility.

variables
array

An array of variable objects. Custom variables missing from it are removed.

200

The dashboard was updated successfully.

Response body

{
  "data": {
    "id": "12345",
    "type": "dashboard",
    "attributes": {
      "team_id": 123,
      "team_name": "My Team",
      "name": "Updated API Dashboard",
      "dashboard_group_id": null,
      "refresh_interval": 120,
      "date_range_from": "now-3h",
      "date_range_to": "now",
      "source_eligibility_sql": null,
      "created_at": "2026-03-25T10:00:00.000Z",
      "updated_at": "2026-03-25T10:05:00.000Z",
      "variables": [
        {
          "name": "time",
          "variable_type": "datetime",
          "values": [],
          "default_values": []
        },
        {
          "name": "start_time",
          "variable_type": "datetime",
          "values": [],
          "default_values": []
        },
        {
          "name": "end_time",
          "variable_type": "datetime",
          "values": [],
          "default_values": []
        },
        {
          "name": "source",
          "variable_type": "source",
          "values": [],
          "default_values": []
        },
        {
          "name": "environment",
          "variable_type": "string",
          "values": [
            "staging"
          ],
          "default_values": [
            "staging"
          ]
        }
      ],
      "charts": [],
      "sections": [],
      "has_overlaps": false
    }
  }
}
404

A dashboard with the specified ID was not found.

422

Validation failed due to invalid parameters (e.g., empty name).

Response body

{
  "errors": "Sorry, some values are incorrect",
  "invalid_values": {
    "name": [
      "can't be blank"
    ]
  }
}

What happens to variables and fields you leave out?

Custom variables missing from variables are removed. System variables time, start_time, end_time, and source are always kept.

A listed variable that already exists keeps its variable_type, default_values, sql_definition, structured_value, and allow_multiple_values when you leave them out, and null clears any of them except variable_type. Its selection is not kept: send values again, or it's cleared. Changing variable_type drops the old default_values, sql_definition, and structured_value.

Example request

cURL
curl --request PATCH \
  --url https://telemetry.betterstack.com/api/v2/dashboards/1234 \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Updated API Dashboard",
    "refresh_interval": 120,
    "variables": [
      {
        "name": "environment",
        "variable_type": "string",
        "values": ["staging"],
        "default_values": ["staging"]
      }
    ]
  }'


Previous article

Create a dashboard

Next article

Remove a dashboard