Skip to main content
Server path: /kibana-management | Type: Application | PCID required: Yes

Tools

ToolDescription
kibana_management_create_data_view_defaultwCreate a data view
kibana_management_create_runtime_field_defaultCreate a runtime field
kibana_management_create_update_runtime_field_defaultCreate or update a runtime field
kibana_management_delete_data_view_defaultDelete a data view
kibana_management_delete_runtime_field_defaultDelete a runtime field from a data view
kibana_management_delete_security_role_nameDelete a role
kibana_management_delete_spaces_space_idDelete a space
kibana_management_get_all_data_views_defaultGet all data views
kibana_management_get_data_view_defaultGet a data view
kibana_management_get_default_data_view_defaultGet the default data view
kibana_management_get_runtime_field_defaultGet a runtime field
kibana_management_get_security_roleGet all roles
kibana_management_get_security_role_nameGet a role
kibana_management_get_spaces_spaceGet all spaces
kibana_management_get_spaces_space_idGet a space
kibana_management_post_saved_objects_exportExport saved objects
kibana_management_post_saved_objects_importImport saved objects
kibana_management_post_security_rolesCreate or update roles
kibana_management_post_spaces_copy_saved_objectsCopy saved objects between spaces
kibana_management_post_spaces_disable_legacy_url_aliasesDisable legacy URL aliases
kibana_management_post_spaces_get_shareable_referencesGet shareable references
kibana_management_post_spaces_spaceCreate a space
kibana_management_post_spaces_update_objects_spacesUpdate saved objects in spaces
kibana_management_preview_swap_data_views_defaultPreview a saved object reference swap
kibana_management_put_security_role_nameCreate or update a role
kibana_management_put_spaces_space_idUpdate a space
kibana_management_resolve_import_errorsResolve import errors
kibana_management_rotate_encryption_keyRotate a key for encrypted saved objects
kibana_management_set_default_datail_view_defaultSet the default data view
kibana_management_swap_data_views_defaultSwap saved object references
kibana_management_update_data_view_defaultUpdate a data view
kibana_management_update_fields_metadata_defaultUpdate data view fields metadata
kibana_management_update_runtime_field_defaultUpdate a runtime field

kibana_management_create_data_view_defaultw

Create a data view Parameters:
ParameterTypeRequiredDefaultDescription
data_viewobjectYesThe data view object.
overridebooleanNoOverride 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:
ParameterTypeRequiredDefaultDescription
viewIdstringYesAn identifier for the data view.
namestringYesThe name for a runtime field.
runtimeFieldobjectYesThe runtime field definition object.

kibana_management_create_update_runtime_field_default

Create or update a runtime field Parameters:
ParameterTypeRequiredDefaultDescription
viewIdstringYesThe ID of the data view fields you want to update.
namestringYesThe name for a runtime field.
runtimeFieldobjectYesThe runtime field definition object.

kibana_management_delete_data_view_default

Delete a data view Parameters:
ParameterTypeRequiredDefaultDescription
viewIdstringYesAn identifier for the data view.

kibana_management_delete_runtime_field_default

Delete a runtime field from a data view Parameters:
ParameterTypeRequiredDefaultDescription
fieldNamestringYesThe name of the runtime field.
viewIdstringYesAn identifier for the data view.

kibana_management_delete_security_role_name

Delete a role Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value

kibana_management_delete_spaces_space_id

Delete a space Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe space identifier.

kibana_management_get_all_data_views_default

Get all data views

kibana_management_get_data_view_default

Get a data view Parameters:
ParameterTypeRequiredDefaultDescription
viewIdstringYesAn identifier for the data view.

kibana_management_get_default_data_view_default

Get the default data view

kibana_management_get_runtime_field_default

Get a runtime field Parameters:
ParameterTypeRequiredDefaultDescription
fieldNamestringYesThe name of the runtime field.
viewIdstringYesAn identifier for the data view.

kibana_management_get_security_role

Get all roles Parameters:
ParameterTypeRequiredDefaultDescription
replaceDeprecatedPrivilegesbooleanNoIf 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:
ParameterTypeRequiredDefaultDescription
namestringYesThe role name.
replaceDeprecatedPrivilegesbooleanNoIf 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:
ParameterTypeRequiredDefaultDescription
purposestringNoSpecifies which authorization checks are applied to the API call. The default value is any.
include_authorized_purposesobjectYesWhen 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:
ParameterTypeRequiredDefaultDescription
idstringYesThe space identifier.

kibana_management_post_saved_objects_export

Export saved objects Parameters:
ParameterTypeRequiredDefaultDescription
excludeExportDetailsbooleanNoDo not add export details entry at the end of the stream.
hasReferenceobject[]NoHas Reference
includeReferencesDeepbooleanNoIncludes all of the referenced objects in the exported objects.
objectsobject[]NoA list of objects to export. NOTE: this optional parameter cannot be combined with the types option
searchstringNoSearch for documents to export using the Elasticsearch Simple Query String syntax.
typestring[]NoThe 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:
ParameterTypeRequiredDefaultDescription
overwritebooleanNoOverwrites 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.
createNewCopiesbooleanNoCreates 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.
compatibilityModebooleanNoApplies 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.
fileobjectYesA 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:
ParameterTypeRequiredDefaultDescription
rolesobjectYesThe roles value

