diff --git a/oas_docs/makefile b/oas_docs/makefile index 7a968f6a44e1f..cb918579e5592 100644 --- a/oas_docs/makefile +++ b/oas_docs/makefile @@ -22,7 +22,8 @@ api-docs: ## Generate Serverless and ESS Kibana OpenAPI bundles .PHONY: merge-api-docs space-aware-api-docs: ## Add special space aware description entries @node scripts/promote_space_awareness.js oas_docs/output/kibana.yaml - @node scripts/promote_space_awareness.js oas_docs/output/kibana.serverless.yaml +## Just for ess for now... +# @node scripts/promote_space_awareness.js oas_docs/output/kibana.serverless.yaml .PHONY: merge-api-docs merge-api-docs: ## Merge Serverless and ESS Kibana OpenAPI bundles with kbn-openapi-bundler diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index d538442d49f4c..50564d2fc404c 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -245,14 +245,7 @@ tags: paths: /api/actions/connector_types: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/actions/connector_types
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - You do not need any Kibana feature privileges to run this API. + description: You do not need any Kibana feature privileges to run this API. operationId: get-actions-connector-types parameters: - description: A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases). @@ -274,14 +267,7 @@ paths: - connectors /api/actions/connector/{id}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/actions/connector/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - WARNING: When you delete a connector, it cannot be recovered. + description: 'WARNING: When you delete a connector, it cannot be recovered.' operationId: delete-actions-connector-id parameters: - description: A required header to protect against CSRF attacks @@ -358,12 +344,6 @@ paths: summary: Get connector information tags: - connectors - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/actions/connector/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: post-actions-connector-id parameters: @@ -512,12 +492,6 @@ paths: summary: Create a connector tags: - connectors - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/actions/connector/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: operationId: put-actions-connector-id parameters: @@ -646,22 +620,9 @@ paths: summary: Update a connector tags: - connectors - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/actions/connector/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/actions/connector/{id}/_execute: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/actions/connector/{id}/_execute
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. + description: You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. operationId: post-actions-connector-id-execute parameters: - description: A required header to protect against CSRF attacks @@ -793,12 +754,6 @@ paths: summary: Get all connectors tags: - connectors - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/actions/connectors
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{id}: delete: operationId: delete-alerting-rule-id @@ -828,12 +783,6 @@ paths: summary: Delete a rule tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/alerting/rule/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. get: operationId: get-alerting-rule-id parameters: @@ -1523,12 +1472,6 @@ paths: summary: Get rule details tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/alerting/rule/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: post-alerting-rule-id parameters: @@ -2925,12 +2868,6 @@ paths: summary: Create a rule tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: operationId: put-alerting-rule-id parameters: @@ -3966,12 +3903,6 @@ paths: summary: Update a rule tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/alerting/rule/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{id}/_disable: post: operationId: post-alerting-rule-id-disable @@ -4013,12 +3944,6 @@ paths: summary: Disable a rule tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{id}/_disable
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{id}/_enable: post: operationId: post-alerting-rule-id-enable @@ -4048,12 +3973,6 @@ paths: summary: Enable a rule tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{id}/_enable
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{id}/_mute_all: post: operationId: post-alerting-rule-id-mute-all @@ -4083,12 +4002,6 @@ paths: summary: Mute all alerts tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{id}/_mute_all
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{id}/_unmute_all: post: operationId: post-alerting-rule-id-unmute-all @@ -4118,12 +4031,6 @@ paths: summary: Unmute all alerts tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{id}/_unmute_all
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{id}/_update_api_key: post: operationId: post-alerting-rule-id-update-api-key @@ -4155,22 +4062,9 @@ paths: summary: Update the API key for a rule tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{id}/_update_api_key
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{id}/snooze_schedule: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{id}/snooze_schedule
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - When you snooze a rule, the rule checks continue to run but alerts will not generate actions. You can snooze for a specified period of time and schedule single or recurring downtimes. + description: When you snooze a rule, the rule checks continue to run but alerts will not generate actions. You can snooze for a specified period of time and schedule single or recurring downtimes. operationId: post-alerting-rule-id-snooze-schedule parameters: - description: A required header to protect against CSRF attacks @@ -4374,12 +4268,6 @@ paths: summary: Mute an alert tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute: post: operationId: post-alerting-rule-rule-id-alert-alert-id-unmute @@ -4415,12 +4303,6 @@ paths: summary: Unmute an alert tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rule/{ruleId}/snooze_schedule/{scheduleId}: delete: operationId: delete-alerting-rule-ruleid-snooze-schedule-scheduleid @@ -4457,12 +4339,6 @@ paths: tags: - alerting x-state: Generally available - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/alerting/rule/{ruleId}/snooze_schedule/{scheduleId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/alerting/rules/_find: get: operationId: get-alerting-rules-find @@ -5437,21 +5313,9 @@ paths: summary: Get information about rules tags: - alerting - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/alerting/rules/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/apm/agent_keys: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/apm/agent_keys
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create a new agent key for APM. The user creating an APM agent API key must have at least the `manage_own_api_key` cluster privilege and the APM application-level privileges that it wishes to grant. After it is created, you can copy the API key (Base64 encoded) and use it to to authorize requests from APM agents to the APM Server. @@ -5559,22 +5423,9 @@ paths: summary: Save APM server schema tags: - APM server schema - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/apm/fleet/apm_server_schema
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/apm/services/{serviceName}/annotation: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/apm/services/{serviceName}/annotation
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a new annotation for a specific service. + description: Create a new annotation for a specific service. operationId: createAnnotation parameters: - $ref: '#/components/parameters/APM_UI_elastic_api_version' @@ -5645,14 +5496,7 @@ paths: }' /api/apm/services/{serviceName}/annotation/search: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/apm/services/{serviceName}/annotation/search
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Search for annotations related to a specific service. + description: Search for annotations related to a specific service. operationId: getAnnotation parameters: - $ref: '#/components/parameters/APM_UI_elastic_api_version' @@ -5757,12 +5601,6 @@ paths: summary: Delete agent configuration tags: - APM agent configuration - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/apm/settings/agent-configuration
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. get: operationId: getAgentConfigurations parameters: @@ -5798,12 +5636,6 @@ paths: summary: Get a list of agent configurations tags: - APM agent configuration - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/apm/settings/agent-configuration
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: operationId: createUpdateAgentConfiguration parameters: @@ -5858,22 +5690,9 @@ paths: summary: Create or update agent configuration tags: - APM agent configuration - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/apm/settings/agent-configuration
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/apm/settings/agent-configuration/agent_name: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/apm/settings/agent-configuration/agent_name
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Retrieve `agentName` for a service. + description: Retrieve `agentName` for a service. operationId: getAgentNameForService parameters: - $ref: '#/components/parameters/APM_UI_elastic_api_version' @@ -5950,21 +5769,9 @@ paths: summary: Get environments for service tags: - APM agent configuration - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/apm/settings/agent-configuration/environments
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/apm/settings/agent-configuration/search: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/apm/settings/agent-configuration/search
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - This endpoint enables you to search for a single agent configuration and update the 'applied_by_agent' field. operationId: searchSingleConfiguration parameters: @@ -6055,21 +5862,9 @@ paths: summary: Get single agent configuration tags: - APM agent configuration - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/apm/settings/agent-configuration/view
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/apm/sourcemaps: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/apm/sourcemaps
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Get an array of Fleet artifacts, including source map uploads. You must have `read` or `all` Kibana privileges for the APM and User Experience feature. operationId: getSourceMaps parameters: @@ -6130,12 +5925,6 @@ paths: -H 'Authorization: ApiKey ${YOUR_API_KEY}' post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/apm/sourcemaps
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Upload a source map for a specific service and version. You must have `all` Kibana privileges for the APM and User Experience feature. The maximum payload size is `1mb`. If you attempt to upload a source map that exceeds the maximum payload size, you will get a 413 error. Before uploading source maps that exceed this default, change the maximum payload size allowed by Kibana with the `server.maxPayload` variable. operationId: uploadSourceMap @@ -6205,12 +5994,6 @@ paths: /api/apm/sourcemaps/{id}: delete: description: | - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/apm/sourcemaps/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Delete a previously uploaded source map. You must have `all` Kibana privileges for the APM and User Experience feature. operationId: deleteSourceMap parameters: @@ -6272,14 +6055,7 @@ paths: -H 'Authorization: ApiKey ${YOUR_API_KEY}' /api/asset_criticality: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/asset_criticality
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete the asset criticality record for a specific entity. + description: Delete the asset criticality record for a specific entity. operationId: DeleteAssetCriticalityRecord parameters: - description: The ID value of the asset. @@ -6326,14 +6102,7 @@ paths: tags: - Security Entity Analytics API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/asset_criticality
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the asset criticality record for a specific entity. + description: Get the asset criticality record for a specific entity. operationId: GetAssetCriticalityRecord parameters: - description: The ID value of the asset. @@ -6366,12 +6135,6 @@ paths: - Security Entity Analytics API post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/asset_criticality
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create or update an asset criticality record for a specific entity. If a record already exists for the specified entity, that record is overwritten with the specified value. If a record doesn't exist for the specified entity, a new record is created. @@ -6409,12 +6172,6 @@ paths: /api/asset_criticality/bulk: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/asset_criticality/bulk
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Bulk upsert up to 1000 asset criticality records. If asset criticality records already exist for the specified entities, those records are overwritten with the specified values. If asset criticality records don't exist for the specified entities, new records are created. @@ -6480,14 +6237,7 @@ paths: - Security Entity Analytics API /api/asset_criticality/list: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/asset_criticality/list
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - List asset criticality records, paging, sorting and filtering as needed. + description: List asset criticality records, paging, sorting and filtering as needed. operationId: FindAssetCriticalityRecords parameters: - description: The field to sort by. @@ -6626,12 +6376,6 @@ paths: summary: Get all data views tags: - data views - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/data_views
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/data_views/data_view: post: operationId: createDataViewDefaultw @@ -6662,21 +6406,9 @@ paths: summary: Create a data view tags: - data views - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/data_views/data_view
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/data_views/data_view/{viewId}: delete: description: | - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/data_views/data_view/{viewId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - WARNING: When you delete a data view, it cannot be recovered. operationId: deleteDataViewDefault parameters: @@ -6717,12 +6449,6 @@ paths: summary: Get a data view tags: - data views - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/data_views/data_view/{viewId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: updateDataViewDefault parameters: @@ -6753,21 +6479,9 @@ paths: summary: Update a data view tags: - data views - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/data_views/data_view/{viewId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/data_views/data_view/{viewId}/fields: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/data_views/data_view/{viewId}/fields
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Update fields presentation metadata such as count, customLabel, customDescription, and format. operationId: updateFieldsMetadataDefault parameters: @@ -6844,12 +6558,6 @@ paths: summary: Create a runtime field tags: - data views - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/data_views/data_view/{viewId}/runtime_field
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: operationId: createUpdateRuntimeFieldDefault parameters: @@ -6905,12 +6613,6 @@ paths: summary: Create or update a runtime field tags: - data views - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/data_views/data_view/{viewId}/runtime_field
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/data_views/data_view/{viewId}/runtime_field/{fieldName}: delete: operationId: deleteRuntimeFieldDefault @@ -6929,12 +6631,6 @@ paths: summary: Delete a runtime field from a data view tags: - data views - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/data_views/data_view/{viewId}/runtime_field/{fieldName}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. get: operationId: getRuntimeFieldDefault parameters: @@ -6966,12 +6662,6 @@ paths: summary: Get a runtime field tags: - data views - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/data_views/data_view/{viewId}/runtime_field/{fieldName}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: updateRuntimeFieldDefault parameters: @@ -7010,12 +6700,6 @@ paths: summary: Update a runtime field tags: - data views - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/data_views/data_view/{viewId}/runtime_field/{fieldName}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/data_views/default: get: operationId: getDefaultDataViewDefault @@ -7041,12 +6725,6 @@ paths: summary: Get the default data view tags: - data views - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/data_views/default
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: setDefaultDatailViewDefault parameters: @@ -7091,21 +6769,9 @@ paths: summary: Set the default data view tags: - data views - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/data_views/default
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/data_views/swap_references: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/data_views/swap_references
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Changes saved object references from one data view identifier to another. WARNING: Misuse can break large numbers of saved objects! Practicing with a backup is recommended. operationId: swapDataViewsDefault parameters: @@ -7151,12 +6817,6 @@ paths: /api/data_views/swap_references/_preview: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/data_views/swap_references/_preview
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Preview the impact of swapping saved object references from one data view identifier to another. operationId: previewSwapDataViewsDefault parameters: @@ -7195,12 +6855,6 @@ paths: /api/detection_engine/privileges: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/detection_engine/privileges
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Retrieves whether or not the user is authenticated, and the user's Kibana space and index privileges, which determine if the user can create an index for the Elastic Security alerts generated by @@ -7275,12 +6929,6 @@ paths: /api/detection_engine/rules: delete: description: | - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/detection_engine/rules
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Delete a detection rule using the `rule_id` or `id` field. The URL query must include one of the following: @@ -7321,12 +6969,6 @@ paths: --header "Content-Type: application/json; Elastic-Api-Version=2023-10-31" get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/detection_engine/rules
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Retrieve a detection rule using the `rule_id` or `id` field. The URL query must include one of the following: @@ -7436,12 +7078,6 @@ paths: --header "Content-Type: application/json; Elastic-Api-Version=2023-10-31" patch: description: | - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/detection_engine/rules
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Update specific fields of an existing detection rule using the `rule_id` or `id` field. The difference between the `id` and `rule_id` is that the `id` is a unique rule identifier that is randomly generated when a rule is created and cannot be set, whereas `rule_id` is a stable rule identifier that can be assigned during rule creation. @@ -7566,12 +7202,6 @@ paths: - Security Detections API post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/rules
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create a new detection rule. > warn > When used with [API key](https://www.elastic.co/guide/en/kibana/current/api-keys.html) authentication, the user's key gets assigned to the affected rules. If the user's key gets deleted or the user becomes inactive, the rules will stop running. @@ -8259,12 +7889,6 @@ paths: - Security Detections API put: description: | - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/detection_engine/rules
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Update a detection rule using the `rule_id` or `id` field. The original rule is replaced, and all unspecified fields are deleted. The difference between the `id` and `rule_id` is that the `id` is a unique rule identifier that is randomly generated when a rule is created and cannot be set, whereas `rule_id` is a stable rule identifier that can be assigned during rule creation. @@ -8437,12 +8061,6 @@ paths: /api/detection_engine/rules/_bulk_action: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/rules/_bulk_action
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Apply a bulk action, such as bulk edit, duplicate, or delete, to multiple detection rules. The bulk action is applied to all rules that match the query or to the rules listed by their IDs. The edit action allows you to add, delete, or set tags, index patterns, investigation fields, rule actions and schedules for multiple rules at once. @@ -9492,12 +9110,6 @@ paths: /api/detection_engine/rules/_export: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/rules/_export
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Export detection rules to an `.ndjson` file. The following configuration items are also included in the `.ndjson` file: - Actions - Exception lists @@ -9577,14 +9189,7 @@ paths: } /api/detection_engine/rules/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/detection_engine/rules/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Retrieve a paginated list of detection rules. By default, the first page is returned, with 20 results per page. + description: Retrieve a paginated list of detection rules. By default, the first page is returned, with 20 results per page. operationId: FindRules parameters: - in: query @@ -9754,12 +9359,6 @@ paths: /api/detection_engine/rules/_import: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/rules/_import
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Import detection rules from an `.ndjson` file, including actions and exception lists. The request must include: - The `Content-Type: multipart/form-data` HTTP header. - A link to the `.ndjson` file containing the rules. @@ -9895,14 +9494,7 @@ paths: --form "file=@" /api/detection_engine/rules/{id}/exceptions: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/rules/{id}/exceptions
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create exception items that apply to a single detection rule. + description: Create exception items that apply to a single detection rule. operationId: CreateRuleExceptionListItems parameters: - description: Detection rule's identifier @@ -10130,21 +9722,9 @@ paths: summary: Preview rule alerts generated on specified time range tags: - Security Detections API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/rules/preview
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/detection_engine/signals/assignees: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/signals/assignees
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Assign users to detection alerts, and unassign them from alerts. > info > You cannot add and remove the same assignee in the same request. @@ -10211,14 +9791,7 @@ paths: - Security Detections API /api/detection_engine/signals/search: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/signals/search
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Find and/or aggregate detection alerts that match the given query. + description: Find and/or aggregate detection alerts that match the given query. operationId: SearchAlerts requestBody: content: @@ -10344,14 +9917,7 @@ paths: - Security Detections API /api/detection_engine/signals/status: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/signals/status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Set the status of one or more detection alerts. + description: Set the status of one or more detection alerts. operationId: SetAlertsStatus requestBody: content: @@ -10469,12 +10035,6 @@ paths: /api/detection_engine/signals/tags: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/detection_engine/signals/tags
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - And tags to detection alerts, and remove them from alerts. > info > You cannot add and remove the same alert tag in the same request. @@ -10563,14 +10123,7 @@ paths: - Security Detections API /api/detection_engine/tags: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/detection_engine/tags
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - List all unique tags from all detection rules. + description: List all unique tags from all detection rules. operationId: ReadTags responses: '200': @@ -10595,14 +10148,7 @@ paths: - Security Detections API /api/endpoint_list: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint_list
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create the exception list for Elastic Endpoint rule exceptions. When you create the exception list, it will have a `list_id` of `endpoint_list`. If the Elastic Endpoint exception list already exists, your request will return an empty response. + description: Create the exception list for Elastic Endpoint rule exceptions. When you create the exception list, it will have a `list_id` of `endpoint_list`. If the Elastic Endpoint exception list already exists, your request will return an empty response. operationId: CreateEndpointList responses: '200': @@ -10642,14 +10188,7 @@ paths: - Security Endpoint Exceptions API /api/endpoint_list/items: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/endpoint_list/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. + description: Delete an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: DeleteEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -10707,14 +10246,7 @@ paths: tags: - Security Endpoint Exceptions API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint_list/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. + description: Get the details of an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: ReadEndpointListItem parameters: - description: Either `id` or `item_id` must be specified @@ -10774,14 +10306,7 @@ paths: tags: - Security Endpoint Exceptions API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint_list/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create an Elastic Endpoint exception list item, and associate it with the Elastic Endpoint exception list. + description: Create an Elastic Endpoint exception list item, and associate it with the Elastic Endpoint exception list. operationId: CreateEndpointListItem requestBody: content: @@ -10860,14 +10385,7 @@ paths: tags: - Security Endpoint Exceptions API put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/endpoint_list/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. + description: Update an Elastic Endpoint exception list item, specified by the `id` or `item_id` field. operationId: UpdateEndpointListItem requestBody: content: @@ -10952,14 +10470,7 @@ paths: - Security Endpoint Exceptions API /api/endpoint_list/items/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint_list/items/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all Elastic Endpoint exception list items. + description: Get a list of all Elastic Endpoint exception list items. operationId: FindEndpointListItems parameters: - description: | @@ -11064,14 +10575,7 @@ paths: - Security Endpoint Exceptions API /api/endpoint/action: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/action
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all response actions. + description: Get a list of all response actions. operationId: EndpointGetActionsList parameters: - in: query @@ -11136,14 +10640,7 @@ paths: - Security Endpoint Management API /api/endpoint/action_status: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/action_status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the status of response actions for the specified agent IDs. + description: Get the status of response actions for the specified agent IDs. operationId: EndpointGetActionsStatus parameters: - in: query @@ -11166,14 +10663,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/{action_id}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/action/{action_id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of a response action using the action ID. + description: Get the details of a response action using the action ID. operationId: EndpointGetActionsDetails parameters: - in: path @@ -11195,14 +10685,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/{action_id}/file/{file_id}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/action/{action_id}/file/{file_id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get information for the specified file using the file ID. + description: Get information for the specified file using the file ID. operationId: EndpointFileInfo parameters: - in: path @@ -11227,14 +10710,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/{action_id}/file/{file_id}/download: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/action/{action_id}/file/{file_id}/download
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Download a file from an endpoint. + description: Download a file from an endpoint. operationId: EndpointFileDownload parameters: - in: path @@ -11259,14 +10735,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/execute: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/execute
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Run a shell command on an endpoint. + description: Run a shell command on an endpoint. operationId: EndpointExecuteAction requestBody: content: @@ -11286,14 +10755,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/get_file: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/get_file
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a file from an endpoint. + description: Get a file from an endpoint. operationId: EndpointGetFileAction requestBody: content: @@ -11313,14 +10775,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/isolate: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/isolate
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Isolate an endpoint from the network. The endpoint remains isolated until it's released. + description: Isolate an endpoint from the network. The endpoint remains isolated until it's released. operationId: EndpointIsolateAction requestBody: content: @@ -11378,14 +10833,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/kill_process: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/kill_process
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Terminate a running process on an endpoint. + description: Terminate a running process on an endpoint. operationId: EndpointKillProcessAction requestBody: content: @@ -11405,14 +10853,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/running_procs: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/running_procs
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all processes running on an endpoint. + description: Get a list of all processes running on an endpoint. operationId: EndpointGetProcessesAction requestBody: content: @@ -11432,14 +10873,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/runscript: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/runscript
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Run a shell command on an endpoint. + description: Run a shell command on an endpoint. operationId: RunScriptAction requestBody: content: @@ -11459,14 +10893,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/scan: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/scan
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Scan a specific file or directory on an endpoint for malware. + description: Scan a specific file or directory on an endpoint for malware. operationId: EndpointScanAction requestBody: content: @@ -11486,14 +10913,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/state: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/action/state
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a response actions state, which reports whether encryption is enabled. + description: Get a response actions state, which reports whether encryption is enabled. operationId: EndpointGetActionsState responses: '200': @@ -11507,14 +10927,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/suspend_process: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/suspend_process
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Suspend a running process on an endpoint. + description: Suspend a running process on an endpoint. operationId: EndpointSuspendProcessAction requestBody: content: @@ -11534,14 +10947,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/unisolate: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/unisolate
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Release an isolated endpoint, allowing it to rejoin a network. + description: Release an isolated endpoint, allowing it to rejoin a network. operationId: EndpointUnisolateAction requestBody: content: @@ -11599,14 +11005,7 @@ paths: - Security Endpoint Management API /api/endpoint/action/upload: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/action/upload
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Upload a file to an endpoint. + description: Upload a file to an endpoint. operationId: EndpointUploadAction requestBody: content: @@ -11668,12 +11067,6 @@ paths: summary: Get a metadata list tags: - Security Endpoint Management API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/metadata
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/endpoint/metadata/{id}: get: operationId: GetEndpointMetadata @@ -11694,12 +11087,6 @@ paths: summary: Get metadata tags: - Security Endpoint Management API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/metadata/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/endpoint/policy_response: get: operationId: GetPolicyResponse @@ -11722,12 +11109,6 @@ paths: summary: Get a policy response tags: - Security Endpoint Management API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/policy_response
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/endpoint/protection_updates_note/{package_policy_id}: get: operationId: GetProtectionUpdatesNote @@ -11747,12 +11128,6 @@ paths: summary: Get a protection updates note tags: - Security Endpoint Management API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/endpoint/protection_updates_note/{package_policy_id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: CreateUpdateProtectionUpdatesNote parameters: @@ -11780,12 +11155,6 @@ paths: summary: Create or update a protection updates note tags: - Security Endpoint Management API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/endpoint/protection_updates_note/{package_policy_id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/monitoring/engine/delete: delete: operationId: DeleteMonitoringEngine @@ -11812,12 +11181,6 @@ paths: summary: Delete the Privilege Monitoring Engine tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/entity_analytics/monitoring/engine/delete
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/monitoring/engine/disable: post: operationId: DisableMonitoringEngine @@ -11831,12 +11194,6 @@ paths: summary: Disable the Privilege Monitoring Engine tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_analytics/monitoring/engine/disable
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/monitoring/engine/init: post: operationId: InitMonitoringEngine @@ -11850,12 +11207,6 @@ paths: summary: Initialize the Privilege Monitoring Engine tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_analytics/monitoring/engine/init
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/monitoring/privileges/health: get: operationId: PrivMonHealth @@ -11881,22 +11232,9 @@ paths: summary: Health check on Privilege Monitoring tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/entity_analytics/monitoring/privileges/health
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/monitoring/privileges/privileges: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/entity_analytics/monitoring/privileges/privileges
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Check if the current user has all required permissions for Privilege Monitoring + description: Check if the current user has all required permissions for Privilege Monitoring operationId: PrivMonPrivileges responses: '200': @@ -11934,12 +11272,6 @@ paths: summary: Create a new monitored user tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_analytics/monitoring/users
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/monitoring/users/_csv: post: operationId: PrivmonBulkUploadUsersCSV @@ -11986,12 +11318,6 @@ paths: summary: Upsert multiple monitored users via CSV upload tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_analytics/monitoring/users/_csv
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/monitoring/users/{id}: delete: operationId: DeletePrivMonUser @@ -12020,12 +11346,6 @@ paths: summary: Delete a monitored user tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/entity_analytics/monitoring/users/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: operationId: UpdatePrivMonUser parameters: @@ -12050,12 +11370,6 @@ paths: summary: Update a monitored user tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/entity_analytics/monitoring/users/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/monitoring/users/list: get: operationId: ListPrivMonUsers @@ -12078,12 +11392,6 @@ paths: summary: List all monitored users tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/entity_analytics/monitoring/users/list
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/privileged_user_monitoring/pad/install: post: operationId: InstallPrivilegedAccessDetectionPackage @@ -12102,12 +11410,6 @@ paths: summary: Installs the privileged access detection package for the Entity Analytics privileged user monitoring experience tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_analytics/privileged_user_monitoring/pad/install
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_analytics/privileged_user_monitoring/pad/status: get: operationId: GetPrivilegedAccessDetectionPackageStatus @@ -12156,12 +11458,6 @@ paths: summary: Gets the status of the privileged access detection package for the Entity Analytics privileged user monitoring experience tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/entity_analytics/privileged_user_monitoring/pad/status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_store/enable: post: operationId: InitEntityStore @@ -12238,12 +11534,6 @@ paths: summary: Initialize the Entity Store tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_store/enable
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_store/engines: get: operationId: ListEntityEngines @@ -12264,12 +11554,6 @@ paths: summary: List the Entity Engines tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/entity_store/engines
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_store/engines/{entityType}: delete: operationId: DeleteEntityEngine @@ -12299,12 +11583,6 @@ paths: summary: Delete the Entity Engine tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/entity_store/engines/{entityType}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. get: operationId: GetEntityEngine parameters: @@ -12324,12 +11602,6 @@ paths: summary: Get an Entity Engine tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/entity_store/engines/{entityType}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_store/engines/{entityType}/init: post: operationId: InitEntityEngine @@ -12402,12 +11674,6 @@ paths: summary: Initialize an Entity Engine tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_store/engines/{entityType}/init
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_store/engines/{entityType}/start: post: operationId: StartEntityEngine @@ -12431,12 +11697,6 @@ paths: summary: Start an Entity Engine tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_store/engines/{entityType}/start
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_store/engines/{entityType}/stop: post: operationId: StopEntityEngine @@ -12460,12 +11720,6 @@ paths: summary: Stop an Entity Engine tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_store/engines/{entityType}/stop
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_store/engines/apply_dataview_indices: post: operationId: ApplyEntityEngineDataviewIndices @@ -12514,22 +11768,9 @@ paths: summary: Apply DataView indices to all installed engines tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/entity_store/engines/apply_dataview_indices
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/entity_store/entities/list: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/entity_store/entities/list
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - List entities records, paging, sorting and filtering as needed. + description: List entities records, paging, sorting and filtering as needed. operationId: ListEntities parameters: - in: query @@ -12639,22 +11880,9 @@ paths: summary: Get the status of the Entity Store tags: - Security Entity Analytics API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/entity_store/status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/exception_lists: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/exception_lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete an exception list using the `id` or `list_id` field. + description: Delete an exception list using the `id` or `list_id` field. operationId: DeleteExceptionList parameters: - description: Exception list's identifier. Either `id` or `list_id` must be specified. @@ -12777,14 +12005,7 @@ paths: tags: - Security Exceptions API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/exception_lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of an exception list using the `id` or `list_id` field. + description: Get the details of an exception list using the `id` or `list_id` field. operationId: ReadExceptionList parameters: - description: Exception list's identifier. Either `id` or `list_id` must be specified. @@ -12903,12 +12124,6 @@ paths: - Security Exceptions API post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/exception_lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - An exception list groups exception items and can be associated with detection rules. You can assign exception lists to multiple detection rules. > info > All exception items added to the same list are evaluated using `OR` logic. That is, if any of the items in a list evaluate to `true`, the exception prevents the rule from generating an alert. Likewise, `OR` logic is used for evaluating exceptions when more than one exception list is assigned to a rule. To use the `AND` operator, you can define multiple clauses (`entries`) in a single exception item. @@ -13107,14 +12322,7 @@ paths: tags: - Security Exceptions API put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/exception_lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an exception list using the `id` or `list_id` field. + description: Update an exception list using the `id` or `list_id` field. operationId: UpdateExceptionList requestBody: content: @@ -13254,14 +12462,7 @@ paths: - Security Exceptions API /api/exception_lists/_duplicate: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/exception_lists/_duplicate
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Duplicate an existing exception list. + description: Duplicate an existing exception list. operationId: DuplicateExceptionList parameters: - in: query @@ -13388,14 +12589,7 @@ paths: - Security Exceptions API /api/exception_lists/_export: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/exception_lists/_export
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Export an exception list and its associated items to an NDJSON file. + description: Export an exception list and its associated items to an NDJSON file. operationId: ExportExceptionList parameters: - in: query @@ -13509,14 +12703,7 @@ paths: - Security Exceptions API /api/exception_lists/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/exception_lists/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all exception list containers. + description: Get a list of all exception list containers. operationId: FindExceptionLists parameters: - description: | @@ -13685,14 +12872,7 @@ paths: - Security Exceptions API /api/exception_lists/_import: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/exception_lists/_import
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Import an exception list and its associated items from an NDJSON file. + description: Import an exception list and its associated items from an NDJSON file. operationId: ImportExceptionList parameters: - description: | @@ -13839,14 +13019,7 @@ paths: - Security Exceptions API /api/exception_lists/items: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/exception_lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete an exception list item using the `id` or `item_id` field. + description: Delete an exception list item using the `id` or `item_id` field. operationId: DeleteExceptionListItem parameters: - description: Exception item's identifier. Either `id` or `item_id` must be specified @@ -13972,14 +13145,7 @@ paths: tags: - Security Exceptions API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/exception_lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of an exception list item using the `id` or `item_id` field. + description: Get the details of an exception list item using the `id` or `item_id` field. operationId: ReadExceptionListItem parameters: - description: Exception list item's identifier. Either `id` or `item_id` must be specified. @@ -14108,12 +13274,6 @@ paths: - Security Exceptions API post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/exception_lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create an exception item and associate it with the specified exception list. > info > Before creating exception items, you must create an exception list. @@ -14434,14 +13594,7 @@ paths: tags: - Security Exceptions API put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/exception_lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an exception list item using the `id` or `item_id` field. + description: Update an exception list item using the `id` or `item_id` field. operationId: UpdateExceptionListItem requestBody: content: @@ -14599,14 +13752,7 @@ paths: - Security Exceptions API /api/exception_lists/items/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/exception_lists/items/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all exception list items in the specified list. + description: Get a list of all exception list items in the specified list. operationId: FindExceptionListItems parameters: - description: The `list_id`s of the items to fetch. @@ -14815,14 +13961,7 @@ paths: - Security Exceptions API /api/exception_lists/summary: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/exception_lists/summary
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a summary of the specified exception list. + description: Get a summary of the specified exception list. operationId: ReadExceptionListSummary parameters: - description: Exception list's identifier generated upon creation. @@ -14948,12 +14087,6 @@ paths: /api/exceptions/shared: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/exceptions/shared
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - An exception list groups exception items and can be associated with detection rules. A shared exception list can apply to multiple detection rules. > info > All exception items added to the same list are evaluated using `OR` logic. That is, if any of the items in a list evaluate to `true`, the exception prevents the rule from generating an alert. Likewise, `OR` logic is used for evaluating exceptions when more than one exception list is assigned to a rule. To use the `AND` operator, you can define multiple clauses (`entries`) in a single exception item. @@ -15073,14 +14206,7 @@ paths: - Security Exceptions API /api/fleet/agent_download_sources: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_download_sources
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-settings-read. + description: '[Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-settings-read.' operationId: get-fleet-agent-download-sources parameters: [] responses: @@ -15180,14 +14306,7 @@ paths: tags: - Elastic Agent binary download sources post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agent_download_sources
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-settings-all.' operationId: post-fleet-agent-download-sources parameters: - description: A required header to protect against CSRF attacks @@ -15338,14 +14457,7 @@ paths: - Elastic Agent binary download sources /api/fleet/agent_download_sources/{sourceId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/agent_download_sources/{sourceId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete an agent binary download source by ID.

[Required authorization] Route required privileges: fleet-settings-all. + description: 'Delete an agent binary download source by ID.

[Required authorization] Route required privileges: fleet-settings-all.' operationId: delete-fleet-agent-download-sources-sourceid parameters: - description: A required header to protect against CSRF attacks @@ -15396,14 +14508,7 @@ paths: tags: - Elastic Agent binary download sources get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_download_sources/{sourceId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get an agent binary download source by ID.

[Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-settings-read. + description: 'Get an agent binary download source by ID.

[Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-settings-read.' operationId: get-fleet-agent-download-sources-sourceid parameters: - in: path @@ -15497,14 +14602,7 @@ paths: tags: - Elastic Agent binary download sources put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/agent_download_sources/{sourceId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an agent binary download source by ID.

[Required authorization] Route required privileges: fleet-settings-all. + description: 'Update an agent binary download source by ID.

[Required authorization] Route required privileges: fleet-settings-all.' operationId: put-fleet-agent-download-sources-sourceid parameters: - description: A required header to protect against CSRF attacks @@ -15660,14 +14758,7 @@ paths: - Elastic Agent binary download sources /api/fleet/agent_policies: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_policies
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-agents-read OR fleet-setup. + description: '[Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-agents-read OR fleet-setup.' operationId: get-fleet-agent-policies parameters: - in: query @@ -16403,14 +15494,7 @@ paths: tags: - Elastic Agent policies post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agent_policies
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: fleet-agent-policies-all.' operationId: post-fleet-agent-policies parameters: - description: A required header to protect against CSRF attacks @@ -17304,14 +16388,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/_bulk_get: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agent_policies/_bulk_get
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-agents-read OR fleet-setup. + description: '[Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-agents-read OR fleet-setup.' operationId: post-fleet-agent-policies-bulk-get parameters: - description: A required header to protect against CSRF attacks @@ -18013,14 +17090,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/{agentPolicyId}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-agents-read OR fleet-setup. + description: 'Get an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-read OR fleet-agents-read OR fleet-setup.' operationId: get-fleet-agent-policies-agentpolicyid parameters: - in: path @@ -18698,14 +17768,7 @@ paths: tags: - Elastic Agent policies put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all. + description: 'Update an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all.' operationId: put-fleet-agent-policies-agentpolicyid parameters: - description: A required header to protect against CSRF attacks @@ -19609,14 +18672,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/{agentPolicyId}/auto_upgrade_agents_status: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}/auto_upgrade_agents_status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get auto upgrade agent status

[Required authorization] Route required privileges: fleet-agents-read. + description: 'Get auto upgrade agent status

[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agent-policies-agentpolicyid-auto-upgrade-agents-status parameters: - in: path @@ -19678,14 +18734,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/{agentPolicyId}/copy: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}/copy
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Copy an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all. + description: 'Copy an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all.' operationId: post-fleet-agent-policies-agentpolicyid-copy parameters: - description: A required header to protect against CSRF attacks @@ -20385,14 +19434,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/{agentPolicyId}/download: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}/download
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Download an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-setup. + description: 'Download an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-setup.' operationId: get-fleet-agent-policies-agentpolicyid-download parameters: - in: path @@ -20466,14 +19508,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/{agentPolicyId}/full: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}/full
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a full agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-read. + description: 'Get a full agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-read.' operationId: get-fleet-agent-policies-agentpolicyid-full parameters: - in: path @@ -20917,14 +19952,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/{agentPolicyId}/outputs: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_policies/{agentPolicyId}/outputs
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of outputs associated with agent policy by policy id.

[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-settings-read. + description: 'Get a list of outputs associated with agent policy by policy id.

[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-settings-read.' operationId: get-fleet-agent-policies-agentpolicyid-outputs parameters: - in: path @@ -21024,14 +20052,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/delete: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agent_policies/delete
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all. + description: 'Delete an agent policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all.' operationId: post-fleet-agent-policies-delete parameters: - description: A required header to protect against CSRF attacks @@ -21095,14 +20116,7 @@ paths: - Elastic Agent policies /api/fleet/agent_policies/outputs: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agent_policies/outputs
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of outputs associated with agent policies.

[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-settings-read. + description: 'Get a list of outputs associated with agent policies.

[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-settings-read.' operationId: post-fleet-agent-policies-outputs parameters: - description: A required header to protect against CSRF attacks @@ -21313,22 +20327,9 @@ paths: summary: Get an agent status summary tags: - Elastic Agent status - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/fleet/agent_status/data: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agent_status/data
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agent-status-data parameters: - in: query @@ -21407,14 +20408,7 @@ paths: - Elastic Agents /api/fleet/agents: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agents
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agents parameters: - in: query @@ -21841,14 +20835,7 @@ paths: tags: - Elastic Agents post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: post-fleet-agents parameters: - description: A required header to protect against CSRF attacks @@ -21910,14 +20897,7 @@ paths: - Elastic Agents /api/fleet/agents/{agentId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/agents/{agentId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete an agent by ID.

[Required authorization] Route required privileges: fleet-agents-all. + description: 'Delete an agent by ID.

[Required authorization] Route required privileges: fleet-agents-all.' operationId: delete-fleet-agents-agentid parameters: - description: A required header to protect against CSRF attacks @@ -21970,14 +20950,7 @@ paths: tags: - Elastic Agents get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agents/{agentId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get an agent by ID.

[Required authorization] Route required privileges: fleet-agents-read. + description: 'Get an agent by ID.

[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agents-agentid parameters: - in: path @@ -22317,14 +21290,7 @@ paths: tags: - Elastic Agents put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/agents/{agentId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an agent by ID.

[Required authorization] Route required privileges: fleet-agents-all. + description: 'Update an agent by ID.

[Required authorization] Route required privileges: fleet-agents-all.' operationId: put-fleet-agents-agentid parameters: - description: A required header to protect against CSRF attacks @@ -22680,14 +21646,7 @@ paths: - Elastic Agents /api/fleet/agents/{agentId}/actions: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/{agentId}/actions
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-agentid-actions parameters: - description: A required header to protect against CSRF attacks @@ -22827,14 +21786,7 @@ paths: - Elastic Agent actions /api/fleet/agents/{agentId}/reassign: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/{agentId}/reassign
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-agentid-reassign parameters: - description: A required header to protect against CSRF attacks @@ -22893,14 +21845,7 @@ paths: - Elastic Agent actions /api/fleet/agents/{agentId}/request_diagnostics: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/{agentId}/request_diagnostics
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: post-fleet-agents-agentid-request-diagnostics parameters: - description: A required header to protect against CSRF attacks @@ -22966,14 +21911,7 @@ paths: - Elastic Agent actions /api/fleet/agents/{agentId}/unenroll: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/{agentId}/unenroll
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-agentid-unenroll parameters: - description: A required header to protect against CSRF attacks @@ -23006,14 +21944,7 @@ paths: - Elastic Agent actions /api/fleet/agents/{agentId}/upgrade: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/{agentId}/upgrade
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-agentid-upgrade parameters: - description: A required header to protect against CSRF attacks @@ -23078,14 +22009,7 @@ paths: - Elastic Agent actions /api/fleet/agents/{agentId}/uploads: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agents/{agentId}/uploads
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agents-agentid-uploads parameters: - in: path @@ -23162,14 +22086,7 @@ paths: - Elastic Agents /api/fleet/agents/action_status: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agents/action_status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agents-action-status parameters: - in: query @@ -23334,14 +22251,7 @@ paths: - Elastic Agent actions /api/fleet/agents/actions/{actionId}/cancel: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/actions/{actionId}/cancel
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-actions-actionid-cancel parameters: - description: A required header to protect against CSRF attacks @@ -23431,14 +22341,7 @@ paths: - Elastic Agent actions /api/fleet/agents/available_versions: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agents/available_versions
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agents-available-versions parameters: [] responses: @@ -23480,14 +22383,7 @@ paths: - Elastic Agents /api/fleet/agents/bulk_reassign: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/bulk_reassign
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-bulk-reassign parameters: - description: A required header to protect against CSRF attacks @@ -23557,14 +22453,7 @@ paths: - Elastic Agent actions /api/fleet/agents/bulk_request_diagnostics: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/bulk_request_diagnostics
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: post-fleet-agents-bulk-request-diagnostics parameters: - description: A required header to protect against CSRF attacks @@ -23634,14 +22523,7 @@ paths: - Elastic Agent actions /api/fleet/agents/bulk_unenroll: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/bulk_unenroll
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-bulk-unenroll parameters: - description: A required header to protect against CSRF attacks @@ -23716,14 +22598,7 @@ paths: - Elastic Agent actions /api/fleet/agents/bulk_update_agent_tags: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/bulk_update_agent_tags
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-bulk-update-agent-tags parameters: - description: A required header to protect against CSRF attacks @@ -23798,14 +22673,7 @@ paths: - Elastic Agent actions /api/fleet/agents/bulk_upgrade: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/bulk_upgrade
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-agents-bulk-upgrade parameters: - description: A required header to protect against CSRF attacks @@ -23886,14 +22754,7 @@ paths: - Elastic Agent actions /api/fleet/agents/files/{fileId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/agents/files/{fileId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a file uploaded by an agent.

[Required authorization] Route required privileges: fleet-agents-all. + description: 'Delete a file uploaded by an agent.

[Required authorization] Route required privileges: fleet-agents-all.' operationId: delete-fleet-agents-files-fileid parameters: - description: A required header to protect against CSRF attacks @@ -23948,14 +22809,7 @@ paths: - Elastic Agents /api/fleet/agents/files/{fileId}/{fileName}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agents/files/{fileId}/{fileName}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a file uploaded by an agent.

[Required authorization] Route required privileges: fleet-agents-read. + description: 'Get a file uploaded by an agent.

[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agents-files-fileid-filename parameters: - in: path @@ -23999,14 +22853,7 @@ paths: - Elastic Agents /api/fleet/agents/setup: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agents/setup
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read OR fleet-agent-policies-read OR fleet-settings-read OR fleet-setup. + description: '[Required authorization] Route required privileges: fleet-agents-read OR fleet-agent-policies-read OR fleet-settings-read OR fleet-setup.' operationId: get-fleet-agents-setup parameters: [] responses: @@ -24070,14 +22917,7 @@ paths: tags: - Elastic Agents post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/agents/setup
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read OR fleet-agent-policies-read OR fleet-settings-read OR fleet-setup. + description: '[Required authorization] Route required privileges: fleet-agents-read OR fleet-agent-policies-read OR fleet-settings-read OR fleet-setup.' operationId: post-fleet-agents-setup parameters: - description: A required header to protect against CSRF attacks @@ -24139,14 +22979,7 @@ paths: - Elastic Agents /api/fleet/agents/tags: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/agents/tags
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read. + description: '[Required authorization] Route required privileges: fleet-agents-read.' operationId: get-fleet-agents-tags parameters: - in: query @@ -24247,22 +23080,9 @@ paths: summary: Check permissions tags: - Fleet internals - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/check-permissions
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/fleet/data_streams: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/data_streams
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all AND fleet-agent-policies-all AND fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-agents-all AND fleet-agent-policies-all AND fleet-settings-all.' operationId: get-fleet-data-streams parameters: [] responses: @@ -24363,14 +23183,7 @@ paths: - Data streams /api/fleet/enrollment_api_keys: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/enrollment_api_keys
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all OR fleet-setup. + description: '[Required authorization] Route required privileges: fleet-agents-all OR fleet-setup.' operationId: get-fleet-enrollment-api-keys parameters: - in: query @@ -24501,14 +23314,7 @@ paths: tags: - Fleet enrollment API keys post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/enrollment_api_keys
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-enrollment-api-keys parameters: - description: A required header to protect against CSRF attacks @@ -24604,14 +23410,7 @@ paths: - Fleet enrollment API keys /api/fleet/enrollment_api_keys/{keyId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/enrollment_api_keys/{keyId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Revoke an enrollment API key by ID by marking it as inactive.

[Required authorization] Route required privileges: fleet-agents-all. + description: 'Revoke an enrollment API key by ID by marking it as inactive.

[Required authorization] Route required privileges: fleet-agents-all.' operationId: delete-fleet-enrollment-api-keys-keyid parameters: - description: A required header to protect against CSRF attacks @@ -24664,14 +23463,7 @@ paths: tags: - Fleet enrollment API keys get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/enrollment_api_keys/{keyId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get an enrollment API key by ID.

[Required authorization] Route required privileges: fleet-agents-all OR fleet-setup. + description: 'Get an enrollment API key by ID.

[Required authorization] Route required privileges: fleet-agents-all OR fleet-setup.' operationId: get-fleet-enrollment-api-keys-keyid parameters: - in: path @@ -24745,14 +23537,7 @@ paths: - Fleet enrollment API keys /api/fleet/epm/bulk_assets: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/bulk_assets
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: post-fleet-epm-bulk-assets parameters: - description: A required header to protect against CSRF attacks @@ -24847,14 +23632,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/categories: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/categories
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-categories parameters: - in: query @@ -24922,14 +23700,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/custom_integrations: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/custom_integrations
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: post-fleet-epm-custom-integrations parameters: - description: A required header to protect against CSRF attacks @@ -25073,14 +23844,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/custom_integrations/{pkgName}: put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/epm/custom_integrations/{pkgName}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all AND integrations-all. + description: '[Required authorization] Route required privileges: fleet-settings-all AND integrations-all.' operationId: put-fleet-epm-custom-integrations-pkgname parameters: - description: A required header to protect against CSRF attacks @@ -25137,14 +23901,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/data_streams: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/data_streams
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-data-streams parameters: - in: query @@ -25223,14 +23980,7 @@ paths: - Data streams /api/fleet/epm/packages: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/packages
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-packages parameters: - in: query @@ -25648,14 +24398,7 @@ paths: tags: - Elastic Package Manager (EPM) post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/packages
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: post-fleet-epm-packages parameters: - description: A required header to protect against CSRF attacks @@ -25784,14 +24527,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/_bulk: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/packages/_bulk
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: post-fleet-epm-packages-bulk parameters: - description: A required header to protect against CSRF attacks @@ -25972,14 +24708,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/_bulk_uninstall: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/packages/_bulk_uninstall
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: post-fleet-epm-packages-bulk-uninstall parameters: - description: A required header to protect against CSRF attacks @@ -26052,14 +24781,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/_bulk_uninstall/{taskId}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/packages/_bulk_uninstall/{taskId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: get-fleet-epm-packages-bulk-uninstall-taskid parameters: - in: path @@ -26133,14 +24855,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/_bulk_upgrade: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/packages/_bulk_upgrade
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: post-fleet-epm-packages-bulk-upgrade parameters: - description: A required header to protect against CSRF attacks @@ -26217,14 +24932,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/_bulk_upgrade/{taskId}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/packages/_bulk_upgrade/{taskId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: get-fleet-epm-packages-bulk-upgrade-taskid parameters: - in: path @@ -26298,14 +25006,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/{pkgName}/{pkgVersion}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: delete-fleet-epm-packages-pkgname-pkgversion parameters: - description: A required header to protect against CSRF attacks @@ -26909,21 +25610,8 @@ paths: summary: Get a package tags: - Elastic Package Manager (EPM) - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: post-fleet-epm-packages-pkgname-pkgversion parameters: - description: A required header to protect against CSRF attacks @@ -27074,14 +25762,7 @@ paths: tags: - Elastic Package Manager (EPM) put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: put-fleet-epm-packages-pkgname-pkgversion parameters: - description: A required header to protect against CSRF attacks @@ -27564,14 +26245,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/{filePath}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-packages-pkgname-pkgversion-filepath parameters: - in: path @@ -27619,14 +26293,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/{pkgName}/{pkgVersion}/datastream_assets: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/datastream_assets
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: delete-fleet-epm-packages-pkgname-pkgversion-datastream-assets parameters: - description: A required header to protect against CSRF attacks @@ -27688,14 +26355,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/{pkgName}/{pkgVersion}/kibana_assets: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/kibana_assets
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: delete-fleet-epm-packages-pkgname-pkgversion-kibana-assets parameters: - description: A required header to protect against CSRF attacks @@ -27751,14 +26411,7 @@ paths: tags: - Elastic Package Manager (EPM) post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/kibana_assets
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all. + description: '[Required authorization] Route required privileges: integrations-all AND fleet-agent-policies-all.' operationId: post-fleet-epm-packages-pkgname-pkgversion-kibana-assets parameters: - description: A required header to protect against CSRF attacks @@ -27917,22 +26570,9 @@ paths: summary: Authorize transforms tags: - Elastic Package Manager (EPM) - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/epm/packages/{pkgName}/{pkgVersion}/transforms/authorize
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/fleet/epm/packages/{pkgName}/stats: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/packages/{pkgName}/stats
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-packages-pkgname-stats parameters: - in: path @@ -27983,14 +26623,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/installed: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/packages/installed
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-packages-installed parameters: - in: query @@ -28140,14 +26773,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/packages/limited: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/packages/limited
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-packages-limited parameters: [] responses: @@ -28189,14 +26815,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/templates/{pkgName}/{pkgVersion}/inputs
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-templates-pkgname-pkgversion-inputs parameters: - in: path @@ -28300,14 +26919,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/epm/verification_key_id: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/epm/verification_key_id
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all. + description: '[Required authorization] Route required privileges: integrations-read OR fleet-setup OR fleet-all.' operationId: get-fleet-epm-verification-key-id parameters: [] responses: @@ -28348,14 +26960,7 @@ paths: - Elastic Package Manager (EPM) /api/fleet/fleet_server_hosts: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/fleet_server_hosts
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all OR fleet-settings-read. + description: '[Required authorization] Route required privileges: fleet-agents-all OR fleet-settings-read.' operationId: get-fleet-fleet-server-hosts parameters: [] responses: @@ -28486,14 +27091,7 @@ paths: tags: - Fleet Server hosts post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/fleet_server_hosts
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-settings-all.' operationId: post-fleet-fleet-server-hosts parameters: - description: A required header to protect against CSRF attacks @@ -28706,14 +27304,7 @@ paths: - Fleet Server hosts /api/fleet/fleet_server_hosts/{itemId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/fleet_server_hosts/{itemId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a Fleet Server host by ID.

[Required authorization] Route required privileges: fleet-settings-all. + description: 'Delete a Fleet Server host by ID.

[Required authorization] Route required privileges: fleet-settings-all.' operationId: delete-fleet-fleet-server-hosts-itemid parameters: - description: A required header to protect against CSRF attacks @@ -28764,14 +27355,7 @@ paths: tags: - Fleet Server hosts get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/fleet_server_hosts/{itemId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a Fleet Server host by ID.

[Required authorization] Route required privileges: fleet-settings-read. + description: 'Get a Fleet Server host by ID.

[Required authorization] Route required privileges: fleet-settings-read.' operationId: get-fleet-fleet-server-hosts-itemid parameters: - in: path @@ -28896,14 +27480,7 @@ paths: tags: - Fleet Server hosts put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/fleet_server_hosts/{itemId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update a Fleet Server host by ID.

[Required authorization] Route required privileges: fleet-settings-all. + description: 'Update a Fleet Server host by ID.

[Required authorization] Route required privileges: fleet-settings-all.' operationId: put-fleet-fleet-server-hosts-itemid parameters: - description: A required header to protect against CSRF attacks @@ -29114,14 +27691,7 @@ paths: - Fleet Server hosts /api/fleet/health_check: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/health_check
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-settings-all.' operationId: post-fleet-health-check parameters: - description: A required header to protect against CSRF attacks @@ -29203,14 +27773,7 @@ paths: - Fleet internals /api/fleet/kubernetes: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/kubernetes
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-setup. + description: '[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-setup.' operationId: get-fleet-kubernetes parameters: - in: query @@ -29265,14 +27828,7 @@ paths: - Elastic Agent policies /api/fleet/kubernetes/download: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/kubernetes/download
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-setup. + description: '[Required authorization] Route required privileges: fleet-agent-policies-read AND fleet-setup.' operationId: get-fleet-kubernetes-download parameters: - in: query @@ -29341,14 +27897,7 @@ paths: - Elastic Agent policies /api/fleet/logstash_api_keys: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/logstash_api_keys
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-settings-all.' operationId: post-fleet-logstash-api-keys parameters: - description: A required header to protect against CSRF attacks @@ -29395,14 +27944,7 @@ paths: - Fleet outputs /api/fleet/message_signing_service/rotate_key_pair: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/message_signing_service/rotate_key_pair
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all AND fleet-agent-policies-all AND fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-agents-all AND fleet-agent-policies-all AND fleet-settings-all.' operationId: post-fleet-message-signing-service-rotate-key-pair parameters: - description: A required header to protect against CSRF attacks @@ -29475,14 +28017,7 @@ paths: - Message Signing Service /api/fleet/outputs: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/outputs
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-read OR fleet-agent-policies-read. + description: '[Required authorization] Route required privileges: fleet-settings-read OR fleet-agent-policies-read.' operationId: get-fleet-outputs parameters: [] responses: @@ -30253,14 +28788,7 @@ paths: tags: - Fleet outputs post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/outputs
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-settings-all.' operationId: post-fleet-outputs parameters: - description: A required header to protect against CSRF attacks @@ -31754,14 +30282,7 @@ paths: - Fleet outputs /api/fleet/outputs/{outputId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/outputs/{outputId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete output by ID.

[Required authorization] Route required privileges: fleet-settings-all. + description: 'Delete output by ID.

[Required authorization] Route required privileges: fleet-settings-all.' operationId: delete-fleet-outputs-outputid parameters: - description: A required header to protect against CSRF attacks @@ -31832,14 +30353,7 @@ paths: tags: - Fleet outputs get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/outputs/{outputId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get output by ID.

[Required authorization] Route required privileges: fleet-settings-read OR fleet-agent-policies-read. + description: 'Get output by ID.

[Required authorization] Route required privileges: fleet-settings-read OR fleet-agent-policies-read.' operationId: get-fleet-outputs-outputid parameters: - in: path @@ -32604,14 +31118,7 @@ paths: tags: - Fleet outputs put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/outputs/{outputId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update output by ID.

[Required authorization] Route required privileges: fleet-settings-all OR fleet-agent-policies-all. + description: 'Update output by ID.

[Required authorization] Route required privileges: fleet-settings-all OR fleet-agent-policies-all.' operationId: put-fleet-outputs-outputid parameters: - description: A required header to protect against CSRF attacks @@ -34089,14 +32596,7 @@ paths: - Fleet outputs /api/fleet/outputs/{outputId}/health: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/outputs/{outputId}/health
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-read. + description: '[Required authorization] Route required privileges: fleet-settings-read.' operationId: get-fleet-outputs-outputid-health parameters: - in: path @@ -34623,12 +33123,6 @@ paths: summary: Get package policies tags: - Fleet package policies - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/package_policies
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: post-fleet-package-policies parameters: @@ -35500,12 +33994,6 @@ paths: summary: Create a package policy tags: - Fleet package policies - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/package_policies
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/fleet/package_policies/_bulk_get: post: operationId: post-fleet-package-policies-bulk-get @@ -35968,22 +34456,9 @@ paths: summary: Bulk get package policies tags: - Fleet package policies - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/package_policies/_bulk_get
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/fleet/package_policies/{packagePolicyId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/package_policies/{packagePolicyId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a package policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all. + description: 'Delete a package policy by ID.

[Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all.' operationId: delete-fleet-package-policies-packagepolicyid parameters: - description: A required header to protect against CSRF attacks @@ -36039,14 +34514,7 @@ paths: tags: - Fleet package policies get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/package_policies/{packagePolicyId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a package policy by ID. + description: Get a package policy by ID. operationId: get-fleet-package-policies-packagepolicyid parameters: - in: path @@ -36488,14 +34956,7 @@ paths: tags: - Fleet package policies put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/package_policies/{packagePolicyId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update a package policy by ID. + description: Update a package policy by ID. operationId: put-fleet-package-policies-packagepolicyid parameters: - description: A required header to protect against CSRF attacks @@ -37366,14 +35827,7 @@ paths: - Fleet package policies /api/fleet/package_policies/delete: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/package_policies/delete
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all. + description: '[Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all.' operationId: post-fleet-package-policies-delete parameters: - description: A required header to protect against CSRF attacks @@ -37506,14 +35960,7 @@ paths: - Fleet package policies /api/fleet/package_policies/upgrade: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/package_policies/upgrade
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Upgrade a package policy to a newer package version.

[Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all. + description: 'Upgrade a package policy to a newer package version.

[Required authorization] Route required privileges: fleet-agent-policies-all AND integrations-all.' operationId: post-fleet-package-policies-upgrade parameters: - description: A required header to protect against CSRF attacks @@ -37590,14 +36037,7 @@ paths: - Fleet package policies /api/fleet/package_policies/upgrade/dryrun: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/package_policies/upgrade/dryrun
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agent-policies-read AND integrations-read. + description: '[Required authorization] Route required privileges: fleet-agent-policies-read AND integrations-read.' operationId: post-fleet-package-policies-upgrade-dryrun parameters: - description: A required header to protect against CSRF attacks @@ -38441,14 +36881,7 @@ paths: - Fleet package policies /api/fleet/proxies: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/proxies
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-read. + description: '[Required authorization] Route required privileges: fleet-settings-read.' operationId: get-fleet-proxies parameters: [] responses: @@ -38530,14 +36963,7 @@ paths: tags: - Fleet proxies post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/proxies
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-settings-all.' operationId: post-fleet-proxies parameters: - description: A required header to protect against CSRF attacks @@ -38652,14 +37078,7 @@ paths: - Fleet proxies /api/fleet/proxies/{itemId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/fleet/proxies/{itemId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a proxy by ID

[Required authorization] Route required privileges: fleet-settings-all. + description: 'Delete a proxy by ID

[Required authorization] Route required privileges: fleet-settings-all.' operationId: delete-fleet-proxies-itemid parameters: - description: A required header to protect against CSRF attacks @@ -38710,14 +37129,7 @@ paths: tags: - Fleet proxies get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/proxies/{itemId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a proxy by ID.

[Required authorization] Route required privileges: fleet-settings-read. + description: 'Get a proxy by ID.

[Required authorization] Route required privileges: fleet-settings-read.' operationId: get-fleet-proxies-itemid parameters: - in: path @@ -38793,14 +37205,7 @@ paths: tags: - Fleet proxies put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/proxies/{itemId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update a proxy by ID.

[Required authorization] Route required privileges: fleet-settings-all. + description: 'Update a proxy by ID.

[Required authorization] Route required privileges: fleet-settings-all.' operationId: put-fleet-proxies-itemid parameters: - description: A required header to protect against CSRF attacks @@ -38917,14 +37322,7 @@ paths: - Fleet proxies /api/fleet/remote_synced_integrations/{outputId}/remote_status: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/remote_synced_integrations/{outputId}/remote_status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-read AND integrations-read. + description: '[Required authorization] Route required privileges: fleet-settings-read AND integrations-read.' operationId: get-fleet-remote-synced-integrations-outputid-remote-status parameters: - in: path @@ -39056,14 +37454,7 @@ paths: - CCR Remote synced integrations /api/fleet/remote_synced_integrations/status: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/remote_synced_integrations/status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-read AND integrations-read. + description: '[Required authorization] Route required privileges: fleet-settings-read AND integrations-read.' operationId: get-fleet-remote-synced-integrations-status parameters: [] responses: @@ -39190,14 +37581,7 @@ paths: - CCR Remote synced integrations /api/fleet/service_tokens: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/service_tokens
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-all. + description: '[Required authorization] Route required privileges: fleet-agents-all.' operationId: post-fleet-service-tokens parameters: - description: A required header to protect against CSRF attacks @@ -39258,14 +37642,7 @@ paths: - Fleet service tokens /api/fleet/settings: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/settings
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-read. + description: '[Required authorization] Route required privileges: fleet-settings-read.' operationId: get-fleet-settings parameters: [] responses: @@ -39357,14 +37734,7 @@ paths: tags: - Fleet internals put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/settings
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-settings-all.' operationId: put-fleet-settings parameters: - description: A required header to protect against CSRF attacks @@ -39495,14 +37865,7 @@ paths: - Fleet internals /api/fleet/setup: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/fleet/setup
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-agents-read OR fleet-agent-policies-read OR fleet-settings-read OR fleet-setup. + description: '[Required authorization] Route required privileges: fleet-agents-read OR fleet-agent-policies-read OR fleet-settings-read OR fleet-setup.' operationId: post-fleet-setup parameters: - description: A required header to protect against CSRF attacks @@ -39603,21 +37966,8 @@ paths: summary: Get space settings tags: [] x-state: Generally available - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/space_settings
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/fleet/space_settings
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: fleet-settings-all. + description: '[Required authorization] Route required privileges: fleet-settings-all.' operationId: put-fleet-space-settings parameters: - description: A required header to protect against CSRF attacks @@ -39665,14 +38015,7 @@ paths: x-state: Generally available /api/fleet/uninstall_tokens: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/uninstall_tokens
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - List the metadata for the latest uninstall tokens per agent policy.

[Required authorization] Route required privileges: fleet-agents-all. + description: 'List the metadata for the latest uninstall tokens per agent policy.

[Required authorization] Route required privileges: fleet-agents-all.' operationId: get-fleet-uninstall-tokens parameters: - description: Partial match filtering for policy IDs @@ -39768,14 +38111,7 @@ paths: - Fleet uninstall tokens /api/fleet/uninstall_tokens/{uninstallTokenId}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/fleet/uninstall_tokens/{uninstallTokenId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get one decrypted uninstall token by its ID.

[Required authorization] Route required privileges: fleet-agents-all. + description: 'Get one decrypted uninstall token by its ID.

[Required authorization] Route required privileges: fleet-agents-all.' operationId: get-fleet-uninstall-tokens-uninstalltokenid parameters: - in: path @@ -39843,12 +38179,6 @@ paths: /api/lists: delete: description: | - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Delete a value list using the list ID. > info > When you delete a list, all of its list items are also deleted. @@ -39962,14 +38292,7 @@ paths: tags: - Security Lists API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of a value list using the list ID. + description: Get the details of a value list using the list ID. operationId: ReadList parameters: - in: query @@ -40064,14 +38387,7 @@ paths: tags: - Security Lists API patch: - description: |- - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update specific fields of an existing list using the list `id`. + description: Update specific fields of an existing list using the list `id`. operationId: PatchList requestBody: content: @@ -40185,14 +38501,7 @@ paths: tags: - Security Lists API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a new value list. + description: Create a new value list. operationId: CreateList requestBody: content: @@ -40385,12 +38694,6 @@ paths: - Security Lists API put: description: | - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/lists
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Update a value list using the list `id`. The original list is replaced, and all unspecified fields are deleted. > info > You cannot modify the `id` value. @@ -40511,14 +38814,7 @@ paths: - Security Lists API /api/lists/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/lists/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a paginated subset of value lists. By default, the first page is returned, with 20 results per page. + description: Get a paginated subset of value lists. By default, the first page is returned, with 20 results per page. operationId: FindLists parameters: - description: The page number to return. @@ -40675,14 +38971,7 @@ paths: - Security Lists API /api/lists/index: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/lists/index
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete the `.lists` and `.items` data streams. + description: Delete the `.lists` and `.items` data streams. operationId: DeleteListIndex responses: '200': @@ -40743,14 +39032,7 @@ paths: tags: - Security Lists API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/lists/index
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Verify that `.lists` and `.items` data streams exist. + description: Verify that `.lists` and `.items` data streams exist. operationId: ReadListIndex responses: '200': @@ -40814,14 +39096,7 @@ paths: tags: - Security Lists API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/lists/index
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create `.lists` and `.items` data streams in the relevant space. + description: Create `.lists` and `.items` data streams in the relevant space. operationId: CreateListIndex responses: '200': @@ -40889,14 +39164,7 @@ paths: - Security Lists API /api/lists/items: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a value list item using its `id`, or its `list_id` and `value` fields. + description: Delete a value list item using its `id`, or its `list_id` and `value` fields. operationId: DeleteListItem parameters: - description: Value list item's identifier. Required if `list_id` and `value` are not specified. @@ -41018,14 +39286,7 @@ paths: tags: - Security Lists API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of a value list item. + description: Get the details of a value list item. operationId: ReadListItem parameters: - description: Value list item identifier. Required if `list_id` and `value` are not specified. @@ -41135,14 +39396,7 @@ paths: tags: - Security Lists API patch: - description: |- - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update specific fields of an existing value list item using the item `id`. + description: Update specific fields of an existing value list item using the item `id`. operationId: PatchListItem requestBody: content: @@ -41257,12 +39511,6 @@ paths: - Security Lists API post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create a value list item and associate it with the specified value list. All value list items in the same list must be the same type. For example, each list item in an `ip` list must define a specific IP address. @@ -41432,12 +39680,6 @@ paths: - Security Lists API put: description: | - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/lists/items
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Update a value list item using the list item ID. The original list item is replaced, and all unspecified fields are deleted. > info > You cannot modify the `id` value. @@ -41550,14 +39792,7 @@ paths: - Security Lists API /api/lists/items/_export: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/lists/items/_export
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Export list item values from the specified value list. + description: Export list item values from the specified value list. operationId: ExportListItems parameters: - description: Value list's `id` to export. @@ -41644,14 +39879,7 @@ paths: - Security Lists API /api/lists/items/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/lists/items/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get all value list items in the specified list. + description: Get all value list items in the specified list. operationId: FindListItems parameters: - in: query @@ -41808,12 +40036,6 @@ paths: /api/lists/items/_import: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/lists/items/_import
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Import value list items from a TXT or CSV file. The maximum file size is 9 million bytes. You can import items to a new or existing list. @@ -42110,22 +40332,9 @@ paths: summary: Get value list privileges tags: - Security Lists API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/lists/privileges
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/maintenance_window: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/maintenance_window
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: write-maintenance-window. + description: '[Required authorization] Route required privileges: write-maintenance-window.' operationId: post-maintenance-window parameters: - description: A required header to protect against CSRF attacks @@ -42361,14 +40570,7 @@ paths: x-state: Generally available /api/maintenance_window/{id}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/maintenance_window/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: write-maintenance-window. + description: '[Required authorization] Route required privileges: write-maintenance-window.' operationId: delete-maintenance-window-id parameters: - description: A required header to protect against CSRF attacks @@ -42398,14 +40600,7 @@ paths: - maintenance-window x-state: Generally available get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/maintenance_window/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: read-maintenance-window. + description: '[Required authorization] Route required privileges: read-maintenance-window.' operationId: get-maintenance-window-id parameters: - description: The identifier for the maintenance window. @@ -42546,14 +40741,7 @@ paths: - maintenance-window x-state: Generally available patch: - description: |- - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/maintenance_window/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: write-maintenance-window. + description: '[Required authorization] Route required privileges: write-maintenance-window.' operationId: patch-maintenance-window-id parameters: - description: A required header to protect against CSRF attacks @@ -42795,14 +40983,7 @@ paths: x-state: Generally available /api/maintenance_window/{id}/_archive: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/maintenance_window/{id}/_archive
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: write-maintenance-window. + description: '[Required authorization] Route required privileges: write-maintenance-window.' operationId: post-maintenance-window-id-archive parameters: - description: A required header to protect against CSRF attacks @@ -42951,14 +41132,7 @@ paths: x-state: Generally available /api/maintenance_window/{id}/_unarchive: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/maintenance_window/{id}/_unarchive
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - [Required authorization] Route required privileges: write-maintenance-window. + description: '[Required authorization] Route required privileges: write-maintenance-window.' operationId: post-maintenance-window-id-unarchive parameters: - description: A required header to protect against CSRF attacks @@ -43108,12 +41282,6 @@ paths: /api/ml/saved_objects/sync: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/ml/saved_objects/sync
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Synchronizes Kibana saved objects for machine learning jobs and trained models. This API runs automatically when you start Kibana and periodically thereafter. operationId: mlSync parameters: @@ -43139,14 +41307,7 @@ paths: - ml /api/note: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/note
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a note from a Timeline using the note ID. + description: Delete a note from a Timeline using the note ID. operationId: DeleteNote requestBody: content: @@ -43179,14 +41340,7 @@ paths: tags: - Security Timeline API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/note
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get all notes for a given document. + description: Get all notes for a given document. operationId: GetNotes parameters: - in: query @@ -43247,14 +41401,7 @@ paths: tags: - Security Timeline API patch: - description: |- - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/note
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Add a note to a Timeline or update an existing note. + description: Add a note to a Timeline or update an existing note. operationId: PersistNoteRoute requestBody: content: @@ -43292,12 +41439,6 @@ paths: /api/observability_ai_assistant/chat/complete: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/observability_ai_assistant/chat/complete
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create a new chat completion by using the Observability AI Assistant. The API returns the model's response based on the current conversation context. @@ -43398,14 +41539,7 @@ paths: x-state: Technical Preview /api/osquery/live_queries: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/osquery/live_queries
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all live queries. + description: Get a list of all live queries. operationId: OsqueryFindLiveQueries parameters: - in: query @@ -43444,14 +41578,7 @@ paths: tags: - Security Osquery API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/osquery/live_queries
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create and run a live query. + description: Create and run a live query. operationId: OsqueryCreateLiveQuery requestBody: content: @@ -43471,14 +41598,7 @@ paths: - Security Osquery API /api/osquery/live_queries/{id}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/osquery/live_queries/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of a live query using the query ID. + description: Get the details of a live query using the query ID. operationId: OsqueryGetLiveQueryDetails parameters: - in: path @@ -43500,14 +41620,7 @@ paths: - Security Osquery API /api/osquery/live_queries/{id}/results/{actionId}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/osquery/live_queries/{id}/results/{actionId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the results of a live query using the query action ID. + description: Get the results of a live query using the query action ID. operationId: OsqueryGetLiveQueryResults parameters: - in: path @@ -43561,14 +41674,7 @@ paths: - Security Osquery API /api/osquery/packs: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/osquery/packs
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all query packs. + description: Get a list of all query packs. operationId: OsqueryFindPacks parameters: - in: query @@ -43602,14 +41708,7 @@ paths: tags: - Security Osquery API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/osquery/packs
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a query pack. + description: Create a query pack. operationId: OsqueryCreatePacks requestBody: content: @@ -43629,14 +41728,7 @@ paths: - Security Osquery API /api/osquery/packs/{id}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/osquery/packs/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a query pack using the pack ID. + description: Delete a query pack using the pack ID. operationId: OsqueryDeletePacks parameters: - in: path @@ -43657,14 +41749,7 @@ paths: tags: - Security Osquery API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/osquery/packs/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of a query pack using the pack ID. + description: Get the details of a query pack using the pack ID. operationId: OsqueryGetPacksDetails parameters: - in: path @@ -43684,12 +41769,6 @@ paths: - Security Osquery API put: description: | - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/osquery/packs/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Update a query pack using the pack ID. > info > You cannot update a prebuilt pack. @@ -43718,14 +41797,7 @@ paths: - Security Osquery API /api/osquery/saved_queries: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/osquery/saved_queries
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all saved queries. + description: Get a list of all saved queries. operationId: OsqueryFindSavedQueries parameters: - in: query @@ -43759,14 +41831,7 @@ paths: tags: - Security Osquery API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/osquery/saved_queries
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create and run a saved query. + description: Create and run a saved query. operationId: OsqueryCreateSavedQuery requestBody: content: @@ -43786,14 +41851,7 @@ paths: - Security Osquery API /api/osquery/saved_queries/{id}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/osquery/saved_queries/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a saved query using the query ID. + description: Delete a saved query using the query ID. operationId: OsqueryDeleteSavedQuery parameters: - in: path @@ -43812,14 +41870,7 @@ paths: tags: - Security Osquery API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/osquery/saved_queries/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of a saved query using the query ID. + description: Get the details of a saved query using the query ID. operationId: OsqueryGetSavedQueryDetails parameters: - in: path @@ -43839,12 +41890,6 @@ paths: - Security Osquery API put: description: | - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/osquery/saved_queries/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Update a saved query using the query ID. > info > You cannot update a prebuilt saved query. @@ -43873,14 +41918,7 @@ paths: - Security Osquery API /api/pinned_event: patch: - description: |- - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/pinned_event
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Pin/unpin an event to/from an existing Timeline. + description: Pin/unpin an event to/from an existing Timeline. operationId: PersistPinnedEventRoute requestBody: content: @@ -43918,14 +41956,7 @@ paths: - Security Timeline API /api/risk_score/engine/dangerously_delete_data: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/risk_score/engine/dangerously_delete_data
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Cleaning up the the Risk Engine by removing the indices, mapping and transforms + description: Cleaning up the the Risk Engine by removing the indices, mapping and transforms operationId: CleanUpRiskEngine responses: '200': @@ -43954,14 +41985,7 @@ paths: - Security Entity Analytics API /api/risk_score/engine/saved_object/configure: patch: - description: |- - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/risk_score/engine/saved_object/configure
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Configuring the Risk Engine Saved Object + description: Configuring the Risk Engine Saved Object operationId: ConfigureRiskEngineSavedObject requestBody: content: @@ -44012,14 +42036,7 @@ paths: - Security Entity Analytics API /api/risk_score/engine/schedule_now: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/risk_score/engine/schedule_now
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Schedule the risk scoring engine to run as soon as possible. You can use this to recalculate entity risk scores after updating their asset criticality. + description: Schedule the risk scoring engine to run as soon as possible. You can use this to recalculate entity risk scores after updating their asset criticality. operationId: ScheduleRiskEngineNow requestBody: content: @@ -44049,12 +42066,6 @@ paths: /api/saved_objects/_export: post: description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/saved_objects/_export
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Retrieve sets of saved objects that you want to import into Kibana. You must include `type` or `objects` in the request body. The output of exporting saved objects must be treated as opaque. Tampering with exported data risks introducing unspecified errors and data loss. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana. @@ -44203,12 +42214,6 @@ paths: /api/saved_objects/_import: post: description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/saved_objects/_import
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Tampering with exported data risks introducing unspecified errors and data loss. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana. @@ -44346,14 +42351,7 @@ paths: --form file=@file.ndjson /api/security_ai_assistant/anonymization_fields/_bulk_action: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security_ai_assistant/anonymization_fields/_bulk_action
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Apply a bulk action to multiple anonymization fields. The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs. + description: Apply a bulk action to multiple anonymization fields. The bulk action is applied to all anonymization fields that match the filter or to the list of anonymization fields by their IDs. operationId: PerformAnonymizationFieldsBulkAction requestBody: content: @@ -44480,14 +42478,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/anonymization_fields/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security_ai_assistant/anonymization_fields/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all anonymization fields. + description: Get a list of all anonymization fields. operationId: FindAnonymizationFields parameters: - description: Fields to return @@ -44659,14 +42650,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/chat/complete: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security_ai_assistant/chat/complete
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a model response for the given chat conversation. + description: Create a model response for the given chat conversation. operationId: ChatComplete parameters: - description: If true, the response will not include content references. @@ -44733,14 +42717,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/current_user/conversations: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/security_ai_assistant/current_user/conversations
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - This endpoint allows users to permanently delete all conversations. + description: This endpoint allows users to permanently delete all conversations. operationId: DeleteAllConversations requestBody: content: @@ -44797,14 +42774,7 @@ paths: tags: - Security AI Assistant API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security_ai_assistant/current_user/conversations
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a new Security AI Assistant conversation. This endpoint allows the user to initiate a conversation with the Security AI Assistant by providing the required parameters. + description: Create a new Security AI Assistant conversation. This endpoint allows the user to initiate a conversation with the Security AI Assistant by providing the required parameters. operationId: CreateConversation requestBody: content: @@ -44870,14 +42840,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/current_user/conversations/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security_ai_assistant/current_user/conversations/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all conversations for the current user. This endpoint allows users to search, filter, sort, and paginate through their conversations. + description: Get a list of all conversations for the current user. This endpoint allows users to search, filter, sort, and paginate through their conversations. operationId: FindConversations parameters: - description: A list of fields to include in the response. If omitted, all fields are returned. @@ -44982,14 +42945,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/current_user/conversations/{id}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/security_ai_assistant/current_user/conversations/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete an existing conversation using the conversation ID. This endpoint allows users to permanently delete a conversation. + description: Delete an existing conversation using the conversation ID. This endpoint allows users to permanently delete a conversation. operationId: DeleteConversation parameters: - description: The conversation's `id` value. @@ -45044,14 +43000,7 @@ paths: tags: - Security AI Assistant API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security_ai_assistant/current_user/conversations/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of an existing conversation using the conversation ID. This allows users to fetch the specific conversation data by its unique ID. + description: Get the details of an existing conversation using the conversation ID. This allows users to fetch the specific conversation data by its unique ID. operationId: ReadConversation parameters: - description: The conversation's `id` value, a unique identifier for the conversation. @@ -45106,14 +43055,7 @@ paths: tags: - Security AI Assistant API put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/security_ai_assistant/current_user/conversations/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an existing conversation using the conversation ID. This endpoint allows users to modify the details of an existing conversation. + description: Update an existing conversation using the conversation ID. This endpoint allows users to modify the details of an existing conversation. operationId: UpdateConversation parameters: - description: The conversation's `id` value. @@ -45187,14 +43129,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/knowledge_base/{resource}: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security_ai_assistant/knowledge_base/{resource}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Read a single KB + description: Read a single KB operationId: ReadKnowledgeBase parameters: - description: The KnowledgeBase `resource` value. @@ -45258,14 +43193,7 @@ paths: tags: - Security AI Assistant API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security_ai_assistant/knowledge_base/{resource}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a KnowledgeBase + description: Create a KnowledgeBase operationId: CreateKnowledgeBase parameters: - description: The KnowledgeBase `resource` value. @@ -45320,14 +43248,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/knowledge_base/entries: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security_ai_assistant/knowledge_base/entries
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a Knowledge Base Entry + description: Create a Knowledge Base Entry operationId: CreateKnowledgeBaseEntry requestBody: content: @@ -45371,14 +43292,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/knowledge_base/entries/_bulk_action: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security_ai_assistant/knowledge_base/entries/_bulk_action
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - The bulk action is applied to all Knowledge Base Entries that match the filter or to the list of Knowledge Base Entries by their IDs. + description: The bulk action is applied to all Knowledge Base Entries that match the filter or to the list of Knowledge Base Entries by their IDs. operationId: PerformKnowledgeBaseEntryBulkAction requestBody: content: @@ -45438,14 +43352,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/knowledge_base/entries/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security_ai_assistant/knowledge_base/entries/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Finds Knowledge Base Entries that match the given query. + description: Finds Knowledge Base Entries that match the given query. operationId: FindKnowledgeBaseEntries parameters: - description: A list of fields to include in the response. If not provided, all fields will be included. @@ -45552,14 +43459,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/knowledge_base/entries/{id}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/security_ai_assistant/knowledge_base/entries/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete a Knowledge Base Entry by its unique `id`. + description: Delete a Knowledge Base Entry by its unique `id`. operationId: DeleteKnowledgeBaseEntry parameters: - description: The unique identifier (`id`) of the Knowledge Base Entry to delete. @@ -45592,14 +43492,7 @@ paths: tags: - Security AI Assistant API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security_ai_assistant/knowledge_base/entries/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Retrieve a Knowledge Base Entry by its unique `id`. + description: Retrieve a Knowledge Base Entry by its unique `id`. operationId: ReadKnowledgeBaseEntry parameters: - description: The unique identifier (`id`) of the Knowledge Base Entry to retrieve. @@ -45637,14 +43530,7 @@ paths: tags: - Security AI Assistant API put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/security_ai_assistant/knowledge_base/entries/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an existing Knowledge Base Entry by its unique `id`. + description: Update an existing Knowledge Base Entry by its unique `id`. operationId: UpdateKnowledgeBaseEntry parameters: - description: The unique identifier (`id`) of the Knowledge Base Entry to update. @@ -45698,14 +43584,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/prompts/_bulk_action: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security_ai_assistant/prompts/_bulk_action
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Apply a bulk action to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs. This action allows for bulk create, update, or delete operations. + description: Apply a bulk action to multiple prompts. The bulk action is applied to all prompts that match the filter or to the list of prompts by their IDs. This action allows for bulk create, update, or delete operations. operationId: PerformPromptsBulkAction requestBody: content: @@ -45815,14 +43694,7 @@ paths: - Security AI Assistant API /api/security_ai_assistant/prompts/_find: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security_ai_assistant/prompts/_find
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all prompts based on optional filters, sorting, and pagination. + description: Get a list of all prompts based on optional filters, sorting, and pagination. operationId: FindPrompts parameters: - description: List of specific fields to include in each returned prompt. @@ -45967,12 +43839,6 @@ paths: summary: Get all roles tags: - roles - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security/role
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/security/role/_query: post: operationId: post-security-role-query @@ -46022,12 +43888,6 @@ paths: description: Indicates a successful call. summary: Query roles tags: [] - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security/role/_query
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/security/role/{name}: delete: operationId: delete-security-role-name @@ -46051,12 +43911,6 @@ paths: summary: Delete a role tags: - roles - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/security/role/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. get: operationId: get-security-role-name parameters: @@ -46079,21 +43933,8 @@ paths: summary: Get a role tags: - roles - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security/role/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/security/role/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm. + description: Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm. operationId: put-security-role-name parameters: - description: A required header to protect against CSRF attacks @@ -46497,12 +44338,6 @@ paths: summary: Create or update roles tags: - roles - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security/roles
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/spaces/space: get: operationId: get-spaces-space @@ -46550,12 +44385,6 @@ paths: summary: Get all spaces tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/spaces/space
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: post-spaces-space parameters: @@ -46613,22 +44442,9 @@ paths: summary: Create a space tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/spaces/space
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/spaces/space/{id}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/spaces/space/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone. + description: When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone. operationId: delete-spaces-space-id parameters: - description: A required header to protect against CSRF attacks @@ -46672,12 +44488,6 @@ paths: summary: Get a space tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/spaces/space/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: operationId: put-spaces-space-id parameters: @@ -46741,12 +44551,6 @@ paths: summary: Update a space tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/spaces/space/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/status: get: operationId: get-status @@ -46785,22 +44589,9 @@ paths: summary: Get Kibana's current status tags: - system - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/streams: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/streams
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Fetches list of all streams

[Required authorization] Route required privileges: read_stream. + description: 'Fetches list of all streams

[Required authorization] Route required privileges: read_stream.' operationId: get-streams parameters: [] requestBody: @@ -46822,14 +44613,7 @@ paths: x-state: Technical Preview /api/streams/_disable: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/_disable
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Disables wired streams and deletes all existing stream definitions. The data of wired streams is deleted, but the data of classic streams is preserved.

[Required authorization] Route required privileges: manage_stream. + description: 'Disables wired streams and deletes all existing stream definitions. The data of wired streams is deleted, but the data of classic streams is preserved.

[Required authorization] Route required privileges: manage_stream.' operationId: post-streams-disable parameters: - description: A required header to protect against CSRF attacks @@ -46858,14 +44642,7 @@ paths: x-state: Technical Preview /api/streams/_enable: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/_enable
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Enables wired streams

[Required authorization] Route required privileges: manage_stream. + description: 'Enables wired streams

[Required authorization] Route required privileges: manage_stream.' operationId: post-streams-enable parameters: - description: A required header to protect against CSRF attacks @@ -46894,14 +44671,7 @@ paths: x-state: Technical Preview /api/streams/_resync: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/_resync
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Resyncs all streams, making sure that Elasticsearch assets are up to date

[Required authorization] Route required privileges: manage_stream. + description: 'Resyncs all streams, making sure that Elasticsearch assets are up to date

[Required authorization] Route required privileges: manage_stream.' operationId: post-streams-resync parameters: - description: A required header to protect against CSRF attacks @@ -46930,14 +44700,7 @@ paths: x-state: Technical Preview /api/streams/{name}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/streams/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Deletes a stream definition and the underlying data stream

[Required authorization] Route required privileges: manage_stream. + description: 'Deletes a stream definition and the underlying data stream

[Required authorization] Route required privileges: manage_stream.' operationId: delete-streams-name parameters: - description: A required header to protect against CSRF attacks @@ -46970,14 +44733,7 @@ paths: - streams x-state: Technical Preview get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/streams/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Fetches a stream definition and associated dashboards

[Required authorization] Route required privileges: read_stream. + description: 'Fetches a stream definition and associated dashboards

[Required authorization] Route required privileges: read_stream.' operationId: get-streams-name parameters: - in: path @@ -47003,14 +44759,7 @@ paths: - streams x-state: Technical Preview put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/streams/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Creates or updates a stream definition. Classic streams can not be created through this API, only updated

[Required authorization] Route required privileges: manage_stream. + description: 'Creates or updates a stream definition. Classic streams can not be created through this API, only updated

[Required authorization] Route required privileges: manage_stream.' operationId: put-streams-name parameters: - description: A required header to protect against CSRF attacks @@ -51969,14 +49718,7 @@ paths: x-state: Technical Preview /api/streams/{name}/_fork: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/{name}/_fork
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Forks a wired stream and creates a child stream

[Required authorization] Route required privileges: manage_stream. + description: 'Forks a wired stream and creates a child stream

[Required authorization] Route required privileges: manage_stream.' operationId: post-streams-name-fork parameters: - description: A required header to protect against CSRF attacks @@ -52094,14 +49836,7 @@ paths: x-state: Technical Preview /api/streams/{name}/_group: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/streams/{name}/_group
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Fetches the group settings of a group stream definition

[Required authorization] Route required privileges: read_stream. + description: 'Fetches the group settings of a group stream definition

[Required authorization] Route required privileges: read_stream.' operationId: get-streams-name-group parameters: - in: path @@ -52127,14 +49862,7 @@ paths: - streams x-state: Technical Preview put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/streams/{name}/_group
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Upserts the group settings of a group stream definition

[Required authorization] Route required privileges: manage_stream. + description: 'Upserts the group settings of a group stream definition

[Required authorization] Route required privileges: manage_stream.' operationId: put-streams-name-group parameters: - description: A required header to protect against CSRF attacks @@ -52175,14 +49903,7 @@ paths: x-state: Technical Preview /api/streams/{name}/_ingest: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/streams/{name}/_ingest
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Fetches the ingest settings of an ingest stream definition

[Required authorization] Route required privileges: read_stream. + description: 'Fetches the ingest settings of an ingest stream definition

[Required authorization] Route required privileges: read_stream.' operationId: get-streams-name-ingest parameters: - in: path @@ -52208,14 +49929,7 @@ paths: - streams x-state: Technical Preview put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/streams/{name}/_ingest
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Upserts the ingest settings of an ingest stream definition

[Required authorization] Route required privileges: manage_stream. + description: 'Upserts the ingest settings of an ingest stream definition

[Required authorization] Route required privileges: manage_stream.' operationId: put-streams-name-ingest parameters: - description: A required header to protect against CSRF attacks @@ -54577,14 +52291,7 @@ paths: x-state: Technical Preview /api/streams/{name}/content/export: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/{name}/content/export
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Exports the content associated to a stream.

[Required authorization] Route required privileges: manage_stream. + description: 'Exports the content associated to a stream.

[Required authorization] Route required privileges: manage_stream.' operationId: post-streams-name-content-export parameters: - description: A required header to protect against CSRF attacks @@ -54673,14 +52380,7 @@ paths: - streams /api/streams/{name}/content/import: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/{name}/content/import
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Links content objects to a stream.

[Required authorization] Route required privileges: manage_stream. + description: 'Links content objects to a stream.

[Required authorization] Route required privileges: manage_stream.' operationId: post-streams-name-content-import parameters: - description: A required header to protect against CSRF attacks @@ -54714,14 +52414,7 @@ paths: - streams /api/streams/{name}/dashboards: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/streams/{name}/dashboards
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Fetches all dashboards linked to a stream that are visible to the current user in the current space.

[Required authorization] Route required privileges: read_stream. + description: 'Fetches all dashboards linked to a stream that are visible to the current user in the current space.

[Required authorization] Route required privileges: read_stream.' operationId: get-streams-name-dashboards parameters: - in: path @@ -54748,14 +52441,7 @@ paths: x-state: Technical Preview /api/streams/{name}/dashboards/_bulk: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/{name}/dashboards/_bulk
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Bulk update dashboards linked to a stream. Can link new dashboards and delete existing ones.

[Required authorization] Route required privileges: manage_stream. + description: 'Bulk update dashboards linked to a stream. Can link new dashboards and delete existing ones.

[Required authorization] Route required privileges: manage_stream.' operationId: post-streams-name-dashboards-bulk parameters: - description: A required header to protect against CSRF attacks @@ -54816,14 +52502,7 @@ paths: x-state: Technical Preview /api/streams/{name}/dashboards/{dashboardId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/streams/{name}/dashboards/{dashboardId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Unlinks a dashboard from a stream. Noop if the dashboard is not linked to the stream.

[Required authorization] Route required privileges: manage_stream. + description: 'Unlinks a dashboard from a stream. Noop if the dashboard is not linked to the stream.

[Required authorization] Route required privileges: manage_stream.' operationId: delete-streams-name-dashboards-dashboardid parameters: - description: A required header to protect against CSRF attacks @@ -54861,14 +52540,7 @@ paths: - streams x-state: Technical Preview put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/streams/{name}/dashboards/{dashboardId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Links a dashboard to a stream. Noop if the dashboard is already linked to the stream.

[Required authorization] Route required privileges: manage_stream. + description: 'Links a dashboard to a stream. Noop if the dashboard is already linked to the stream.

[Required authorization] Route required privileges: manage_stream.' operationId: put-streams-name-dashboards-dashboardid parameters: - description: A required header to protect against CSRF attacks @@ -54907,14 +52579,7 @@ paths: x-state: Technical Preview /api/streams/{name}/queries: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/streams/{name}/queries
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Fetches all queries linked to a stream that are visible to the current user in the current space.

[Required authorization] Route required privileges: read_stream. + description: 'Fetches all queries linked to a stream that are visible to the current user in the current space.

[Required authorization] Route required privileges: read_stream.' operationId: get-streams-name-queries parameters: - in: path @@ -54941,14 +52606,7 @@ paths: x-state: Technical Preview /api/streams/{name}/queries/_bulk: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/{name}/queries/_bulk
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Bulk update queries of a stream. Can add new queries and delete existing ones.

[Required authorization] Route required privileges: manage_stream. + description: 'Bulk update queries of a stream. Can add new queries and delete existing ones.

[Required authorization] Route required privileges: manage_stream.' operationId: post-streams-name-queries-bulk parameters: - description: A required header to protect against CSRF attacks @@ -55026,14 +52684,7 @@ paths: x-state: Technical Preview /api/streams/{name}/queries/{queryId}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/streams/{name}/queries/{queryId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Remove a query from a stream. Noop if the query is not found on the stream.

[Required authorization] Route required privileges: manage_stream. + description: 'Remove a query from a stream. Noop if the query is not found on the stream.

[Required authorization] Route required privileges: manage_stream.' operationId: delete-streams-name-queries-queryid parameters: - description: A required header to protect against CSRF attacks @@ -55071,14 +52722,7 @@ paths: - streams x-state: Technical Preview put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/streams/{name}/queries/{queryId}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Adds a query to a stream. Noop if the query is already present on the stream.

[Required authorization] Route required privileges: manage_stream. + description: 'Adds a query to a stream. Noop if the query is already present on the stream.

[Required authorization] Route required privileges: manage_stream.' operationId: put-streams-name-queries-queryid parameters: - description: A required header to protect against CSRF attacks @@ -55126,14 +52770,7 @@ paths: x-state: Technical Preview /api/streams/{name}/significant_events: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/streams/{name}/significant_events
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Read the significant events

[Required authorization] Route required privileges: read_stream. + description: 'Read the significant events

[Required authorization] Route required privileges: read_stream.' operationId: get-streams-name-significant-events parameters: - in: path @@ -55175,14 +52812,7 @@ paths: x-state: Technical Preview /api/streams/{name}/significant_events/_generate: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/streams/{name}/significant_events/_generate
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Generate significant events queries based on the stream data

[Required authorization] Route required privileges: read_stream. + description: 'Generate significant events queries based on the stream data

[Required authorization] Route required privileges: read_stream.' operationId: get-streams-name-significant-events-generate parameters: - in: path @@ -55229,14 +52859,7 @@ paths: x-state: Technical Preview /api/streams/{name}/significant_events/_preview: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/streams/{name}/significant_events/_preview
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Preview significant event results based on a given query

[Required authorization] Route required privileges: read_stream. + description: 'Preview significant event results based on a given query

[Required authorization] Route required privileges: read_stream.' operationId: post-streams-name-significant-events-preview parameters: - description: A required header to protect against CSRF attacks @@ -55297,12 +52920,6 @@ paths: /api/task_manager/_health: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/task_manager/_health
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Get the health status of the Kibana task manager. operationId: task-manager-health responses: @@ -55320,14 +52937,7 @@ paths: - task manager /api/timeline: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/timeline
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Delete one or more Timelines or Timeline templates. + description: Delete one or more Timelines or Timeline templates. operationId: DeleteTimelines requestBody: content: @@ -55361,14 +52971,7 @@ paths: tags: - Security Timeline API get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/timeline
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of an existing saved Timeline or Timeline template. + description: Get the details of an existing saved Timeline or Timeline template. operationId: GetTimeline parameters: - description: The `savedObjectId` of the template timeline to retrieve @@ -55392,14 +52995,7 @@ paths: tags: - Security Timeline API patch: - description: |- - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/timeline
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update an existing Timeline. You can update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing Timeline. + description: Update an existing Timeline. You can update the title, description, date range, pinned events, pinned queries, and/or pinned saved queries of an existing Timeline. operationId: PatchTimeline requestBody: content: @@ -55451,14 +53047,7 @@ paths: tags: - Security Timeline API post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/timeline
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a new Timeline or Timeline template. + description: Create a new Timeline or Timeline template. operationId: CreateTimelines requestBody: content: @@ -55523,12 +53112,6 @@ paths: /api/timeline/_copy: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/timeline/_copy
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Copies and returns a timeline or timeline template. operationId: CopyTimeline requestBody: @@ -55557,14 +53140,7 @@ paths: - Security Timeline API /api/timeline/_draft: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/timeline/_draft
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned. + description: Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned. operationId: GetDraftTimelines parameters: - in: query @@ -55606,12 +53182,6 @@ paths: - Security Timeline API post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/timeline/_draft
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create a clean draft Timeline or Timeline template for the current user. > info > If the user already has a draft Timeline, the existing draft Timeline is cleared and returned. @@ -55662,14 +53232,7 @@ paths: - Security Timeline API /api/timeline/_export: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/timeline/_export
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Export Timelines as an NDJSON file. + description: Export Timelines as an NDJSON file. operationId: ExportTimelines parameters: - description: The name of the file to export @@ -55715,14 +53278,7 @@ paths: - Security Timeline API /api/timeline/_favorite: patch: - description: |- - **Spaces method and path for this operation:** - -
patch /s/{space_id}/api/timeline/_favorite
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Favorite a Timeline or Timeline template for the current user. + description: Favorite a Timeline or Timeline template for the current user. operationId: PersistFavoriteRoute requestBody: content: @@ -55772,14 +53328,7 @@ paths: - Security Timeline API /api/timeline/_import: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/timeline/_import
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Import Timelines. + description: Import Timelines. operationId: ImportTimelines requestBody: content: @@ -55852,14 +53401,7 @@ paths: - Security Timeline API /api/timeline/_prepackaged: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/timeline/_prepackaged
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Install or update prepackaged Timelines. + description: Install or update prepackaged Timelines. operationId: InstallPrepackedTimelines requestBody: content: @@ -55937,22 +53479,9 @@ paths: summary: Get an existing saved Timeline or Timeline template tags: - Security Timeline API - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/timeline/resolve
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/timelines: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/timelines
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Get a list of all saved Timelines or Timeline templates. + description: Get a list of all saved Timelines or Timeline templates. operationId: GetTimelines parameters: - description: If true, only timelines that are marked as favorites by the user are returned. diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index d2652b8aa3c77..394608ce3b985 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -8185,12 +8185,6 @@ paths: /api/cases/reporters: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/cases/reporters
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Returns information about the users who opened cases. You must have read privileges for the **Cases** feature in the **Management**, **Observability**, or **Security** section of the Kibana feature privileges, depending on the owner of the cases. The API returns information about the users as they existed at the time of the case creation, including their name, full name, and email address. If any of those details change thereafter or if a user is deleted, the information returned by this API is unchanged. operationId: getCaseReportersDefaultSpace parameters: @@ -12889,12 +12883,6 @@ paths: /api/encrypted_saved_objects/_rotate_key: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/encrypted_saved_objects/_rotate_key
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Superuser role required. If a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key. @@ -17438,12 +17426,6 @@ paths: /api/features: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/features
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Get information about all Kibana features. Features are used by spaces and security to refine and secure access to Kibana. operationId: get-features responses: @@ -44572,12 +44554,6 @@ paths: /api/logstash/pipeline/{id}: delete: description: | - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/logstash/pipeline/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Delete a centrally-managed Logstash pipeline. If your Elasticsearch cluster is protected with basic authentication, you must have either the `logstash_admin` built-in role or a customized Logstash writer role. externalDocs: @@ -44600,12 +44576,6 @@ paths: x-state: Technical Preview get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/logstash/pipeline/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Get information for a centrally-managed Logstash pipeline. To use this API, you must have either the `logstash_admin` built-in role or a customized Logstash reader role. externalDocs: @@ -44644,12 +44614,6 @@ paths: x-state: Technical Preview put: description: | - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/logstash/pipeline/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Create a centrally-managed Logstash pipeline or update a pipeline. To use this API, you must have either the `logstash_admin` built-in role or a customized Logstash writer role. externalDocs: @@ -44710,12 +44674,6 @@ paths: /api/logstash/pipelines: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/logstash/pipelines
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Get a list of all centrally-managed Logstash pipelines. To use this API, you must have either the `logstash_admin` built-in role or a customized Logstash reader role. @@ -49255,12 +49213,6 @@ paths: summary: Get all roles tags: - roles - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security/role
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/security/role/_query: post: operationId: post-security-role-query @@ -49310,12 +49262,6 @@ paths: description: Indicates a successful call. summary: Query roles tags: [] - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security/role/_query
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/security/role/{name}: delete: operationId: delete-security-role-name @@ -49339,12 +49285,6 @@ paths: summary: Delete a role tags: - roles - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/security/role/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. get: operationId: get-security-role-name parameters: @@ -49372,21 +49312,8 @@ paths: summary: Get a role tags: - roles - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/security/role/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/security/role/{name}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm. + description: Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm. operationId: put-security-role-name parameters: - description: A required header to protect against CSRF attacks @@ -49799,21 +49726,9 @@ paths: summary: Create or update roles tags: - roles - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security/roles
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/security/session/_invalidate: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/security/session/_invalidate
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Invalidate user sessions that match a query. To use this API, you must be a superuser. operationId: post-security-session-invalidate parameters: @@ -49920,12 +49835,6 @@ paths: /api/short_url: post: description: | - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/short_url
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Kibana URLs may be long and cumbersome, short URLs are much easier to remember and share. Short URLs are created by specifying the locator ID and locator parameters. When a short URL is resolved, the locator ID and locator parameters are used to redirect user to the right Kibana page. operationId: post-url @@ -49970,12 +49879,6 @@ paths: /api/short_url/_slug/{slug}: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/short_url/_slug/{slug}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Resolve a Kibana short URL by its slug. operationId: resolve-url parameters: @@ -49999,12 +49902,6 @@ paths: /api/short_url/{id}: delete: description: | - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/short_url/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Delete a Kibana short URL. operationId: delete-url parameters: @@ -50018,12 +49915,6 @@ paths: x-state: Technical Preview get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/short_url/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Get a single Kibana short URL. operationId: get-url parameters: @@ -50041,14 +49932,7 @@ paths: x-state: Technical Preview /api/spaces/_copy_saved_objects: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/spaces/_copy_saved_objects
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - It also allows you to automatically copy related objects, so when you copy a dashboard, this can automatically copy over the associated visualizations, data views, and saved Discover sessions, as required. You can request to overwrite any objects that already exist in the target space if they share an identifier or you can use the resolve copy saved objects conflicts API to do this on a per-object basis.

[Required authorization] Route required privileges: copySavedObjectsToSpaces. + description: 'It also allows you to automatically copy related objects, so when you copy a dashboard, this can automatically copy over the associated visualizations, data views, and saved Discover sessions, as required. You can request to overwrite any objects that already exist in the target space if they share an identifier or you can use the resolve copy saved objects conflicts API to do this on a per-object basis.

[Required authorization] Route required privileges: copySavedObjectsToSpaces.' operationId: post-spaces-copy-saved-objects parameters: - description: A required header to protect against CSRF attacks @@ -50171,22 +50055,9 @@ paths: summary: Disable legacy URL aliases tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/spaces/_disable_legacy_url_aliases
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/spaces/_get_shareable_references: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/spaces/_get_shareable_references
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Collect references and space contexts for saved objects. + description: Collect references and space contexts for saved objects. operationId: post-spaces-get-shareable-references parameters: - description: A required header to protect against CSRF attacks @@ -50224,14 +50095,7 @@ paths: - spaces /api/spaces/_resolve_copy_saved_objects_errors: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/spaces/_resolve_copy_saved_objects_errors
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Overwrite saved objects that are returned as errors from the copy saved objects to space API.

[Required authorization] Route required privileges: copySavedObjectsToSpaces. + description: 'Overwrite saved objects that are returned as errors from the copy saved objects to space API.

[Required authorization] Route required privileges: copySavedObjectsToSpaces.' operationId: post-spaces-resolve-copy-saved-objects-errors parameters: - description: A required header to protect against CSRF attacks @@ -50321,14 +50185,7 @@ paths: tags: [] /api/spaces/_update_objects_spaces: post: - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/spaces/_update_objects_spaces
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Update one or more saved objects to add or remove them from some spaces. + description: Update one or more saved objects to add or remove them from some spaces. operationId: post-spaces-update-objects-spaces parameters: - description: A required header to protect against CSRF attacks @@ -50434,12 +50291,6 @@ paths: summary: Get all spaces tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/spaces/space
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. post: operationId: post-spaces-space parameters: @@ -50504,22 +50355,9 @@ paths: summary: Create a space tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
post /s/{space_id}/api/spaces/space
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/spaces/space/{id}: delete: - description: |- - **Spaces method and path for this operation:** - -
delete /s/{space_id}/api/spaces/space/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone. + description: When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone. operationId: delete-spaces-space-id parameters: - description: A required header to protect against CSRF attacks @@ -50563,12 +50401,6 @@ paths: summary: Get a space tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/spaces/space/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. put: operationId: put-spaces-space-id parameters: @@ -50639,12 +50471,6 @@ paths: summary: Update a space tags: - spaces - description: |- - **Spaces method and path for this operation:** - -
put /s/{space_id}/api/spaces/space/{id}
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/status: get: operationId: get-status @@ -50683,12 +50509,6 @@ paths: summary: Get Kibana's current status tags: - system - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. /api/streams: get: description: |- @@ -60421,12 +60241,6 @@ paths: /api/task_manager/_health: get: description: | - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/task_manager/_health
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - Get the health status of the Kibana task manager. operationId: task-manager-health responses: @@ -61186,14 +61000,7 @@ paths: - Security Timeline API /api/upgrade_assistant/status: get: - description: |- - **Spaces method and path for this operation:** - -
get /s/{space_id}/api/upgrade_assistant/status
- - Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. - - Check the status of your cluster. + description: Check the status of your cluster. operationId: get-upgrade-status responses: '200': diff --git a/oas_docs/scripts/promote_space_awareness.js b/oas_docs/scripts/promote_space_awareness.js index 56c41d8a8e5b1..fa8289dcc391a 100644 --- a/oas_docs/scripts/promote_space_awareness.js +++ b/oas_docs/scripts/promote_space_awareness.js @@ -14,19 +14,22 @@ const { run } = require('@kbn/dev-cli-runner'); const yaml = require('js-yaml'); const { REPO_ROOT } = require('@kbn/repo-info'); -const NON_SPACE_PATH_PREFIXES = new Set([ - '/api/upgrade_assistant', - '/api/logstash/pipeline', - '/api/logstash/pipelines', - '/api/task_manager/_health', - '/api/cases/reporters', - '/api/encrypted_saved_objects/_rotate_key', - '/api/short_url', - '/api/features', - '/api/security/role', - '/api/spaces', - '/api/security/session/_invalidate', -]).values(); +const NON_SPACE_PATH_PREFIXES = [ + ...new Set([ + '/api/upgrade_assistant', + '/api/logstash/pipeline', + '/api/logstash/pipelines', + '/api/task_manager/_health', + '/api/cases/reporters', + '/api/encrypted_saved_objects/_rotate_key', + '/api/short_url', + '/api/features', + '/api/status', + '/api/security/role', + '/api/spaces', + '/api/security/session/_invalidate', + ]), +]; const SPACE_PREFIX = '/s/'; @@ -46,10 +49,18 @@ run( const absPath = path.resolve(REPO_ROOT, relativeFilePath); const oasDoc = yaml.load(fs.readFileSync(absPath, 'utf8')); - for (const [pathName, pathValue] of Object.entries(oasDoc.paths)) { - if (pathName.startsWith(SPACE_PREFIX)) continue; - if (NON_SPACE_PATH_PREFIXES.some((nonSpacePrefix) => pathName.startsWith(nonSpacePrefix))) + for (const [_pathName, pathValue] of Object.entries(oasDoc.paths)) { + const pathName = _pathName.trim(); + log.debug(`Processing path: ${pathName}`); + if ( + pathName.startsWith(SPACE_PREFIX) || + NON_SPACE_PATH_PREFIXES.some((nonSpacePrefix) => { + return pathName.startsWith(nonSpacePrefix); + }) + ) { + log.debug(`Skipping path: ${pathName}.`); continue; + } for (const [method, methodValue] of Object.entries(pathValue)) { methodValue.description = `**Spaces method and path for this operation:**\n\n${getSpaceAlternatePathHtml( @@ -59,7 +70,7 @@ run( } } - log.info(`Writing file to ${absPath}`); + log.info(`Writing file with spaces promoted to ${absPath}`); fs.writeFileSync(absPath, yaml.dump(oasDoc, { noRefs: true, lineWidth: -1 }), 'utf8'); }, {