- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.3
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
Bulk update object API
editBulk update object API
edit[preview] 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. Update the attributes for multiple existing Kibana saved objects.
Request
editPUT <kibana host>:<port>/api/saved_objects/_bulk_update
PUT <kibana host>:<port>/s/<space_id>/api/saved_objects/_bulk_update
Path parameters
edit-
space_id
-
(Optional, string) An identifier for the space. If
space_id
is not provided in the URL, the default space is used.
Request body
edit-
type
-
(Required, string) Valid options include
visualization
,dashboard
,search
,index-pattern
,config
. -
id
- (Required, string) The object ID to update.
-
attributes
-
(Required, object) The data to persist.
When you update, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API and break Kibana. Make sure any data that you send to the API is properly formed.
-
references
-
(Optional, array) Objects with
name
,id
, andtype
properties that describe the other saved objects this object references. To refer to the other saved object, usename
in the attributes, but never theid
, which automatically updates during migrations or import/export. -
version
- (Optional, number) Ensures the version matches that of the persisted object.
-
namespace
- (Optional, string) Identifier for the space in which to update this object. If this is defined, it will supersede the space ID that is in the URL.
Response code
edit-
200
- Indicates a successful call. Note, this HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body. Refer to the example below for details.
Example
editUpdate three saved objects, where one of them does not exist:
$ curl -X PUT api/saved_objects/_bulk_update [ { type: 'visualization', id: 'not an id', attributes: { title: 'An existing visualization', }, }, { type: 'dashboard', id: 'be3733a0-9efe-11e7-acb3-3dab96693fab', attributes: { title: 'An existing dashboard', }, { type: 'index-pattern', id: 'logstash-*', attributes: { title: 'my-logstash-pattern' } } ]
The API returns the following:
[ { "type": "visualization", "id": "not an id", "error": { "statusCode": 404, "error": "Not Found", "message": "Saved object [visualization/not an id] not found", }, }, { "type": "dashboard", "id": "be3733a0-9efe-11e7-acb3-3dab96693fab", "version": 2, "attributes": { "title": "An existing dashboard", }, }, { "type": "index-pattern", "id": "logstash-*", "attributes": { "title": "my-logstash-pattern", } } ]