Skip to main content
POST
Create external dashboard

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Body

application/json
name
string
required

Dashboard name (required)

Required string length: 1 - 255
url
string<uri>
required

Dashboard URL (must be HTTPS)

description
string

Dashboard description

Maximum string length: 1000
iconUrl
string<uri>

Icon URL

displayOrder
integer

Display order

Required range: 0 <= x <= 1000
isActive
boolean

Initial active status

roleIds
string<uuid>[]

Role IDs to assign

Response

External dashboard created

data
object
required