Skip to main content
PUT
/
v3
/
dashboards
/
{dashboard_id}
Update an existing dashboard
curl --request PUT \
  --url https://api.ctrl-hub.com/v3/dashboards/{dashboard_id} \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "scope": "<string>",
      "name": "<string>",
      "cards": [
        {}
      ],
      "order": 123
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "scope": "landing",
      "name": "My landing view",
      "order": 0,
      "cards": [
        {}
      ],
      "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

​
dashboard_id
string<uuid>
required

The unique identifier for the dashboard.

Body

application/vnd.api+json

The dashboard to update. Replaces the supplied attributes wholesale.

​
data
object
required

Response

Get a dashboard.

JSON API response object

​
data
object
required

A user-owned dashboard, composed of cards laid out on a fixed-slot bento grid. The shape of each card instance is defined by the frontend card registry; the API treats the cards array as opaque JSON.

​
jsonapi
object
required