Skip to main content
POST
/
api
/
public
/
v1
/
dashboards
/
external
Create external dashboard
curl --request POST \
  --url https://app.msportal.ai/api/public/v1/dashboards/external \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "description": "<string>",
  "iconUrl": "<string>",
  "displayOrder": 500,
  "isActive": true,
  "roleIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "url": "<string>",
    "iconUrl": "<string>",
    "displayOrder": 123,
    "isActive": true,
    "isDefault": true,
    "allowInIframe": true,
    "framePolicy": "<string>",
    "roleIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "roleNames": [
      "<string>"
    ],
    "companyUrls": [
      {
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyName": "<string>",
        "url": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

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