Get a list of dashboards Technical Preview

GET /api/dashboards/dashboard

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Query parameters

  • page number

    The page number to return. Default is "1".

    Minimum value is 1. Default value is 1.

  • perPage number

    The number of dashboards to display on each page (max 1000). Default is "20".

    Minimum value is 1, maximum value is 1000.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • attributes object Required

        Additional properties are NOT allowed.

        Hide attributes attributes Show attributes attributes object
        • description string

          A short description.

          Default value is empty.

        • timeRestore boolean

          Whether to restore time upon viewing this dashboard

          Default value is false.

        • title string Required

          A human-readable title for the dashboard

      • createdAt string
      • createdBy string
      • error object

        Additional properties are NOT allowed.

        Hide error attributes Show error attributes object
        • error string Required
        • message string Required
        • metadata object

          Additional properties are allowed.

        • statusCode number Required
      • id string Required
      • managed boolean
      • namespaces array[string]
      • originId string
      • references array[object] Required
        Hide references attributes Show references attributes object
        • id string Required
        • name string Required
        • type string Required
      • type string Required
      • updatedAt string
      • updatedBy string
      • version string
    • total number Required
GET /api/dashboards/dashboard
curl \
 --request GET 'http://localhost:5601/api/dashboards/dashboard' \
 --header "Authorization: $API_KEY"