{ "opencollection": "1.0.0", "info": { "name": "Kibana APIs Actions Spaces API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Spaces", "type": "folder" }, "items": [ { "info": { "name": "Resolve conflicts copying saved objects", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/spaces/_resolve_copy_saved_objects_errors", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Overwrite saved objects that are returned as errors from the copy saved objects to space API.

[Required authorization] Route required privileges: copySavedObjectsToSpaces." }, { "info": { "name": "Copy saved objects between spaces", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/spaces/_copy_saved_objects", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "It also allows you to automatically copy related objects, so when you copy a dashboard, this can automatically copy over the associated visualizations, data views, and saved Discover sessions, as required. You can request to overwrite any objects that already exist in the target space if they share an identifier or you can use the resolve copy saved objects conflicts API to do this on a per-object basis.

[Required authorization] Route required privileges: copySavedObjectsToSpaces." }, { "info": { "name": "Disable legacy URL aliases", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/spaces/_disable_legacy_url_aliases", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable one or more legacy URL aliases so that they no longer resolve to their target saved objects." }, { "info": { "name": "Get shareable references", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/spaces/_get_shareable_references", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Collect references and space contexts for saved objects." }, { "info": { "name": "Update saved objects in spaces", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/spaces/_update_objects_spaces", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update one or more saved objects to add or remove them from some spaces." }, { "info": { "name": "Get all spaces", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/spaces/space", "params": [ { "name": "purpose", "value": "", "type": "query", "description": "Specifies which authorization checks are applied to the API call. The default value is `any`." }, { "name": "include_authorized_purposes", "value": "", "type": "query", "description": "When enabled, the API returns any spaces the user is authorized to access in any capacity, each including the purposes for which the user is authorized. This is useful for identifying spaces the user can read but is not authorized for a given purpose. Without the security plugin, this parameter has no effect, because no authorization checks are performed. This parameter cannot be used together with the `purpose` parameter." } ] }, "docs": "Retrieve all available Kibana spaces. The list includes only the spaces that the user is authorized to access." }, { "info": { "name": "Create a space", "type": "http" }, "http": { "method": "POST", "url": "https://{kibana_url}/api/spaces/space", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Kibana space." }, { "info": { "name": "Get a space", "type": "http" }, "http": { "method": "GET", "url": "https://{kibana_url}/api/spaces/space/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The space identifier." } ] }, "docs": "Retrieve a single Kibana space by its identifier." }, { "info": { "name": "Update a space", "type": "http" }, "http": { "method": "PUT", "url": "https://{kibana_url}/api/spaces/space/:id", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The space identifier. You are unable to change the ID with the update operation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Kibana space." }, { "info": { "name": "Delete a space", "type": "http" }, "http": { "method": "DELETE", "url": "https://{kibana_url}/api/spaces/space/:id", "headers": [ { "name": "kbn-xsrf", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The space identifier." } ] }, "docs": "When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone." } ] } ], "bundled": true }