Headers

• kbn-xsrf string Required

  A required header to protect against CSRF attacks

Path parameters

• id string Required

  A unique identifier for the dashboard.

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • item object Required

    Additional properties are allowed.

    Hide item attributes Show item attributes object

    • attributes object Required

      Additional properties are NOT allowed.

      Hide attributes attributes Show attributes attributes object

      • controlGroupInput object

        Additional properties are NOT allowed.

        Hide controlGroupInput attributes Show controlGroupInput attributes object

        • autoApplySelections boolean

          Show apply selections button in controls.

          Default value is true.

        • chainingSystem string

          The chaining strategy for multiple controls. For example, "HIERARCHICAL" or "NONE".

          Values are NONE or HIERARCHICAL. Default value is HIERARCHICAL.

        • controls array[object]

          An array of control panels and their state in the control group.

          Default value is [] (empty).

          Hide controls attributes Show controls attributes object

          • controlConfig object

            Additional properties are allowed.

          • grow boolean

            Expand width of the control panel to fit available space.

            Default value is false.

          • id string

            The unique ID of the control.

          • order number Required

            The order of the control panel in the control group.

          • type string Required

            The type of the control panel.

          • width string

            Minimum width of the control panel in the control group.

            Values are small, medium, or large. Default value is medium.

        • enhancements object

          Additional properties are allowed.

        • ignoreParentSettings object Required

          Additional properties are NOT allowed.

          Hide ignoreParentSettings attributes Show ignoreParentSettings attributes object

          • ignoreFilters boolean

            Ignore global filters in controls.

            Default value is false.

          • ignoreQuery boolean

            Ignore the global query bar in controls.

            Default value is false.

          • ignoreTimerange boolean

            Ignore the global time range in controls.

            Default value is false.

          • ignoreValidations boolean

            Ignore validations in controls.

            Default value is false.

        • labelPosition string

          Position of the labels for controls. For example, "oneLine", "twoLine".

          Values are oneLine or twoLine. Default value is oneLine.

      • description string

        A short description.

        Default value is empty.

      • kibanaSavedObjectMeta object

        A container for various metadata

        Default value is {} (empty). Additional properties are NOT allowed.

        Hide kibanaSavedObjectMeta attribute Show kibanaSavedObjectMeta attribute object

        • searchSource object

          Additional properties are allowed.

          Hide searchSource attributes Show searchSource attributes object

          • filter array[object]

            A filter for the search source.

            Hide filter attributes Show filter attributes object

            • $state object

              Additional properties are NOT allowed.

              Hide $state attribute Show $state attribute object

              • store string Required

                Denote whether a filter is specific to an application's context (e.g. 'appState') or whether it should be applied globally (e.g. 'globalState').

                Values are appState or globalState.

            • meta object Required

              Additional properties are allowed.

              Hide meta attributes Show meta attributes object

              • alias string | null
              • controlledBy string
              • disabled boolean
              • field string
              • group string
              • index string
              • isMultiIndex boolean
              • key string
              • negate boolean
              • type string
              • value string
            • query object

              Additional properties are allowed.

          • query object

            Additional properties are NOT allowed.

            Hide query attributes Show query attributes object

            • language string Required

              The query language such as KQL or Lucene.

            • query string | object Required

              Any of:

              string-1 string object-2 object

              A text-based query such as Kibana Query Language (KQL) or Lucene query language.

              Additional properties are allowed.

          • sort array[object]
          • type string
      • options object Required

        Additional properties are NOT allowed.

        Hide options attributes Show options attributes object

        • hidePanelTitles boolean

          Hide the panel titles in the dashboard.

          Default value is false.

        • syncColors boolean

          Synchronize colors between related panels in the dashboard.

          Default value is true.

        • syncCursor boolean

          Synchronize cursor position between related panels in the dashboard.

          Default value is true.

        • syncTooltips boolean

          Synchronize tooltips between related panels in the dashboard.

          Default value is true.

        • useMargins boolean

          Show margins between panels in the dashboard layout.

          Default value is true.

      • panels array[object]

        Default value is [] (empty).

        Hide panels attributes Show panels attributes object

        • gridData object Required

          Additional properties are NOT allowed.

          Hide gridData attributes Show gridData attributes object

          • h number

            The height of the panel in grid units

            Minimum value is 1. Default value is 15.

          • i string Required
          • w number

            The width of the panel in grid units

            Minimum value is 1, maximum value is 48. Default value is 24.

          • x number Required

            The x coordinate of the panel in grid units

          • y number Required

            The y coordinate of the panel in grid units

        • id string

          The saved object id for by reference panels

        • panelConfig object Required

          Additional properties are allowed.

          Hide panelConfig attributes Show panelConfig attributes object

          • description string

            The description of the panel

          • enhancements object

            Additional properties are allowed.

          • hidePanelTitles boolean

            Set to true to hide the panel title in its container.

          • savedObjectId string

            The unique id of the library item to construct the embeddable.

          • title string

            The title of the panel

          • version string

            The version of the embeddable in the panel.

        • panelIndex string Required
        • panelRefName string
        • title string

          The title of the panel

        • type string Required

          The embeddable type

        • version string Deprecated

          The version was used to store Kibana version information from versions 7.3.0 -> 8.11.0. As of version 8.11.0, the versioning information is now per-embeddable-type and is stored on the embeddable's input. (panelConfig in this type).

      • refreshInterval object

        A container for various refresh interval settings

        Additional properties are NOT allowed.

        Hide refreshInterval attributes Show refreshInterval attributes object

        • display string Deprecated

          A human-readable string indicating the refresh frequency. No longer used.

        • pause boolean Required

          Whether the refresh interval is set to be paused while viewing the dashboard.

        • section number Deprecated

          No longer used.

        • value number Required

          A numeric value indicating refresh frequency in milliseconds.

      • timeFrom string

        An ISO string indicating when to restore time from

      • timeRestore boolean

        Whether to restore time upon viewing this dashboard

        Default value is false.

      • timeTo string

        An ISO string indicating when to restore time from

      • title string Required

        A human-readable title for the dashboard

      • version number Deprecated
    • 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