-
Notifications
You must be signed in to change notification settings - Fork 8.5k
[Dashboard] Update request and response format for dashboard apis #227886
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
🤖 Jobs for this PR can be triggered through checkboxes. 🚧
ℹ️ To trigger the CI, please tick the checkbox below 👇
|
src/platform/plugins/shared/dashboard/server/content_management/v1/cm_services.ts
Outdated
Show resolved
Hide resolved
…t/v1/cm_services.ts Co-authored-by: Nick Peihl <[email protected]>
src/platform/plugins/shared/dashboard/server/content_management/v1/cm_services.ts
Outdated
Show resolved
Hide resolved
src/platform/plugins/shared/dashboard/server/content_management/v1/cm_services.ts
Outdated
Show resolved
Hide resolved
src/platform/plugins/shared/dashboard/server/content_management/v1/cm_services.ts
Outdated
Show resolved
Hide resolved
nickpeihl
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for updating the schema. I've left a few suggestions / questions.
src/platform/plugins/shared/dashboard/server/content_management/v1/cm_services.ts
Outdated
Show resolved
Hide resolved
...d/public/services/dashboard_content_management_service/dashboard_content_management_cache.ts
Outdated
Show resolved
Hide resolved
src/platform/plugins/shared/content_management/common/rpc/search.ts
Outdated
Show resolved
Hide resolved
| meta: M; | ||
| }; | ||
|
|
||
| export type DashboardItemResult<T = unknown, M = void> = M extends void |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I didn't mean we should define a DashboardItemResult in this plugin as other applications consume types from this plugin. I may have to think about this a little more. My head spins every time I try to wrap my head around all of these generics.
Dashboard api
Content management api
O11y Dashboard UI
Saved object UI
Data views UI
|
|
Cloud deployments require a Github label, please add |
💔 Build Failed
Failed CI StepsHistory
|
…32458) ## Summary Implement #196609 #227886 affects too many files, this PR limits the scope to only dashboard api. ## API functional test: ``` node scripts/functional_tests_server.js --config ./src/platform/test/api_integration/config.js node scripts/functional_test_runner --config=src/platform/test/api_integration/config.js ``` ## Dashboard apis <img width="3444" height="3050" alt="content management drawio" src="https://github.com/user-attachments/assets/4680c3d1-a00c-439d-8897-c953f6f7dd23" /> ### Create ``` POST kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 { "version": 2, "controlGroupInput": { "autoApplySelections": true, "chainingSystem": "HIERARCHICAL", "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "labelPosition": "oneLine", "controls": [] }, "kibanaSavedObjectMeta": { "searchSource": { "filter": [], "query": { "query": "", "language": "kuery" } } }, "description": "xxx", "timeRestore": false, "options": { "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false, "hidePanelTitles": false }, "panels": [], "title": "five" } ``` Response: ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:00:11.462Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIxLDFd" } } ``` ### Get ``` GET kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 ``` Response ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:00:11.462Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIxLDFd", "outcome": "exactMatch" } } ``` ### Update ``` PUT kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 { "version": 2, "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "filter": [], "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five+++", "references": [], "spaces": [ "default" ] } ``` Response ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five+++", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "updatedAt": "2025-09-15T11:08:33.625Z", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "version": "WzIyLDFd" } } ``` ### Delete ``` DELETE kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 ``` Response ``` OK ``` ### List ``` GET kbn:/api/dashboards/dashboard?apiVersion=1 ``` Response: ``` { "items": [ { "id": "security-detection-rule-monitoring-default", "type": "dashboard", "data": { "title": "[Elastic Security] Detection rule monitoring", "description": "This dashboard helps you monitor the health and performance of detection rules.", "timeRestore": false, "namespaces": [ "default" ], "references": [ { "type": "tag", "id": "fleet-managed-default", "name": "tag-ref-fleet-managed" }, { "type": "tag", "id": "security-solution-default", "name": "tag-ref-security-solution" }, { "id": "kibana-event-log-data-view", "name": "52ec5ce0-3ea9-42ee-91f2-0f664d6cb74d:indexpattern-datasource-layer-66195a85-b71e-45f5-a5ea-4388416cf5f7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "52ec5ce0-3ea9-42ee-91f2-0f664d6cb74d:874e1b4c-a64b-426a-b43e-d4ee226610a9", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "91a23437-071d-4739-b57e-2881caa980eb:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "91a23437-071d-4739-b57e-2881caa980eb:37539143-7ea2-4353-ae4e-78ec772d1508", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9770096c-3ba7-42e4-9783-5042ff08896d:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9770096c-3ba7-42e4-9783-5042ff08896d:32816692-7d96-4a12-abe3-3016e8a3844c", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "12011f8d-0d0d-40d6-8ef5-0d50bfe570f8:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "12011f8d-0d0d-40d6-8ef5-0d50bfe570f8:9acb5e9e-8c72-4ba6-a4f5-7f2901353c16", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3b0743e-9a2c-4173-babc-dc93204cc0f2:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3b0743e-9a2c-4173-babc-dc93204cc0f2:9adf5837-270f-43bf-92d8-af2d74022292", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "78c659aa-a001-4c30-9452-e9c7d0c0ec5d:indexpattern-datasource-layer-4eaf036b-c9f5-4206-bcfe-8033bec44a21", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "78c659aa-a001-4c30-9452-e9c7d0c0ec5d:abcc85f3-00cd-48bd-a313-de50207ab1b6", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3dd29a9-c051-46ab-b1fa-facf899f7af9:indexpattern-datasource-layer-4eaf036b-c9f5-4206-bcfe-8033bec44a21", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3dd29a9-c051-46ab-b1fa-facf899f7af9:0ccd359c-35a9-42ee-9b53-e0061755ffef", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "ad5995be-bf0f-48ba-8dc8-7313ca3bfbae:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "ad5995be-bf0f-48ba-8dc8-7313ca3bfbae:2720edea-b96b-47d7-bf57-ff3a4c91ab9d", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2eac0a4e-9ec7-433e-89bc-e8edc1dadae7:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2eac0a4e-9ec7-433e-89bc-e8edc1dadae7:0b7e01b1-974a-4de9-867d-46fc000c63e3", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "d2e87680-4d92-4067-9f27-7749854dedce:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "d2e87680-4d92-4067-9f27-7749854dedce:4101bdcb-5ba8-406f-8893-07356a98d49b", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2372c630-207e-4859-83a9-de5a7bc638dc:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2372c630-207e-4859-83a9-de5a7bc638dc:adafccc0-9c17-4249-89e1-e61a8d00079b", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "e2504c27-3027-4c13-85c0-a66416c53bd4:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "e2504c27-3027-4c13-85c0-a66416c53bd4:edb4ad7f-1ef2-477f-980c-c6fe47d6470d", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "fe382f90-aa03-47e0-a8a0-d6a8de877467:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "fe382f90-aa03-47e0-a8a0-d6a8de877467:505272a2-f4fb-4778-9fdf-11415f36cc51", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "0b6f467f-f784-457e-9351-839874bef66e:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "0b6f467f-f784-457e-9351-839874bef66e:e0a238a9-104e-46c0-890a-c7b3e1c08018", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2ad1eb6c-c19b-41b1-897e-2d1d192cedae:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2ad1eb6c-c19b-41b1-897e-2d1d192cedae:5f5acf46-a12a-43cf-8d4a-b1ef1a971771", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "6ce283f7-115a-4a0f-9184-71e141149183:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "6ce283f7-115a-4a0f-9184-71e141149183:a1fed0ee-76a2-476e-8614-9fe8e71128b3", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "f5d7a9c8-839c-408c-b798-68d019483bc7:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "f5d7a9c8-839c-408c-b798-68d019483bc7:ee506497-3313-49d4-9cc9-353e55305547", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2168b471-9a51-4ead-a51e-15e52ba85d86:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2168b471-9a51-4ead-a51e-15e52ba85d86:c5902ca2-58ae-4b1c-b420-5208b7cb16c4", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "075d7dff-442b-4091-bfe2-3844e7e7e3f4:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "075d7dff-442b-4091-bfe2-3844e7e7e3f4:64b1a767-a32b-4a59-9fae-de5f08d38208", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-54585793-d86f-4dce-8fb1-80b6ef529e4f", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-87d56d88-cfac-492c-ba95-a70cb5815c20", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-223cc135-2457-4248-aada-6d1d10cfa126", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:cdd8151e-3bd4-4b23-8844-e836e0f10c91", "type": "index-pattern" }, { "name": "controlGroup_c9c507d9-a157-40b4-aec4-0a2e204c559c:optionsListDataView", "type": "index-pattern", "id": "kibana-event-log-data-view" }, { "name": "controlGroup_8b3b697c-2abf-4801-8a08-a1a29d483571:optionsListDataView", "type": "index-pattern", "id": "kibana-event-log-data-view" } ] }, "meta": { "createdAt": "2025-09-15T10:22:20.373Z", "updatedAt": "2025-09-15T10:22:20.373Z", "managed": true, "version": "WzYsMV0=" } }, { "id": "a51412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:22:50.768Z", "updatedAt": "2025-09-15T10:22:50.768Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE0LDFd" } }, { "id": "a53412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:30:32.617Z", "updatedAt": "2025-09-15T10:30:32.617Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE2LDFd" } }, { "id": "a52412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:26:47.286Z", "updatedAt": "2025-09-15T10:26:47.286Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE1LDFd" } }, { "id": "a54412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:40:16.427Z", "updatedAt": "2025-09-15T10:40:16.427Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE3LDFd" } }, { "id": "a55412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:41:46.145Z", "updatedAt": "2025-09-15T10:41:46.145Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE4LDFd" } }, { "id": "a56412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:44:24.153Z", "updatedAt": "2025-09-15T10:44:24.153Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE5LDFd" } }, { "id": "a57412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:46:20.279Z", "updatedAt": "2025-09-15T10:46:20.279Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIwLDFd" } }, { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five+++", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:08:33.625Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIyLDFd" } } ], "total": 9 } ``` --------- Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: kibanamachine <[email protected]>
…astic#232458) ## Summary Implement elastic#196609 elastic#227886 affects too many files, this PR limits the scope to only dashboard api. ## API functional test: ``` node scripts/functional_tests_server.js --config ./src/platform/test/api_integration/config.js node scripts/functional_test_runner --config=src/platform/test/api_integration/config.js ``` ## Dashboard apis <img width="3444" height="3050" alt="content management drawio" src="https://github.com/user-attachments/assets/4680c3d1-a00c-439d-8897-c953f6f7dd23" /> ### Create ``` POST kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 { "version": 2, "controlGroupInput": { "autoApplySelections": true, "chainingSystem": "HIERARCHICAL", "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "labelPosition": "oneLine", "controls": [] }, "kibanaSavedObjectMeta": { "searchSource": { "filter": [], "query": { "query": "", "language": "kuery" } } }, "description": "xxx", "timeRestore": false, "options": { "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false, "hidePanelTitles": false }, "panels": [], "title": "five" } ``` Response: ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:00:11.462Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIxLDFd" } } ``` ### Get ``` GET kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 ``` Response ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:00:11.462Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIxLDFd", "outcome": "exactMatch" } } ``` ### Update ``` PUT kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 { "version": 2, "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "filter": [], "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five+++", "references": [], "spaces": [ "default" ] } ``` Response ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five+++", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "updatedAt": "2025-09-15T11:08:33.625Z", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "version": "WzIyLDFd" } } ``` ### Delete ``` DELETE kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 ``` Response ``` OK ``` ### List ``` GET kbn:/api/dashboards/dashboard?apiVersion=1 ``` Response: ``` { "items": [ { "id": "security-detection-rule-monitoring-default", "type": "dashboard", "data": { "title": "[Elastic Security] Detection rule monitoring", "description": "This dashboard helps you monitor the health and performance of detection rules.", "timeRestore": false, "namespaces": [ "default" ], "references": [ { "type": "tag", "id": "fleet-managed-default", "name": "tag-ref-fleet-managed" }, { "type": "tag", "id": "security-solution-default", "name": "tag-ref-security-solution" }, { "id": "kibana-event-log-data-view", "name": "52ec5ce0-3ea9-42ee-91f2-0f664d6cb74d:indexpattern-datasource-layer-66195a85-b71e-45f5-a5ea-4388416cf5f7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "52ec5ce0-3ea9-42ee-91f2-0f664d6cb74d:874e1b4c-a64b-426a-b43e-d4ee226610a9", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "91a23437-071d-4739-b57e-2881caa980eb:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "91a23437-071d-4739-b57e-2881caa980eb:37539143-7ea2-4353-ae4e-78ec772d1508", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9770096c-3ba7-42e4-9783-5042ff08896d:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9770096c-3ba7-42e4-9783-5042ff08896d:32816692-7d96-4a12-abe3-3016e8a3844c", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "12011f8d-0d0d-40d6-8ef5-0d50bfe570f8:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "12011f8d-0d0d-40d6-8ef5-0d50bfe570f8:9acb5e9e-8c72-4ba6-a4f5-7f2901353c16", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3b0743e-9a2c-4173-babc-dc93204cc0f2:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3b0743e-9a2c-4173-babc-dc93204cc0f2:9adf5837-270f-43bf-92d8-af2d74022292", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "78c659aa-a001-4c30-9452-e9c7d0c0ec5d:indexpattern-datasource-layer-4eaf036b-c9f5-4206-bcfe-8033bec44a21", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "78c659aa-a001-4c30-9452-e9c7d0c0ec5d:abcc85f3-00cd-48bd-a313-de50207ab1b6", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3dd29a9-c051-46ab-b1fa-facf899f7af9:indexpattern-datasource-layer-4eaf036b-c9f5-4206-bcfe-8033bec44a21", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3dd29a9-c051-46ab-b1fa-facf899f7af9:0ccd359c-35a9-42ee-9b53-e0061755ffef", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "ad5995be-bf0f-48ba-8dc8-7313ca3bfbae:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "ad5995be-bf0f-48ba-8dc8-7313ca3bfbae:2720edea-b96b-47d7-bf57-ff3a4c91ab9d", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2eac0a4e-9ec7-433e-89bc-e8edc1dadae7:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2eac0a4e-9ec7-433e-89bc-e8edc1dadae7:0b7e01b1-974a-4de9-867d-46fc000c63e3", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "d2e87680-4d92-4067-9f27-7749854dedce:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "d2e87680-4d92-4067-9f27-7749854dedce:4101bdcb-5ba8-406f-8893-07356a98d49b", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2372c630-207e-4859-83a9-de5a7bc638dc:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2372c630-207e-4859-83a9-de5a7bc638dc:adafccc0-9c17-4249-89e1-e61a8d00079b", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "e2504c27-3027-4c13-85c0-a66416c53bd4:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "e2504c27-3027-4c13-85c0-a66416c53bd4:edb4ad7f-1ef2-477f-980c-c6fe47d6470d", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "fe382f90-aa03-47e0-a8a0-d6a8de877467:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "fe382f90-aa03-47e0-a8a0-d6a8de877467:505272a2-f4fb-4778-9fdf-11415f36cc51", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "0b6f467f-f784-457e-9351-839874bef66e:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "0b6f467f-f784-457e-9351-839874bef66e:e0a238a9-104e-46c0-890a-c7b3e1c08018", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2ad1eb6c-c19b-41b1-897e-2d1d192cedae:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2ad1eb6c-c19b-41b1-897e-2d1d192cedae:5f5acf46-a12a-43cf-8d4a-b1ef1a971771", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "6ce283f7-115a-4a0f-9184-71e141149183:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "6ce283f7-115a-4a0f-9184-71e141149183:a1fed0ee-76a2-476e-8614-9fe8e71128b3", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "f5d7a9c8-839c-408c-b798-68d019483bc7:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "f5d7a9c8-839c-408c-b798-68d019483bc7:ee506497-3313-49d4-9cc9-353e55305547", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2168b471-9a51-4ead-a51e-15e52ba85d86:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2168b471-9a51-4ead-a51e-15e52ba85d86:c5902ca2-58ae-4b1c-b420-5208b7cb16c4", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "075d7dff-442b-4091-bfe2-3844e7e7e3f4:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "075d7dff-442b-4091-bfe2-3844e7e7e3f4:64b1a767-a32b-4a59-9fae-de5f08d38208", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-54585793-d86f-4dce-8fb1-80b6ef529e4f", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-87d56d88-cfac-492c-ba95-a70cb5815c20", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-223cc135-2457-4248-aada-6d1d10cfa126", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:cdd8151e-3bd4-4b23-8844-e836e0f10c91", "type": "index-pattern" }, { "name": "controlGroup_c9c507d9-a157-40b4-aec4-0a2e204c559c:optionsListDataView", "type": "index-pattern", "id": "kibana-event-log-data-view" }, { "name": "controlGroup_8b3b697c-2abf-4801-8a08-a1a29d483571:optionsListDataView", "type": "index-pattern", "id": "kibana-event-log-data-view" } ] }, "meta": { "createdAt": "2025-09-15T10:22:20.373Z", "updatedAt": "2025-09-15T10:22:20.373Z", "managed": true, "version": "WzYsMV0=" } }, { "id": "a51412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:22:50.768Z", "updatedAt": "2025-09-15T10:22:50.768Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE0LDFd" } }, { "id": "a53412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:30:32.617Z", "updatedAt": "2025-09-15T10:30:32.617Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE2LDFd" } }, { "id": "a52412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:26:47.286Z", "updatedAt": "2025-09-15T10:26:47.286Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE1LDFd" } }, { "id": "a54412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:40:16.427Z", "updatedAt": "2025-09-15T10:40:16.427Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE3LDFd" } }, { "id": "a55412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:41:46.145Z", "updatedAt": "2025-09-15T10:41:46.145Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE4LDFd" } }, { "id": "a56412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:44:24.153Z", "updatedAt": "2025-09-15T10:44:24.153Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE5LDFd" } }, { "id": "a57412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:46:20.279Z", "updatedAt": "2025-09-15T10:46:20.279Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIwLDFd" } }, { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five+++", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:08:33.625Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIyLDFd" } } ], "total": 9 } ``` --------- Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: kibanamachine <[email protected]>
…32458) ## Summary Implement #196609 #227886 affects too many files, this PR limits the scope to only dashboard api. ## API functional test: ``` node scripts/functional_tests_server.js --config ./src/platform/test/api_integration/config.js node scripts/functional_test_runner --config=src/platform/test/api_integration/config.js ``` ## Dashboard apis <img width="3444" height="3050" alt="content management drawio" src="https://github.com/user-attachments/assets/4680c3d1-a00c-439d-8897-c953f6f7dd23" /> ### Create ``` POST kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 { "version": 2, "controlGroupInput": { "autoApplySelections": true, "chainingSystem": "HIERARCHICAL", "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "labelPosition": "oneLine", "controls": [] }, "kibanaSavedObjectMeta": { "searchSource": { "filter": [], "query": { "query": "", "language": "kuery" } } }, "description": "xxx", "timeRestore": false, "options": { "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false, "hidePanelTitles": false }, "panels": [], "title": "five" } ``` Response: ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:00:11.462Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIxLDFd" } } ``` ### Get ``` GET kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 ``` Response ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:00:11.462Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIxLDFd", "outcome": "exactMatch" } } ``` ### Update ``` PUT kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 { "version": 2, "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "filter": [], "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five+++", "references": [], "spaces": [ "default" ] } ``` Response ``` { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "controlGroupInput": { "labelPosition": "oneLine", "chainingSystem": "HIERARCHICAL", "autoApplySelections": true, "ignoreParentSettings": { "ignoreFilters": false, "ignoreQuery": false, "ignoreTimerange": false, "ignoreValidations": false }, "controls": [] }, "description": "xxx", "kibanaSavedObjectMeta": { "searchSource": { "query": { "query": "", "language": "kuery" } } }, "options": { "hidePanelTitles": false, "useMargins": true, "syncColors": false, "syncCursor": true, "syncTooltips": false }, "panels": [], "timeRestore": false, "title": "five+++", "version": 2, "namespaces": [ "default" ], "references": [] }, "meta": { "updatedAt": "2025-09-15T11:08:33.625Z", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "version": "WzIyLDFd" } } ``` ### Delete ``` DELETE kbn:/api/dashboards/dashboard/a58412c4d-984f-68ef-8dd4-ef4d5f9222xf?apiVersion=1 ``` Response ``` OK ``` ### List ``` GET kbn:/api/dashboards/dashboard?apiVersion=1 ``` Response: ``` { "items": [ { "id": "security-detection-rule-monitoring-default", "type": "dashboard", "data": { "title": "[Elastic Security] Detection rule monitoring", "description": "This dashboard helps you monitor the health and performance of detection rules.", "timeRestore": false, "namespaces": [ "default" ], "references": [ { "type": "tag", "id": "fleet-managed-default", "name": "tag-ref-fleet-managed" }, { "type": "tag", "id": "security-solution-default", "name": "tag-ref-security-solution" }, { "id": "kibana-event-log-data-view", "name": "52ec5ce0-3ea9-42ee-91f2-0f664d6cb74d:indexpattern-datasource-layer-66195a85-b71e-45f5-a5ea-4388416cf5f7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "52ec5ce0-3ea9-42ee-91f2-0f664d6cb74d:874e1b4c-a64b-426a-b43e-d4ee226610a9", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "91a23437-071d-4739-b57e-2881caa980eb:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "91a23437-071d-4739-b57e-2881caa980eb:37539143-7ea2-4353-ae4e-78ec772d1508", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9770096c-3ba7-42e4-9783-5042ff08896d:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9770096c-3ba7-42e4-9783-5042ff08896d:32816692-7d96-4a12-abe3-3016e8a3844c", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "12011f8d-0d0d-40d6-8ef5-0d50bfe570f8:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "12011f8d-0d0d-40d6-8ef5-0d50bfe570f8:9acb5e9e-8c72-4ba6-a4f5-7f2901353c16", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3b0743e-9a2c-4173-babc-dc93204cc0f2:indexpattern-datasource-layer-17c4f52b-ef17-43d7-8282-91e48cbe11e7", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3b0743e-9a2c-4173-babc-dc93204cc0f2:9adf5837-270f-43bf-92d8-af2d74022292", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "78c659aa-a001-4c30-9452-e9c7d0c0ec5d:indexpattern-datasource-layer-4eaf036b-c9f5-4206-bcfe-8033bec44a21", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "78c659aa-a001-4c30-9452-e9c7d0c0ec5d:abcc85f3-00cd-48bd-a313-de50207ab1b6", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3dd29a9-c051-46ab-b1fa-facf899f7af9:indexpattern-datasource-layer-4eaf036b-c9f5-4206-bcfe-8033bec44a21", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "b3dd29a9-c051-46ab-b1fa-facf899f7af9:0ccd359c-35a9-42ee-9b53-e0061755ffef", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "ad5995be-bf0f-48ba-8dc8-7313ca3bfbae:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "ad5995be-bf0f-48ba-8dc8-7313ca3bfbae:2720edea-b96b-47d7-bf57-ff3a4c91ab9d", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2eac0a4e-9ec7-433e-89bc-e8edc1dadae7:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2eac0a4e-9ec7-433e-89bc-e8edc1dadae7:0b7e01b1-974a-4de9-867d-46fc000c63e3", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "d2e87680-4d92-4067-9f27-7749854dedce:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "d2e87680-4d92-4067-9f27-7749854dedce:4101bdcb-5ba8-406f-8893-07356a98d49b", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2372c630-207e-4859-83a9-de5a7bc638dc:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2372c630-207e-4859-83a9-de5a7bc638dc:adafccc0-9c17-4249-89e1-e61a8d00079b", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "e2504c27-3027-4c13-85c0-a66416c53bd4:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "e2504c27-3027-4c13-85c0-a66416c53bd4:edb4ad7f-1ef2-477f-980c-c6fe47d6470d", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "fe382f90-aa03-47e0-a8a0-d6a8de877467:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "fe382f90-aa03-47e0-a8a0-d6a8de877467:505272a2-f4fb-4778-9fdf-11415f36cc51", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "0b6f467f-f784-457e-9351-839874bef66e:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "0b6f467f-f784-457e-9351-839874bef66e:e0a238a9-104e-46c0-890a-c7b3e1c08018", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2ad1eb6c-c19b-41b1-897e-2d1d192cedae:indexpattern-datasource-layer-59ae5f24-20ed-4c11-bf5c-229d2dbb3cc8", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2ad1eb6c-c19b-41b1-897e-2d1d192cedae:5f5acf46-a12a-43cf-8d4a-b1ef1a971771", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "6ce283f7-115a-4a0f-9184-71e141149183:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "6ce283f7-115a-4a0f-9184-71e141149183:a1fed0ee-76a2-476e-8614-9fe8e71128b3", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "f5d7a9c8-839c-408c-b798-68d019483bc7:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "f5d7a9c8-839c-408c-b798-68d019483bc7:ee506497-3313-49d4-9cc9-353e55305547", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2168b471-9a51-4ead-a51e-15e52ba85d86:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "2168b471-9a51-4ead-a51e-15e52ba85d86:c5902ca2-58ae-4b1c-b420-5208b7cb16c4", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "075d7dff-442b-4091-bfe2-3844e7e7e3f4:indexpattern-datasource-layer-dd23be91-5d0e-41d8-8907-ae3c9a577e2e", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "075d7dff-442b-4091-bfe2-3844e7e7e3f4:64b1a767-a32b-4a59-9fae-de5f08d38208", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-54585793-d86f-4dce-8fb1-80b6ef529e4f", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-87d56d88-cfac-492c-ba95-a70cb5815c20", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:indexpattern-datasource-layer-223cc135-2457-4248-aada-6d1d10cfa126", "type": "index-pattern" }, { "id": "kibana-event-log-data-view", "name": "9cfc685f-bbe0-4275-9da2-370d4c7f1493:cdd8151e-3bd4-4b23-8844-e836e0f10c91", "type": "index-pattern" }, { "name": "controlGroup_c9c507d9-a157-40b4-aec4-0a2e204c559c:optionsListDataView", "type": "index-pattern", "id": "kibana-event-log-data-view" }, { "name": "controlGroup_8b3b697c-2abf-4801-8a08-a1a29d483571:optionsListDataView", "type": "index-pattern", "id": "kibana-event-log-data-view" } ] }, "meta": { "createdAt": "2025-09-15T10:22:20.373Z", "updatedAt": "2025-09-15T10:22:20.373Z", "managed": true, "version": "WzYsMV0=" } }, { "id": "a51412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:22:50.768Z", "updatedAt": "2025-09-15T10:22:50.768Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE0LDFd" } }, { "id": "a53412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:30:32.617Z", "updatedAt": "2025-09-15T10:30:32.617Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE2LDFd" } }, { "id": "a52412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:26:47.286Z", "updatedAt": "2025-09-15T10:26:47.286Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE1LDFd" } }, { "id": "a54412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:40:16.427Z", "updatedAt": "2025-09-15T10:40:16.427Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE3LDFd" } }, { "id": "a55412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:41:46.145Z", "updatedAt": "2025-09-15T10:41:46.145Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE4LDFd" } }, { "id": "a56412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:44:24.153Z", "updatedAt": "2025-09-15T10:44:24.153Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzE5LDFd" } }, { "id": "a57412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T10:46:20.279Z", "updatedAt": "2025-09-15T10:46:20.279Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIwLDFd" } }, { "id": "a58412c4d-984f-68ef-8dd4-ef4d5f9222xf", "type": "dashboard", "data": { "title": "five+++", "description": "xxx", "timeRestore": false, "namespaces": [ "default" ], "references": [] }, "meta": { "createdAt": "2025-09-15T11:00:11.462Z", "updatedAt": "2025-09-15T11:08:33.625Z", "createdBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "updatedBy": "u_mGBROF_q5bmFCATbLXAcCwKa0k8JvONAwSruelyKA5E_0", "managed": false, "version": "WzIyLDFd" } } ], "total": 9 } ``` --------- Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: Nick Peihl <[email protected]> Co-authored-by: kibanamachine <[email protected]>
Summary
#196609
Dashboard apis
Create
Response:
Get
Response
Update
Response
Delete
Response
List
Response:
Content management api
Search
Response
Get:
response
Update:
Response
Delete:
Response