Skip to main content
POST
Create a dashboard

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

POST /dashboards

title
string
required
Required string length: 1 - 120
description
string | null
Maximum string length: 500
slug
string | null
columns
integer
default:12
Required range: 1 <= x <= 24
components
ComponentCreateSchema · object[]
permissions
string[]
agent_id
integer | null

Response

Successful Response

Full dashboard returned by the API.

id
string
required
title
string
required
description
string | null
required
slug
string | null
required
columns
integer
required
status
enum<string>
required
Available options:
draft,
published,
archived
visibility
enum<string>
required
Available options:
private,
organization,
public
version
integer
required
components
ComponentResponse · object[]
required
permissions
string[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
created_by
string | null
required
agent_id
integer | null