Dashboards
List dashboards
Get a paginated list of dashboards that your account has access to.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters dashboards in the response.
Show Child Parameters
Sorts a collection of dashboards. Supported sort attributes are:
- name
- created_at
- updated_at
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
Example:created_at desc
Response
application/json
Response
List of dashboards
returns the pagination information
Show Child Parameters
Show Child Parameters
Authentication
Query Parameters
Create a new dashboard
Creates a new dashboard from the provided definition.
Body
application/json
Body
Dashboard Request
The dashboard name, which is displayed at the top of the dashboard and in lists.
It does not need to be unique.
>= 1 characters<= 255 characters
A JSON object describing a dashboard.
A dashboard is an array of tiles. All tiles are of type ‘chart’, which query data and render a chart displaying that data.
Dashboards have 6 columns and as many rows as necessary to display their tiles.
Show Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Response
application/json
Response
The created dashboard, including generated fields.
Dashboard Request
The dashboard name, which is displayed at the top of the dashboard and in lists.
It does not need to be unique.
>= 1 characters<= 255 characters
A JSON object describing a dashboard.
A dashboard is an array of tiles. All tiles are of type ‘chart’, which query data and render a chart displaying that data.
Dashboards have 6 columns and as many rows as necessary to display their tiles.
Show Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Body
Get a single dashboard
Get a dashboard that your account has access to.
Path Parameters
The dashboard’s ID.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
The dashboard with the given ID.
Dashboard Request
The dashboard name, which is displayed at the top of the dashboard and in lists.
It does not need to be unique.
>= 1 characters<= 255 characters
A JSON object describing a dashboard.
A dashboard is an array of tiles. All tiles are of type ‘chart’, which query data and render a chart displaying that data.
Dashboards have 6 columns and as many rows as necessary to display their tiles.
Show Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update an existing dashboard
Update an existing dashboard, replacing its definition with the provided one.
Path Parameters
The dashboard’s ID.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
Dashboard Request
The dashboard name, which is displayed at the top of the dashboard and in lists.
It does not need to be unique.
>= 1 characters<= 255 characters
A JSON object describing a dashboard.
A dashboard is an array of tiles. All tiles are of type ‘chart’, which query data and render a chart displaying that data.
Dashboards have 6 columns and as many rows as necessary to display their tiles.
Show Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Response
application/json
Response
The created dashboard, including generated fields.
Dashboard Request
The dashboard name, which is displayed at the top of the dashboard and in lists.
It does not need to be unique.
>= 1 characters<= 255 characters
A JSON object describing a dashboard.
A dashboard is an array of tiles. All tiles are of type ‘chart’, which query data and render a chart displaying that data.
Dashboards have 6 columns and as many rows as necessary to display their tiles.
Show Child Parameters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z