> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # kibana-management > Kibana Management - data views, saved objects, spaces, and roles **Server path:** `/kibana-management` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | [`kibana_management_create_data_view_default`](#kibana_management_create_data_view_default) | Create a data view | | [`kibana_management_create_runtime_field_default`](#kibana_management_create_runtime_field_default) | Create a runtime field | | [`kibana_management_create_update_runtime_field_default`](#kibana_management_create_update_runtime_field_default) | Create or update a runtime field | | [`kibana_management_delete_data_view_default`](#kibana_management_delete_data_view_default) | Delete a data view | | [`kibana_management_delete_runtime_field_default`](#kibana_management_delete_runtime_field_default) | Delete a runtime field from a data view | | [`kibana_management_delete_security_role_name`](#kibana_management_delete_security_role_name) | Delete a role | | [`kibana_management_delete_spaces_space_id`](#kibana_management_delete_spaces_space_id) | Delete a space | | [`kibana_management_get_all_data_views_default`](#kibana_management_get_all_data_views_default) | Get all data views | | [`kibana_management_get_data_view_default`](#kibana_management_get_data_view_default) | Get a data view | | [`kibana_management_get_default_data_view_default`](#kibana_management_get_default_data_view_default) | Get the default data view | | [`kibana_management_get_runtime_field_default`](#kibana_management_get_runtime_field_default) | Get a runtime field | | [`kibana_management_get_security_role`](#kibana_management_get_security_role) | Get all roles | | [`kibana_management_get_security_role_name`](#kibana_management_get_security_role_name) | Get a role | | [`kibana_management_get_spaces_space`](#kibana_management_get_spaces_space) | Get all spaces | | [`kibana_management_get_spaces_space_id`](#kibana_management_get_spaces_space_id) | Get a space | | [`kibana_management_post_saved_objects_export`](#kibana_management_post_saved_objects_export) | Export saved objects | | [`kibana_management_post_saved_objects_import`](#kibana_management_post_saved_objects_import) | Import saved objects | | [`kibana_management_post_security_roles`](#kibana_management_post_security_roles) | Create or update roles | | [`kibana_management_post_spaces_copy_saved_objects`](#kibana_management_post_spaces_copy_saved_objects) | Copy saved objects between spaces | | [`kibana_management_post_spaces_disable_legacy_url_aliases`](#kibana_management_post_spaces_disable_legacy_url_aliases) | Disable legacy URL aliases | | [`kibana_management_post_spaces_get_shareable_references`](#kibana_management_post_spaces_get_shareable_references) | Get shareable references | | [`kibana_management_post_spaces_space`](#kibana_management_post_spaces_space) | Create a space | | [`kibana_management_post_spaces_update_objects_spaces`](#kibana_management_post_spaces_update_objects_spaces) | Update saved objects in spaces | | [`kibana_management_preview_swap_data_views_default`](#kibana_management_preview_swap_data_views_default) | Preview a saved object reference swap | | [`kibana_management_put_security_role_name`](#kibana_management_put_security_role_name) | Create or update a role | | [`kibana_management_put_spaces_space_id`](#kibana_management_put_spaces_space_id) | Update a space | | [`kibana_management_resolve_import_errors`](#kibana_management_resolve_import_errors) | Resolve import errors | | [`kibana_management_rotate_encryption_key`](#kibana_management_rotate_encryption_key) | Rotate a key for encrypted saved objects | | [`kibana_management_set_default_data_view_default`](#kibana_management_set_default_data_view_default) | Set the default data view | | [`kibana_management_swap_data_views_default`](#kibana_management_swap_data_views_default) | Swap saved object references | | [`kibana_management_update_data_view_default`](#kibana_management_update_data_view_default) | Update a data view | | [`kibana_management_update_fields_metadata_default`](#kibana_management_update_fields_metadata_default) | Update data view fields metadata | | [`kibana_management_update_runtime_field_default`](#kibana_management_update_runtime_field_default) | Update a runtime field | *** ## kibana\_management\_create\_data\_view\_default Create a data view **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `data_view` | object | Yes | — | The data view object. | | `override` | boolean | No | — | Override an existing data view if a data view with the provided title already exists. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "data_view": { "type": "object", "description": "The data view object.", "properties": { "allowNoIndex": { "type": "boolean", "description": "Allows the data view saved object to exist before the data is available. Defaults to `false`." }, "fieldAttrs": { "type": "object", "description": "Field Attrs" }, "fieldFormats": { "type": "object", "description": "A map of field formats by field name." }, "fields": { "type": "object", "description": "The fields value" }, "id": { "type": "string", "description": "The id value" }, "name": { "type": "string", "description": "The data view name." }, "namespaces": { "type": "array", "items": { "type": "string" }, "description": "An array of space identifiers for sharing the data view between multiple spaces." }, "runtimeFieldMap": { "type": "object", "description": "Runtime Field Map" }, "sourceFilters": { "type": "array", "items": { "type": "object" }, "description": "The array of field names you want to filter out in Discover." }, "timeFieldName": { "type": "string", "description": "The timestamp field name, which you use for time-based data views." }, "title": { "type": "string", "description": "Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (`*`)." }, "type": { "type": "string", "description": "When set to `rollup`, identifies the rollup data views." }, "typeMeta": { "type": "object", "description": "When you use rollup indices, contains the field list for the rollup data view API endpoints." }, "version": { "type": "string", "description": "The version value" } }, "required": [ "title" ] }, "override": { "type": "boolean", "description": "Override an existing data view if a data view with the provided title already exists." } }, "required": [ "PCID", "kbn-xsrf", "data_view" ] } ``` *** ## kibana\_management\_create\_runtime\_field\_default Create a runtime field **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `viewId` | string | Yes | — | An identifier for the data view. | | `name` | string | Yes | — | The name for a runtime field. | | `runtimeField` | object | Yes | — | The runtime field definition object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "viewId": { "type": "string", "description": "An identifier for the data view." }, "name": { "type": "string", "description": "The name for a runtime field." }, "runtimeField": { "type": "object", "description": "The runtime field definition object." } }, "required": [ "PCID", "kbn-xsrf", "viewId", "name", "runtimeField" ] } ``` *** ## kibana\_management\_create\_update\_runtime\_field\_default Create or update a runtime field **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | -------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `viewId` | string | Yes | — | The ID of the data view fields you want to update. | | `name` | string | Yes | — | The name for a runtime field. | | `runtimeField` | object | Yes | — | The runtime field definition object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "viewId": { "type": "string", "description": "The ID of the data view fields you want to update." }, "name": { "type": "string", "description": "The name for a runtime field." }, "runtimeField": { "type": "object", "description": "The runtime field definition object." } }, "required": [ "PCID", "kbn-xsrf", "viewId", "name", "runtimeField" ] } ``` *** ## kibana\_management\_delete\_data\_view\_default Delete a data view **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `viewId` | string | Yes | — | An identifier for the data view. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "viewId": { "type": "string", "description": "An identifier for the data view." } }, "required": [ "PCID", "kbn-xsrf", "viewId" ] } ``` *** ## kibana\_management\_delete\_runtime\_field\_default Delete a runtime field from a data view **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | -------------------------------- | | `fieldName` | string | Yes | — | The name of the runtime field. | | `viewId` | string | Yes | — | An identifier for the data view. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fieldName": { "type": "string", "description": "The name of the runtime field." }, "viewId": { "type": "string", "description": "An identifier for the data view." } }, "required": [ "PCID", "fieldName", "viewId" ] } ``` *** ## kibana\_management\_delete\_security\_role\_name Delete a role **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "kbn-xsrf", "name" ] } ``` *** ## kibana\_management\_delete\_spaces\_space\_id Delete a space **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `id` | string | Yes | — | The space identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "id": { "type": "string", "description": "The space identifier." } }, "required": [ "PCID", "kbn-xsrf", "id" ] } ``` *** ## kibana\_management\_get\_all\_data\_views\_default Get all data views ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## kibana\_management\_get\_data\_view\_default Get a data view **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------------------- | | `viewId` | string | Yes | — | An identifier for the data view. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "viewId": { "type": "string", "description": "An identifier for the data view." } }, "required": [ "PCID", "viewId" ] } ``` *** ## kibana\_management\_get\_default\_data\_view\_default Get the default data view ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## kibana\_management\_get\_runtime\_field\_default Get a runtime field **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | -------------------------------- | | `fieldName` | string | Yes | — | The name of the runtime field. | | `viewId` | string | Yes | — | An identifier for the data view. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fieldName": { "type": "string", "description": "The name of the runtime field." }, "viewId": { "type": "string", "description": "An identifier for the data view." } }, "required": [ "PCID", "fieldName", "viewId" ] } ``` *** ## kibana\_management\_get\_security\_role Get all roles **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `replaceDeprecatedPrivileges` | boolean | No | — | If `true` and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "replaceDeprecatedPrivileges": { "type": "boolean", "description": "If `true` and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges." } }, "required": [ "PCID" ] } ``` *** ## kibana\_management\_get\_security\_role\_name Get a role **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | The role name. | | `replaceDeprecatedPrivileges` | boolean | No | — | If `true` and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The role name." }, "replaceDeprecatedPrivileges": { "type": "boolean", "description": "If `true` and the response contains any privileges that are associated with deprecated features, they are omitted in favor of details about the appropriate replacement feature privileges." } }, "required": [ "PCID", "name" ] } ``` *** ## kibana\_management\_get\_spaces\_space Get all spaces **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `purpose` | string | No | — | Specifies which authorization checks are applied to the API call. The default value is `any`. | | `include_authorized_purposes` | boolean | No | — | When enabled, the API returns any spaces that the user is authorized to access in any capacity and each space will contain the purposes for which the user is authorized. This can be useful to determine which spaces a user can read but not take a specific action in. If the security plugin is not enabled, this parameter has no effect, since no authorization checks take place. This parameter cannot be used in with the `purpose` parameter. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "purpose": { "type": "string", "description": "Specifies which authorization checks are applied to the API call. The default value is `any`.", "enum": [ "any", "copySavedObjectsIntoSpace", "shareSavedObjectsIntoSpace" ] }, "include_authorized_purposes": { "type": "boolean", "description": "When enabled, the API returns any spaces that the user is authorized to access in any capacity and each space will contain the purposes for which the user is authorized. This can be useful to determine which spaces a user can read but not take a specific action in. If the security plugin is not enabled, this parameter has no effect, since no authorization checks take place. This parameter cannot be used in with the `purpose` parameter." } }, "required": [ "PCID" ] } ``` *** ## kibana\_management\_get\_spaces\_space\_id Get a space **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------- | | `id` | string | Yes | — | The space identifier. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The space identifier." } }, "required": [ "PCID", "id" ] } ``` *** ## kibana\_management\_post\_saved\_objects\_export Export saved objects **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `excludeExportDetails` | boolean | No | — | Do not add export details entry at the end of the stream. | | `hasReference` | object\[] | No | — | Has Reference | | `includeReferencesDeep` | boolean | No | — | Includes all of the referenced objects in the exported objects. | | `objects` | object\[] | No | — | A list of objects to export. NOTE: this optional parameter cannot be combined with the `types` option | | `search` | string | No | — | Search for documents to export using the Elasticsearch Simple Query String syntax. | | `type` | string\[] | No | — | The saved object types to include in the export. Use `*` to export all the types. Valid options depend on enabled plugins, but may include `visualization`, `dashboard`, `search`, `index-pattern`, `tag`, `config`, `config-global`, `lens`, `map`, `event-annotation-group`, `query`, `url`, `action`, `alert`, `alerting_rule_template`, `apm-indices`, `cases-user-actions`, `cases`, `cases-comments`, `infrastructure-monitoring-log-view`, `ml-trained-model`, `osquery-saved-query`, `osquery-pack`, `osquery-pack-asset`. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "excludeExportDetails": { "type": "boolean", "description": "Do not add export details entry at the end of the stream." }, "hasReference": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "type", "id" ] }, "description": "Has Reference" }, "includeReferencesDeep": { "type": "boolean", "description": "Includes all of the referenced objects in the exported objects." }, "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "type", "id" ] }, "description": "A list of objects to export. NOTE: this optional parameter cannot be combined with the `types` option" }, "search": { "type": "string", "description": "Search for documents to export using the Elasticsearch Simple Query String syntax." }, "type": { "type": "array", "items": { "type": "string" }, "description": "The saved object types to include in the export. Use `*` to export all the types. Valid options depend on enabled plugins, but may include `visualization`, `dashboard`, `search`, `index-pattern`, `tag`, `config`, `config-global`, `lens`, `map`, `event-annotation-group`, `query`, `url`, `action`, `alert`, `alerting_rule_template`, `apm-indices`, `cases-user-actions`, `cases`, `cases-comments`, `infrastructure-monitoring-log-view`, `ml-trained-model`, `osquery-saved-query`, `osquery-pack`, `osquery-pack-asset`." } }, "required": [ "PCID", "kbn-xsrf" ] } ``` *** ## kibana\_management\_post\_saved\_objects\_import Import saved objects **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `overwrite` | boolean | No | — | Overwrites saved objects when they already exist. When used, potential conflict errors are automatically resolved by overwriting the destination object. NOTE: This option cannot be used with the `createNewCopies` option. | | `createNewCopies` | boolean | No | — | Creates copies of saved objects, regenerates each object ID, and resets the origin. When used, potential conflict errors are avoided. NOTE: This option cannot be used with the `overwrite` and `compatibilityMode` options. | | `compatibilityMode` | boolean | No | — | Applies various adjustments to the saved objects that are being imported to maintain compatibility between different Kibana versions. Use this option only if you encounter issues with imported saved objects. NOTE: This option cannot be used with the `createNewCopies` option. | | `file` | object | Yes | — | A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "overwrite": { "type": "boolean", "description": "Overwrites saved objects when they already exist. When used, potential conflict errors are automatically resolved by overwriting the destination object. NOTE: This option cannot be used with the `createNewCopies` option." }, "createNewCopies": { "type": "boolean", "description": "Creates copies of saved objects, regenerates each object ID, and resets the origin. When used, potential conflict errors are avoided. NOTE: This option cannot be used with the `overwrite` and `compatibilityMode` options." }, "compatibilityMode": { "type": "boolean", "description": "Applies various adjustments to the saved objects that are being imported to maintain compatibility between different Kibana versions. Use this option only if you encounter issues with imported saved objects. NOTE: This option cannot be used with the `createNewCopies` option." }, "file": { "type": "object", "description": "A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported." } }, "required": [ "PCID", "kbn-xsrf", "file" ] } ``` *** ## kibana\_management\_post\_security\_roles Create or update roles **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `roles` | object | Yes | — | The roles value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "roles": { "type": "object", "description": "The roles value" } }, "required": [ "PCID", "kbn-xsrf", "roles" ] } ``` *** ## kibana\_management\_post\_spaces\_copy\_saved\_objects Copy saved objects between spaces **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `compatibilityMode` | boolean | No | — | Apply various adjustments to the saved objects that are being copied to maintain compatibility between different Kibana versions. Use this option only if you encounter issues with copied saved objects. This option cannot be used with the `createNewCopies` option. | | `createNewCopies` | boolean | No | — | Create new copies of saved objects, regenerate each object identifier, and reset the origin. When used, potential conflict errors are avoided. This option cannot be used with the `overwrite` and `compatibilityMode` options. | | `includeReferences` | boolean | No | — | When set to true, all saved objects related to the specified saved objects will also be copied into the target spaces. | | `objects` | object\[] | Yes | — | The objects value | | `overwrite` | boolean | No | — | When set to true, all conflicts are automatically overridden. When a saved object with a matching type and identifier exists in the target space, that version is replaced with the version from the source space. This option cannot be used with the `createNewCopies` option. | | `spaces` | string\[] | Yes | — | The spaces value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "compatibilityMode": { "type": "boolean", "description": "Apply various adjustments to the saved objects that are being copied to maintain compatibility between different Kibana versions. Use this option only if you encounter issues with copied saved objects. This option cannot be used with the `createNewCopies` option." }, "createNewCopies": { "type": "boolean", "description": "Create new copies of saved objects, regenerate each object identifier, and reset the origin. When used, potential conflict errors are avoided. This option cannot be used with the `overwrite` and `compatibilityMode` options." }, "includeReferences": { "type": "boolean", "description": "When set to true, all saved objects related to the specified saved objects will also be copied into the target spaces." }, "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the saved object to copy." }, "type": { "type": "string", "description": "The type of the saved object to copy." } }, "required": [ "type", "id" ] }, "description": "The objects value" }, "overwrite": { "type": "boolean", "description": "When set to true, all conflicts are automatically overridden. When a saved object with a matching type and identifier exists in the target space, that version is replaced with the version from the source space. This option cannot be used with the `createNewCopies` option." }, "spaces": { "type": "array", "items": { "type": "string" }, "description": "The spaces value" } }, "required": [ "PCID", "kbn-xsrf", "objects", "spaces" ] } ``` *** ## kibana\_management\_post\_spaces\_disable\_legacy\_url\_aliases Disable legacy URL aliases **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `aliases` | object\[] | Yes | — | The aliases value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "aliases": { "type": "array", "items": { "type": "object", "properties": { "sourceId": { "type": "string", "description": "The alias source object identifier. This is the legacy object identifier." }, "targetSpace": { "type": "string", "description": "The space where the alias target object exists." }, "targetType": { "type": "string", "description": "The type of alias target object." } }, "required": [ "targetSpace", "targetType", "sourceId" ] }, "description": "The aliases value" } }, "required": [ "PCID", "kbn-xsrf", "aliases" ] } ``` *** ## kibana\_management\_post\_spaces\_get\_shareable\_references Get shareable references **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `objects` | object\[] | Yes | — | The objects value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id value" }, "type": { "type": "string", "description": "The type value" } }, "required": [ "type", "id" ] }, "description": "The objects value" } }, "required": [ "PCID", "kbn-xsrf", "objects" ] } ``` *** ## kibana\_management\_post\_spaces\_space Create a space **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `_reserved` | boolean | No | — | The reserved value | | `color` | string | No | — | The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name. | | `description` | string | No | — | A description for the space. | | `disabledFeatures` | string\[] | No | — | Disabled Features | | `id` | string | Yes | — | The space ID that is part of the Kibana URL when inside the space. Space IDs are limited to lowercase alphanumeric, underscore, and hyphen characters (a-z, 0-9, \_, and -). You are cannot change the ID with the update operation. | | `imageUrl` | string | No | — | The data-URL encoded image to display in the space avatar. If specified, initials will not be displayed and the color will be visible as the background color for transparent images. For best results, your image should be 64x64. Images will not be optimized by this API call, so care should be taken when using custom images. | | `initials` | string | No | — | One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name. | | `name` | string | Yes | — | The display name for the space. | | `projectRouting` | string | No | — | Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments. | | `solution` | string | No | — | The solution value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "_reserved": { "type": "boolean", "description": "The reserved value" }, "color": { "type": "string", "description": "The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name." }, "description": { "type": "string", "description": "A description for the space." }, "disabledFeatures": { "type": "array", "items": { "type": "string" }, "description": "Disabled Features" }, "id": { "type": "string", "description": "The space ID that is part of the Kibana URL when inside the space. Space IDs are limited to lowercase alphanumeric, underscore, and hyphen characters (a-z, 0-9, _, and -). You are cannot change the ID with the update operation." }, "imageUrl": { "type": "string", "description": "The data-URL encoded image to display in the space avatar. If specified, initials will not be displayed and the color will be visible as the background color for transparent images. For best results, your image should be 64x64. Images will not be optimized by this API call, so care should be taken when using custom images." }, "initials": { "type": "string", "description": "One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name." }, "name": { "type": "string", "description": "The display name for the space." }, "projectRouting": { "type": "string", "description": "Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments." }, "solution": { "type": "string", "description": "The solution value", "enum": [ "security", "oblt", "es", "classic" ] } }, "required": [ "PCID", "kbn-xsrf", "id", "name" ] } ``` *** ## kibana\_management\_post\_spaces\_update\_objects\_spaces Update saved objects in spaces **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | --------- | -------- | ------- | ------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `objects` | object\[] | Yes | — | The objects value | | `spacesToAdd` | string\[] | Yes | — | Spaces To Add | | `spacesToRemove` | string\[] | Yes | — | Spaces To Remove | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier of the saved object to update." }, "type": { "type": "string", "description": "The type of the saved object to update." } }, "required": [ "type", "id" ] }, "description": "The objects value" }, "spacesToAdd": { "type": "array", "items": { "type": "string" }, "description": "Spaces To Add" }, "spacesToRemove": { "type": "array", "items": { "type": "string" }, "description": "Spaces To Remove" } }, "required": [ "PCID", "kbn-xsrf", "objects", "spacesToAdd", "spacesToRemove" ] } ``` *** ## kibana\_management\_preview\_swap\_data\_views\_default Preview a saved object reference swap **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `delete` | boolean | No | — | Deletes referenced saved object if all references are removed. | | `forId` | string\[] | No | — | Limit the affected saved objects to one or more by identifier. | | `forType` | string | No | — | Limit the affected saved objects by type. | | `fromId` | string | Yes | — | The saved object reference to change. | | `fromType` | string | No | — | Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views. | | `toId` | string | Yes | — | New saved object reference value to replace the old value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "delete": { "type": "boolean", "description": "Deletes referenced saved object if all references are removed." }, "forId": { "type": "array", "items": { "type": "string" }, "description": "Limit the affected saved objects to one or more by identifier." }, "forType": { "type": "string", "description": "Limit the affected saved objects by type." }, "fromId": { "type": "string", "description": "The saved object reference to change." }, "fromType": { "type": "string", "description": "Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views." }, "toId": { "type": "string", "description": "New saved object reference value to replace the old value." } }, "required": [ "PCID", "kbn-xsrf", "fromId", "toId" ] } ``` *** ## kibana\_management\_put\_security\_role\_name Create or update a role **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | --------- | -------- | ------- | ---------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `name` | string | Yes | — | The role name. | | `createOnly` | boolean | No | — | When true, a role is not overwritten if it already exists. | | `description` | string | No | — | A description for the role. | | `elasticsearch` | object | Yes | — | The elasticsearch value | | `kibana` | object\[] | No | — | The kibana value | | `metadata` | object | No | — | The metadata value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "name": { "type": "string", "description": "The role name." }, "createOnly": { "type": "boolean", "description": "When true, a role is not overwritten if it already exists." }, "description": { "type": "string", "description": "A description for the role." }, "elasticsearch": { "type": "object", "description": "The elasticsearch value", "properties": { "cluster": { "type": "array", "items": { "type": "string" }, "description": "The cluster value" }, "indices": { "type": "array", "items": { "type": "object" }, "description": "The indices value" }, "remote_cluster": { "type": "array", "items": { "type": "object" }, "description": "Remote Cluster" }, "remote_indices": { "type": "array", "items": { "type": "object" }, "description": "Remote Indices" }, "run_as": { "type": "array", "items": { "type": "string" }, "description": "Run As" } } }, "kibana": { "type": "array", "items": { "type": "object", "properties": { "base": { "description": "The base value" }, "feature": { "type": "object", "description": "The feature value" }, "spaces": { "description": "The spaces value" } }, "required": [ "base" ] }, "description": "The kibana value" }, "metadata": { "type": "object", "description": "The metadata value" } }, "required": [ "PCID", "kbn-xsrf", "name", "elasticsearch" ] } ``` *** ## kibana\_management\_put\_spaces\_space\_id Update a space **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `kbn-xsrf` | string | Yes | — | A required header to protect against CSRF attacks | | `id` | string | Yes | — | The space identifier. You are unable to change the ID with the update operation. | | `_reserved` | boolean | No | — | The reserved value | | `color` | string | No | — | The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name. | | `description` | string | No | — | A description for the space. | | `disabledFeatures` | string\[] | No | — | Disabled Features | | `imageUrl` | string | No | — | The data-URL encoded image to display in the space avatar. If specified, initials will not be displayed and the color will be visible as the background color for transparent images. For best results, your image should be 64x64. Images will not be optimized by this API call, so care should be taken when using custom images. | | `initials` | string | No | — | One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name. | | `name` | string | Yes | — | The display name for the space. | | `projectRouting` | string | No | — | Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments. | | `solution` | string | No | — | The solution value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "A required header to protect against CSRF attacks" }, "id": { "type": "string", "description": "The space identifier. You are unable to change the ID with the update operation." }, "_reserved": { "type": "boolean", "description": "The reserved value" }, "color": { "type": "string", "description": "The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name." }, "description": { "type": "string", "description": "A description for the space." }, "disabledFeatures": { "type": "array", "items": { "type": "string" }, "description": "Disabled Features" }, "imageUrl": { "type": "string", "description": "The data-URL encoded image to display in the space avatar. If specified, initials will not be displayed and the color will be visible as the background color for transparent images. For best results, your image should be 64x64. Images will not be optimized by this API call, so care should be taken when using custom images." }, "initials": { "type": "string", "description": "One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name." }, "name": { "type": "string", "description": "The display name for the space." }, "projectRouting": { "type": "string", "description": "Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments." }, "solution": { "type": "string", "description": "The solution value", "enum": [ "security", "oblt", "es", "classic" ] } }, "required": [ "PCID", "kbn-xsrf", "id", "name" ] } ``` *** ## kibana\_management\_resolve\_import\_errors Resolve import errors **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `compatibilityMode` | boolean | No | — | Applies various adjustments to the saved objects that are being imported to maintain compatibility between different Kibana versions. When enabled during the initial import, also enable when resolving import errors. This option cannot be used with the `createNewCopies` option. | | `createNewCopies` | boolean | No | — | Creates copies of the saved objects, regenerates each object ID, and resets the origin. When enabled during the initial import, also enable when resolving import errors. | | `file` | string | No | — | The same file given to the import API. | | `retries` | object\[] | Yes | — | The retry operations, which can specify how to resolve different types of errors. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "compatibilityMode": { "type": "boolean", "description": "Applies various adjustments to the saved objects that are being imported to maintain compatibility between different Kibana versions. When enabled during the initial import, also enable when resolving import errors. This option cannot be used with the `createNewCopies` option." }, "createNewCopies": { "type": "boolean", "description": "Creates copies of the saved objects, regenerates each object ID, and resets the origin. When enabled during the initial import, also enable when resolving import errors." }, "file": { "type": "string", "description": "The same file given to the import API." }, "retries": { "type": "array", "items": { "type": "object", "properties": { "destinationId": { "type": "string", "description": "Specifies the destination ID that the imported object should have, if different from the current ID." }, "id": { "type": "string", "description": "The saved object ID." }, "ignoreMissingReferences": { "type": "boolean", "description": "When set to `true`, ignores missing reference errors. When set to `false`, does nothing." }, "overwrite": { "type": "boolean", "description": "When set to `true`, the source object overwrites the conflicting destination object. When set to `false`, does nothing." }, "replaceReferences": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "type": { "type": "string" } } }, "description": "A list of `type`, `from`, and `to` used to change the object references." }, "type": { "type": "string", "description": "The saved object type." } }, "required": [ "type", "id" ] }, "description": "The retry operations, which can specify how to resolve different types of errors." } }, "required": [ "PCID", "kbn-xsrf", "retries" ] } ``` *** ## kibana\_management\_rotate\_encryption\_key Rotate a key for encrypted saved objects **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `batch_size` | number | No | — | Specifies a maximum number of saved objects that Kibana can process in a single batch. Bulk key rotation is an iterative process since Kibana may not be able to fetch and process all required saved objects in one go and splits processing into consequent batches. By default, the batch size is 10000, which is also a maximum allowed value. | | `type` | string | No | — | Limits encryption key rotation only to the saved objects with the specified type. By default, Kibana tries to rotate the encryption key for all saved object types that may contain encrypted attributes. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "batch_size": { "type": "number", "description": "Specifies a maximum number of saved objects that Kibana can process in a single batch. Bulk key rotation is an iterative process since Kibana may not be able to fetch and process all required saved objects in one go and splits processing into consequent batches. By default, the batch size is 10000, which is also a maximum allowed value." }, "type": { "type": "string", "description": "Limits encryption key rotation only to the saved objects with the specified type. By default, Kibana tries to rotate the encryption key for all saved object types that may contain encrypted attributes." } }, "required": [ "PCID" ] } ``` *** ## kibana\_management\_set\_default\_data\_view\_default Set the default data view **Parameters:** | Parameter | Type | Required | Default | Description | | | -------------- | ------- | -------- | ------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | | `data_view_id` | string | null | Yes | — | The data view identifier. NOTE: The API does not validate whether it is a valid identifier. Use `null` to unset the default data view. | | `force` | boolean | No | — | Update an existing default data view identifier. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "data_view_id": { "type": [ "string", "null" ], "description": "The data view identifier. NOTE: The API does not validate whether it is a valid identifier. Use `null` to unset the default data view." }, "force": { "type": "boolean", "description": "Update an existing default data view identifier." } }, "required": [ "PCID", "kbn-xsrf", "data_view_id" ] } ``` *** ## kibana\_management\_swap\_data\_views\_default Swap saved object references **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `delete` | boolean | No | — | Deletes referenced saved object if all references are removed. | | `forId` | string\[] | No | — | Limit the affected saved objects to one or more by identifier. | | `forType` | string | No | — | Limit the affected saved objects by type. | | `fromId` | string | Yes | — | The saved object reference to change. | | `fromType` | string | No | — | Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views. | | `toId` | string | Yes | — | New saved object reference value to replace the old value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "delete": { "type": "boolean", "description": "Deletes referenced saved object if all references are removed." }, "forId": { "type": "array", "items": { "type": "string" }, "description": "Limit the affected saved objects to one or more by identifier." }, "forType": { "type": "string", "description": "Limit the affected saved objects by type." }, "fromId": { "type": "string", "description": "The saved object reference to change." }, "fromType": { "type": "string", "description": "Specify the type of the saved object reference to alter. The default value is `index-pattern` for data views." }, "toId": { "type": "string", "description": "New saved object reference value to replace the old value." } }, "required": [ "PCID", "kbn-xsrf", "fromId", "toId" ] } ``` *** ## kibana\_management\_update\_data\_view\_default Update a data view **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `viewId` | string | Yes | — | An identifier for the data view. | | `data_view` | object | Yes | — | The data view properties you want to update. Only the specified properties are updated in the data view. Unspecified fields stay as they are persisted. | | `refresh_fields` | boolean | No | — | Reloads the data view fields after the data view is updated. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "viewId": { "type": "string", "description": "An identifier for the data view." }, "data_view": { "type": "object", "description": "The data view properties you want to update. Only the specified properties are updated in the data view. Unspecified fields stay as they are persisted.", "properties": { "allowNoIndex": { "type": "boolean", "description": "Allows the data view saved object to exist before the data is available. Defaults to `false`." }, "fieldFormats": { "type": "object", "description": "A map of field formats by field name." }, "fields": { "type": "object", "description": "The fields value" }, "name": { "type": "string", "description": "The name value" }, "runtimeFieldMap": { "type": "object", "description": "Runtime Field Map" }, "sourceFilters": { "type": "array", "items": { "type": "object" }, "description": "The array of field names you want to filter out in Discover." }, "timeFieldName": { "type": "string", "description": "The timestamp field name, which you use for time-based data views." }, "title": { "type": "string", "description": "Comma-separated list of data streams, indices, and aliases that you want to search. Supports wildcards (`*`)." }, "type": { "type": "string", "description": "When set to `rollup`, identifies the rollup data views." }, "typeMeta": { "type": "object", "description": "When you use rollup indices, contains the field list for the rollup data view API endpoints." } } }, "refresh_fields": { "type": "boolean", "description": "Reloads the data view fields after the data view is updated." } }, "required": [ "PCID", "kbn-xsrf", "viewId", "data_view" ] } ``` *** ## kibana\_management\_update\_fields\_metadata\_default Update data view fields metadata **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------- | | `kbn-xsrf` | string | Yes | — | Cross-site request forgery protection | | `viewId` | string | Yes | — | An identifier for the data view. | | `fields` | object | Yes | — | The field object. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "kbn-xsrf": { "type": "string", "description": "Cross-site request forgery protection" }, "viewId": { "type": "string", "description": "An identifier for the data view." }, "fields": { "type": "object", "description": "The field object." } }, "required": [ "PCID", "kbn-xsrf", "viewId", "fields" ] } ``` *** ## kibana\_management\_update\_runtime\_field\_default Update a runtime field **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------- | | `fieldName` | string | Yes | — | The name of the runtime field. | | `viewId` | string | Yes | — | An identifier for the data view. | | `runtimeField` | object | Yes | — | The runtime field definition object. You can update following fields: - `type` - `script` | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fieldName": { "type": "string", "description": "The name of the runtime field." }, "viewId": { "type": "string", "description": "An identifier for the data view." }, "runtimeField": { "type": "object", "description": "The runtime field definition object. You can update following fields: - `type` - `script`" } }, "required": [ "PCID", "fieldName", "viewId", "runtimeField" ] } ```