Skip to content
BleemeoBleemeo

Create a dashboard

POST
/v1/dashboard/
curl --request POST \
  --url https://example.com/v1/dashboard/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "dashboard_type": 0, "dashboardlayout": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "description": "example", "name": "example", "tags": [ { "name": "example", "tag_type": 0 } ] }'

Create a new dashboard.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
account
required
string format: uuid
created_at
required
string format: date-time
created_by
required
string format: uuid
nullable
dashboard_type
  • 0 - Custom
  • 1 - Template
integer
>= -2147483648 <= 2147483647
Allowed values: 0 1
dashboardlayout
string format: uuid
nullable
description
string
id
required
string format: uuid
is_dashboard_k8s
required

For app mobile compatibility

boolean
is_dashboard_services
required

For app mobile compatibility

boolean
is_dashboard_stack
required

For app mobile compatibility

boolean
is_dashboard_system
required
boolean
is_dashboard_template
required
boolean
is_favorite
required
boolean
is_sandbox
required
boolean
min_step
required
string
modified_at
required
string format: date-time
modified_by
required
string format: uuid
nullable
name
required
string
<= 1050 characters
tags
Array<object>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
required
string format: uuid
is_automatic
required
boolean
is_service_tag
required
boolean
name
required
string
<= 100 characters
tag_type
  • 0 - Automatic API
  • 1 - Created by Glouton
  • 2 - Created by frontend
  • 3 - Automatic Glouton
  • 4 - Automatic API for agent’s service
  • 10 - No type
integer
>= -2147483648 <= 2147483647
Allowed values: 0 1 2 3 4 10
tag_type_text
required
string
widgets
required
Array<string>

Responses

Section titled “Responses”

201

Section titled “201”
Media typeapplication/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
account
required
string format: uuid
created_at
required
string format: date-time
created_by
required
string format: uuid
nullable
dashboard_type
  • 0 - Custom
  • 1 - Template
integer
>= -2147483648 <= 2147483647
Allowed values: 0 1
dashboardlayout
string format: uuid
nullable
description
string
id
required
string format: uuid
is_dashboard_k8s
required

For app mobile compatibility

boolean
is_dashboard_services
required

For app mobile compatibility

boolean
is_dashboard_stack
required

For app mobile compatibility

boolean
is_dashboard_system
required
boolean
is_dashboard_template
required
boolean
is_favorite
required
boolean
is_sandbox
required
boolean
min_step
required
string
modified_at
required
string format: date-time
modified_by
required
string format: uuid
nullable
name
required
string
<= 1050 characters
tags
Array<object>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object
id
required
string format: uuid
is_automatic
required
boolean
is_service_tag
required
boolean
name
required
string
<= 100 characters
tag_type
  • 0 - Automatic API
  • 1 - Created by Glouton
  • 2 - Created by frontend
  • 3 - Automatic Glouton
  • 4 - Automatic API for agent’s service
  • 10 - No type
integer
>= -2147483648 <= 2147483647
Allowed values: 0 1 2 3 4 10
tag_type_text
required
string
widgets
required
Array<string>
Example
{
  "dashboard_type": 0,
  "tags": [
    {
      "tag_type": 0
    }
  ]
}