Update a dashboard

patch

https://{customerid}.observeinc.com/v1/dashboards/{id}

Beta — may change; breaking changes are coordinated with affected
customers. Suitable for evaluation, not production reliance.

Merge-patch update (RFC 7396).
Omitted fields are unchanged. When definition is present it replaces the
whole document (not a deep merge).

description is the only field that accepts a JSON null, which clears
it. Sending null for schemaVersion, name, visibility,
objectTags, or definition is rejected; omit the field instead to
leave it unchanged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Unique identifier of the dashboard (numeric id serialized as a string).

Query Params

expand

boolean

Whether to expand resources referenced in the response to include additional fields

Body Params

Merge-patch (RFC 7396) body for a dashboard. Only fields present are
applied. When definition is present it replaces the whole document.

schemaVersion

integer

enum

Must be 2 when sent.

Allowed:

name

string

length ≥ 1

description

string | null

visibility

string

enum

Allowed:

objectTags

object

User-applied tags for organization and discovery, as a map of tag key
to a list of values. For example: {"env": ["prod", "staging"], "team": ["platform"]}.

definition

object

The dashboard body — what the dashboard shows — kept separate
from the identity, audit, and governance metadata on the
dashboard itself so the two can evolve independently. This is
the object governed by schemaVersion.

Responses

Language

Credentials

Bearer

Authorization: Bearer <customerid> <apitoken>

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Dashboard updated successfully

400Bad request

401Unauthorized

403Forbidden

404Resource not found

409Conflict

422Unprocessable entity — a required query parameter was omitted (e.g. missing_field).

429Rate limit reached

5XXInternal server error