Skip to main content

Configuration service (v1)

Download OpenAPI specification:Download

Dashboards

Get all dashboards

query Parameters
cursor
string <byte>

Paging cursor

direction
string (PagingCommand.Direction)
Enum: "NEXT" "PREVIOUS"

Paging direction

pageSize
integer [ 1 .. 100 ]

Page size

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new dashboard

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required

JSON representation of the dashboard to be created

name
required
string [ 1 .. 255 ] characters
default
boolean
required
Array of objects (Dashboard.Widget)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "default": true,
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Get dashboard by name

path Parameters
name
required
string

Dashboard name

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "default": true,
  • "widgets": [
    ]
}

Update an existing dashboard

path Parameters
name
required
string

Dashboard name

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Request Body schema: application/json
required
name
required
string [ 1 .. 255 ] characters
default
boolean
required
Array of objects (Dashboard.Widget)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "default": true,
  • "widgets": [
    ]
}

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Remove an existing dashboard

path Parameters
name
required
string

Dashboard name

header Parameters
X-Scope-OrgID
string

Scope header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}