v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

dashboardManagement

List all dashboards.

List all dashboards under the Personal folder created by the user or under folders viewable by user.

get/v2/dashboards

Query parameters

limitinteger

Limit the number of dashboard returned in the response. The number of dashboards returned may be less than the limit.

tokenstring

Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

modestring

Example:createdByUser

whether to list all viewable dashboards under the folders

Response

Paginated list of dashboards under the Personal folder created by the user.

nextstring

Next continuation token. next is set to null when no more pages are left.

Example response

{
  "dashboards": [
    {
      "title": "Kubernetes Dashboard",
      "description": "A view of pods, namespaces and nodes of your cluster.",
      "folderId": "000000000C1C17C6",
      "topologyLabelMap": {
        "data": {
          "service": [
            "kube-scheduler",
            "kube-dns"
          ]
        }
      },
      "domain": "aws",
      "hierarchies": [
        "Kubernetes Node View"
      ],
      "refreshInterval": 30,
      "timeRange": {
        "type": "BeginBoundedTimeRange",
        "from": {
          "type": "RelativeTimeRangeBoundary",
          "relativeTime": "-15m"
        }
      },
      "panels": [
        {
          "id": "2F7D449E3D511066",
          "key": "panelca6280e4a75fca45",
          "title": "This panel shows memory usage for your kubernetes pod.",
          "visualSettings": "{\\\"general\\\":{\\\"type\\\":\\\"column\\\"}",
          "panelType": "SumoSearchPanel"
        }
      ],
      "layout": {
        "layoutType": "Grid",
        "layoutStructures": [
          {
            "key": "panelPANE-3DC454FD977E2A46",
            "structure": "{\\\"height\\\":5,\\\"width\\\":9,\\\"x\\\":0,\\\"y\\\":0}"
          }
        ]
      },
      "variables": [
        {
          "name": "_sourceHost",
          "displayName": "Source Host",
          "defaultValue": "default_value",
          "sourceDefinition": {
            "variableSourceType": "MetadataVariableSourceDefinition"
          },
          "includeAllOption": true,
          "valueType": "Any"
        }
      ],
      "theme": "light",
      "organizations": {
        "defaultOrgIds": [
          "us2-00000000FF42A0C3"
        ]
      },
      "id": "B23OjNs5ZCyn5VdMwOBoLo3PjgRnJSAlNTKEDAcpuDG2CIgRe9KFXMofm2H2",
      "contentId": "1",
      "scheduleId": "RdQHYPh2jxoS90DXtKfA7nAJV2rsQ9BncpfY7IkjNzQWi52ug85W7r6Rrmtd",
      "scheduleCount": 10
    }
  ],
  "next": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc"
}