kibana_management_post_spaces_copy_saved_objects

Copy saved objects between spaces Parameters:
ParameterTypeRequiredDefaultDescription
compatibilityModebooleanNoApply 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.
createNewCopiesbooleanNoCreate 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.
includeReferencesbooleanNoWhen set to true, all saved objects related to the specified saved objects will also be copied into the target spaces.
objectsobject[]YesThe objects value
overwritebooleanNoWhen 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.
spacesstring[]YesThe spaces value

kibana_management_post_spaces_disable_legacy_url_aliases

Disable legacy URL aliases Parameters:
ParameterTypeRequiredDefaultDescription
aliasesobject[]YesThe aliases value

kibana_management_post_spaces_get_shareable_references

Get shareable references Parameters:
ParameterTypeRequiredDefaultDescription
objectsobject[]YesThe objects value

kibana_management_post_spaces_space

Create a space Parameters:
ParameterTypeRequiredDefaultDescription
_reservedbooleanNoThe reserved value
colorstringNoThe hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
descriptionstringNoA description for the space.
disabledFeaturesstring[]NoDisabled Features
idstringYesThe 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.
imageUrlstringNoThe 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.
initialsstringNoOne or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.
namestringYesThe display name for the space.
projectRoutingstringNoCross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments.
solutionstringNoThe solution value

kibana_management_post_spaces_update_objects_spaces

Update saved objects in spaces Parameters:
ParameterTypeRequiredDefaultDescription
objectsobject[]YesThe objects value
spacesToAddstring[]YesSpaces To Add
spacesToRemovestring[]YesSpaces To Remove

kibana_management_preview_swap_data_views_default

Preview a saved object reference swap Parameters:
ParameterTypeRequiredDefaultDescription
deletebooleanNoDeletes referenced saved object if all references are removed.
forIdstring[]NoLimit the affected saved objects to one or more by identifier.
forTypestringNoLimit the affected saved objects by type.
fromIdstringYesThe saved object reference to change.
fromTypestringNoSpecify the type of the saved object reference to alter. The default value is index-pattern for data views.
toIdstringYesNew saved object reference value to replace the old value.

kibana_management_put_security_role_name

Create or update a role Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe role name.
createOnlybooleanNoWhen true, a role is not overwritten if it already exists.
descriptionstringNoA description for the role.
elasticsearchobjectYesThe elasticsearch value
kibanaobject[]NoThe kibana value
metadataobjectNoThe metadata value

kibana_management_put_spaces_space_id

Update a space Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe space identifier. You are unable to change the ID with the update operation.
_reservedbooleanNoThe reserved value
colorstringNoThe hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
descriptionstringNoA description for the space.
disabledFeaturesstring[]NoDisabled Features
imageUrlstringNoThe 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.
initialsstringNoOne or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.
namestringYesThe display name for the space.
projectRoutingstringNoCross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments.
solutionstringNoThe solution value

kibana_management_resolve_import_errors

Resolve import errors Parameters:
ParameterTypeRequiredDefaultDescription
compatibilityModebooleanNoApplies 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.
createNewCopiesbooleanNoCreates 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.
filestringNoThe same file given to the import API.
retriesobject[]YesThe 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:
ParameterTypeRequiredDefaultDescription
batch_sizenumberNoSpecifies 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.
typestringNoLimits 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:
ParameterTypeRequiredDefaultDescription
data_view_idstringYesThe data view identifier. NOTE: The API does not validate whether it is a valid identifier. Use null to unset the default data view.
forcebooleanNoUpdate an existing default data view identifier.

kibana_management_swap_data_views_default

Swap saved object references Parameters:
ParameterTypeRequiredDefaultDescription
deletebooleanNoDeletes referenced saved object if all references are removed.
forIdstring[]NoLimit the affected saved objects to one or more by identifier.
forTypestringNoLimit the affected saved objects by type.
fromIdstringYesThe saved object reference to change.
fromTypestringNoSpecify the type of the saved object reference to alter. The default value is index-pattern for data views.
toIdstringYesNew saved object reference value to replace the old value.

kibana_management_update_data_view_default

Update a data view Parameters:
ParameterTypeRequiredDefaultDescription
viewIdstringYesAn identifier for the data view.
data_viewobjectYesThe 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_fieldsbooleanNoReloads the data view fields after the data view is updated.

kibana_management_update_fields_metadata_default

Update data view fields metadata Parameters:
ParameterTypeRequiredDefaultDescription
viewIdstringYesAn identifier for the data view.
fieldsobjectYesThe field object.

kibana_management_update_runtime_field_default

Update a runtime field Parameters:
ParameterTypeRequiredDefaultDescription
fieldNamestringYesThe name of the runtime field.
viewIdstringYesAn identifier for the data view.
runtimeFieldobjectYesThe runtime field definition object. You can update following fields: - type - script