Skip to main content
GET
/
v1
/
dashboards
/
{id}
Get dashboard details
curl --request GET \
  --url https://api.cnap.tech/v1/dashboards/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "j572abc123def456",
  "name": "Cluster Overview",
  "description": "<string>",
  "workspace_id": "<string>",
  "widgets": [
    {
      "snippet_id": "<string>",
      "col_span": 2,
      "display_type": "table"
    }
  ],
  "created_by": "<string>",
  "created_at": 123
}

Authorizations

Authorization
string
header
required

Personal Access Token (cnap_pat_...) or OAuth2 JWT. Create tokens at https://cnap.tech/account/tokens

Path Parameters

id
string
required

Dashboard ID

Response

Dashboard details

id
string
required
Example:

"j572abc123def456"

name
string
required
Example:

"Cluster Overview"

description
string | null
required

Optional dashboard description

workspace_id
string
required
widgets
object[]
required

Ordered list of widgets in the dashboard grid

created_by
string
required

User ID of the dashboard creator

created_at
number
required

Unix timestamp (seconds)