/kibana-management | Type: Application | PCID required: Yes
Tools
kibana_management_create_data_view_defaultw
Create a data view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
kibana_management_create_runtime_field_default
Create a runtime field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
kibana_management_create_update_runtime_field_default
Create or update a runtime field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
kibana_management_delete_data_view_default
Delete a data view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
viewId | string | Yes | — | An identifier for the data view. |
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. |
kibana_management_delete_security_role_name
Delete a role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name value |
kibana_management_delete_spaces_space_id
Delete a space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The space identifier. |
kibana_management_get_all_data_views_default
Get all data viewskibana_management_get_data_view_default
Get a data view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
viewId | string | Yes | — | An identifier for the data view. |
kibana_management_get_default_data_view_default
Get the default data viewkibana_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. |
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. |
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. |
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 | object | Yes | — | 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. |
kibana_management_get_spaces_space_id
Get a space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The space identifier. |
kibana_management_post_saved_objects_export
Export saved objects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
kibana_management_post_saved_objects_import
Import saved objects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
kibana_management_post_security_roles
Create or update roles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roles | object | Yes | — | The roles value |
kibana_management_post_spaces_copy_saved_objects
Copy saved objects between spaces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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 |
kibana_management_post_spaces_disable_legacy_url_aliases
Disable legacy URL aliases Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
aliases | object[] | Yes | — | The aliases value |
kibana_management_post_spaces_get_shareable_references
Get shareable references Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objects | object[] | Yes | — | The objects value |
kibana_management_post_spaces_space
Create a space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
_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 |
kibana_management_post_spaces_update_objects_spaces
Update saved objects in spaces Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
objects | object[] | Yes | — | The objects value |
spacesToAdd | string[] | Yes | — | Spaces To Add |
spacesToRemove | string[] | Yes | — | Spaces To Remove |
kibana_management_preview_swap_data_views_default
Preview a saved object reference swap Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
kibana_management_put_security_role_name
Create or update a role Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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 |
kibana_management_put_spaces_space_id
Update a space Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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 |
kibana_management_resolve_import_errors
Resolve import errors Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
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. |
kibana_management_set_default_datail_view_default
Set the default data view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
data_view_id | string | 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. |
kibana_management_swap_data_views_default
Swap saved object references Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
kibana_management_update_data_view_default
Update a data view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
kibana_management_update_fields_metadata_default
Update data view fields metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
viewId | string | Yes | — | An identifier for the data view. |
fields | object | Yes | — | The field object. |
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 |

