openapi: 3.2.0 info: version: '1' title: Elastic Cloud Enterprise Deployments API termsOfService: '' servers: - url: https://{{hostname}}/api/v1 security: - basicAuth: [] - apiKey: [] tags: - name: Deployments paths: /deployments: get: tags: - Deployments summary: List Deployments description: List Deployments. operationId: list-deployments responses: '200': description: The list of deployments that belong to the authenticated user. content: application/json: schema: $ref: '#/components/schemas/DeploymentsListResponse' '401': description: You are not authorized to perform this action. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD post: tags: - Deployments summary: Create Deployment description: Creates a Deployment. operationId: create-deployment parameters: - name: request_id in: query description: An optional idempotency token - if two create requests share the same request_id token (min size 32 characters, max 128) then only one deployment will be created, the second request will return the info of that deployment (in the same format described below, but with blanks for auth-related fields) required: false schema: type: string - name: validate_only in: query description: If true, will just validate the Deployment definition but will not perform the creation required: false schema: type: boolean default: false - name: template_id in: query description: An optional template id - if present, the referenced template will be used to fill in the resources field of the deployment creation request. If any resources are present in the request together with the template, the ones coming in the request will prevail and no merging with the template will be performed. required: false schema: type: string responses: '201': description: The request was valid and a new deployment was created headers: x-cloud-resource-version: description: The resource version, which is used to avoid update conflicts with concurrent operations schema: type: string x-cloud-resource-created: description: The date-time when the resource was created (ISO format relative to UTC) schema: type: string x-cloud-resource-last-modified: description: The date-time when the resource was last modified (ISO format relative to UTC) schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentCreateResponse' '202': description: The request was valid and deployment creation had already been started. content: application/json: schema: $ref: '#/components/schemas/DeploymentCreateResponse' '200': description: The request was valid (used when validate_only is true). content: application/json: schema: $ref: '#/components/schemas/DeploymentCreateResponse' '400': description: The deployment request had errors. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '401': description: You are not authorized to perform this action. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentCreateRequest' description: The deployment definition required: true /deployments/_resync: post: tags: - Deployments summary: Resynchronize Deployments description: Resynchronizes the search index for all the deployments. operationId: resync-deployments parameters: - name: skip_matching_version in: query description: When true, skips the document indexing when the version matches the in-memory copy. required: false schema: type: boolean default: true responses: '200': description: The deployments resync operation executed successfully. content: application/json: schema: $ref: '#/components/schemas/IndexSynchronizationResults' '500': description: 'The deployments resync operation failed. (code: `deployments.resync_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.resync_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - resync /deployments/_search: post: tags: - Deployments summary: Search Deployments description: Retrieves the information for all of the deployments that match the specified query. operationId: search-deployments parameters: - name: minimal_metadata in: query description: Comma separated list of attributes to include in response for deployments found. Useful for reducing response size when retrieving many deployments. Use of this parameter moves the result to the minimal_metadata section of the response. required: false schema: type: string responses: '200': description: The list of deployments that match the specified query and belong to the authenticated user. headers: x-cloud-resource-version: description: The resource version, which is used to avoid update conflicts with concurrent operations schema: type: string x-cloud-resource-created: description: The date-time when the resource was created (ISO format relative to UTC) schema: type: string x-cloud-resource-last-modified: description: The date-time when the resource was last modified (ISO format relative to UTC) schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentsSearchResponse' x-doc: tag: Deployment - Commands requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' description: (Optional) The search query to run. When not specified, all of the deployments are matched. /deployments/eligible-remote-clusters: post: tags: - Deployments summary: Get eligible remote clusters description: Returns the list of deployments which contain eligible remote clusters for a specific version. operationId: search-eligible-remote-clusters parameters: - name: version in: query description: The version of the Elasticsearch cluster cluster that will potentially be configured to have remote clusters. required: true schema: type: string responses: '200': description: List of deployments which contains eligible remote clusters for a specific version content: application/json: schema: $ref: '#/components/schemas/DeploymentsSearchResponse' '400': description: 'The provided version is invalid. (code: `stackpack.invalid_version`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - stackpack.invalid_version content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Remote Clusters requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' description: (Optional) The search query to run against all deployments containing eligible remote clusters. When not specified, all the eligible deployments are matched. /deployments/{deployment_id}: get: tags: - Deployments summary: Get Deployment description: Retrieves information about a Deployment. operationId: get-deployment parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: show_security in: query description: Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials required: false schema: type: boolean default: false - name: show_metadata in: query description: Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials required: false schema: type: boolean default: false - name: show_plans in: query description: Whether to include the full current and pending plan information in the response - can be large per cluster required: false schema: type: boolean default: true - name: show_plan_logs in: query description: Whether to include with the current and pending plan information the attempt log - can be very large per cluster required: false schema: type: boolean default: false - name: show_plan_history in: query description: "Whether to include the plan history with the current and pending plan information. The results can be very large per cluster.\n By default, if a given resource kind (e.g. Elasticsearch, Kibana, etc.) has more than 100 plans\n (which should be very rare, most likely caused by a bug) only 100 plans are returned for the given resource type:\n The first 10 plans, and the last 90 plans for that resource type.\n If ALL of the plans are desired, pass the `force_all_plan_history` parameter with a value of `true`.\n" required: false schema: type: boolean default: false - name: show_plan_defaults in: query description: If showing plans, whether to show values that are left at their default value (less readable but more informative) required: false schema: type: boolean default: false - name: convert_legacy_plans in: query description: If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true') required: false schema: type: boolean default: false - name: show_system_alerts in: query description: Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field. required: false schema: type: integer default: 0 - name: show_settings in: query description: Whether to show cluster settings in the response. required: false schema: type: boolean default: false - name: show_instance_metrics in: query description: Whether to show resources instance metrics in the response. required: false schema: type: boolean default: true - name: show_instance_configurations in: query description: If true, will return details for each instance configuration referenced by the deployment. required: false schema: type: boolean default: true - name: enrich_with_template in: query description: If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on required: false schema: type: boolean default: true - name: force_all_plan_history in: query description: "Force show the entire plan history no matter how long.\n As noted in the `show_plan_history` parameter description, by default, a maximum of 100 plans are shown per resource. \n If `true`, this parameter overrides the default, and ALL plans are returned.\n Use with care as the plan history can be VERY large. Consider pairing with `show_plan_logs=false`.\n " required: false schema: type: boolean default: false - name: clear_transient in: query description: If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update required: false schema: type: boolean default: false responses: '200': description: The Deployment info response headers: x-cloud-resource-version: description: The resource version, which is used to avoid update conflicts with concurrent operations schema: type: string x-cloud-resource-created: description: The date-time when the resource was created (ISO format relative to UTC) schema: type: string x-cloud-resource-last-modified: description: The date-time when the resource was last modified (ISO format relative to UTC) schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentGetResponse' '401': description: You are not authorized to perform this action. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD put: tags: - Deployments summary: Update Deployment description: Updates a Deployment. operationId: update-deployment parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: hide_pruned_orphans in: query description: Whether or not to hide orphaned resources that were shut down (relevant if prune on the request is true) required: false schema: type: boolean default: false - name: skip_snapshot in: query description: Whether or not to skip snapshots before shutting down orphaned resources (relevant if prune on the request is true) required: false schema: type: boolean default: false - name: validate_only in: query description: If true, will just validate the Deployment definition but will not perform the update required: false schema: type: boolean default: false - name: version in: query description: If specified then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request) required: false schema: type: string responses: '200': description: The request was valid and the deployment was updated. headers: x-cloud-resource-version: description: The resource version, which is used to avoid update conflicts with concurrent operations schema: type: string x-cloud-resource-created: description: The date-time when the resource was created (ISO format relative to UTC) schema: type: string x-cloud-resource-last-modified: description: The date-time when the resource was last modified (ISO format relative to UTC) schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateResponse' '400': description: The deployment request had errors. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '401': description: You are not authorized to perform this action. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateRequest' description: The deployment definition required: true delete: tags: - Deployments summary: Delete Deployment description: Deletes a Deployment and all its resources. operationId: delete-deployment parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string responses: '200': description: The request was valid and the deployment was deleted. content: application/json: schema: $ref: '#/components/schemas/DeploymentDeleteResponse' '400': description: The Deployment resources have not been shutdown yet. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '401': description: You are not authorized to perform this action. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD /deployments/{deployment_id}/_restore: post: tags: - Deployments summary: Restores a shutdown Deployment description: Restores all resources in a Deployment. operationId: restore-deployment parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: restore_snapshot in: query description: Whether or not to restore a snapshot for those resources that allow it. required: false schema: type: boolean default: false responses: '200': description: The request was valid and the resources of the deployment were restored. content: application/json: schema: $ref: '#/components/schemas/DeploymentRestoreResponse' '400': description: There are Elasticsearch resources in the deployment which are not shut down. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '401': description: You are not authorized to perform this action. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD /deployments/{deployment_id}/_resync: post: tags: - Deployments summary: Resynchronize Deployment description: Immediately resynchronizes the search index for the selected deployment. operationId: resync-deployment parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string responses: '200': description: The deployment resync operation executed successfully. content: application/json: schema: $ref: '#/components/schemas/IndexSynchronizationResults' '500': description: 'The deployment resync operation failed for deployment {deployment_id}. (code: `deployments.resync_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.resync_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - resync /deployments/{deployment_id}/_shutdown: post: tags: - Deployments summary: Shuts down Deployment description: Shuts down all resources in a Deployment. operationId: shutdown-deployment parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: hide in: query description: Whether or not to hide the deployment and its resources.Only applicable for Platform administrators. required: false schema: type: boolean - name: skip_snapshot in: query description: Whether or not to skip snapshots before shutting down the resources required: false schema: type: boolean default: false responses: '200': description: The request was valid and the resources of the deployment were shutdown. content: application/json: schema: $ref: '#/components/schemas/DeploymentShutdownResponse' '400': description: 'Parameter is restricted and can only be set by a Platform administrator. (code: `deployments.restricted_parameter`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.restricted_parameter content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '401': description: You are not authorized to perform this action. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD /deployments/{deployment_id}/apm/{ref_id}: get: tags: - Deployments summary: Get Deployment APM Resource Info description: Get info about an APM Resource belonging to a given Deployment. operationId: get-deployment-apm-resource-info parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: show_metadata in: query description: Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials. required: false schema: type: boolean default: false - name: show_plans in: query description: Whether to include the full current and pending plan information in the response - can be large per cluster. required: false schema: type: boolean default: true - name: show_plan_logs in: query description: Whether to include with the current and pending plan information the attempt log - can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_history in: query description: Whether to include with the current and pending plan information the plan history- can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_defaults in: query description: If showing plans, whether to show values that are left at their default value (less readable but more informative). required: false schema: type: boolean default: false - name: show_settings in: query description: Whether to show cluster settings in the response. required: false schema: type: boolean default: false - name: clear_transient in: query description: If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update required: false schema: type: boolean default: false responses: '200': description: Standard response. content: application/json: schema: $ref: '#/components/schemas/ApmResourceInfo' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Info /deployments/{deployment_id}/apm/{ref_id}/_reset-token: post: tags: - Deployments summary: Reset the secret token for an APM resource. description: Reset the token of an APM resource. operationId: deployment-apm-reset-secret-token parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '202': description: Response containing the new secret token, plan to apply it starts content: application/json: schema: $ref: '#/components/schemas/ApmCrudResponse' '400': description: 'Reset token is not supported when APM is managed by Elastic Agent. (code: `clusters.cluster_plan_state_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - clusters.cluster_plan_state_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: APM routes /deployments/{deployment_id}/appsearch/{ref_id}: get: tags: - Deployments summary: Get Deployment App Search Resource Info description: Get info about an App Search Resource belonging to a given Deployment. operationId: get-deployment-appsearch-resource-info parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: show_metadata in: query description: Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials. required: false schema: type: boolean default: false - name: show_plans in: query description: Whether to include the full current and pending plan information in the response - can be large per cluster. required: false schema: type: boolean default: true - name: show_plan_logs in: query description: Whether to include with the current and pending plan information the attempt log - can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_history in: query description: Whether to include with the current and pending plan information the plan history- can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_defaults in: query description: If showing plans, whether to show values that are left at their default value (less readable but more informative). required: false schema: type: boolean default: false - name: show_settings in: query description: Whether to show cluster settings in the response. required: false schema: type: boolean default: false - name: clear_transient in: query description: If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update required: false schema: type: boolean default: false responses: '200': description: Standard response. content: application/json: schema: $ref: '#/components/schemas/AppSearchResourceInfo' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Info /deployments/{deployment_id}/appsearch/{ref_id}/read_only_mode: get: tags: - Deployments summary: Set AppSearch read-only status description: Enable/Disable read-only mode on the given App Search resource. operationId: get-appsearch-read-only-mode parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '200': description: Standard response content: application/json: schema: $ref: '#/components/schemas/ReadOnlyResponse' '404': description: 'The Resource specified by ref_id cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: App Search - Read-only put: tags: - Deployments summary: Set AppSearch read-only status description: Enable/Disable read-only mode on the given App Search resource. operationId: set-appsearch-read-only-mode parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '200': description: Standard response content: application/json: schema: $ref: '#/components/schemas/ReadOnlyResponse' '404': description: 'The Resource specified by ref_id cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: App Search - Read-only requestBody: content: application/json: schema: $ref: '#/components/schemas/ReadOnlyRequest' description: read-only request body required: true /deployments/{deployment_id}/certificate-authority: get: tags: - Deployments summary: Get certificate authority description: Returns the certificate authority used to sign the certificates of this deployment. operationId: get-deployment-certificate-authority parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string responses: '200': description: The certificate authority used to sign the certificates of this deployment content: application/json: schema: $ref: '#/components/schemas/CertificateAuthority' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Elasticsearch Resource cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Trust /deployments/{deployment_id}/elasticsearch/{ref_id}: get: tags: - Deployments summary: Get Deployment Elasticsearch Resource Info description: Get info about an Elasticsearch Resource belonging to a given Deployment. operationId: get-deployment-es-resource-info parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: show_security in: query description: Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials. required: false schema: type: boolean default: false - name: show_metadata in: query description: Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials. required: false schema: type: boolean default: false - name: show_plans in: query description: Whether to include the full current and pending plan information in the response - can be large per cluster. required: false schema: type: boolean default: true - name: show_plan_logs in: query description: Whether to include with the current and pending plan information the attempt log - can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_history in: query description: Whether to include with the current and pending plan information the plan history- can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_defaults in: query description: If showing plans, whether to show values that are left at their default value (less readable but more informative). required: false schema: type: boolean default: false - name: convert_legacy_plans in: query description: If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true'). required: false schema: type: boolean default: false - name: show_system_alerts in: query description: Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field. required: false schema: type: integer default: 0 - name: show_settings in: query description: Whether to show cluster settings in the response. required: false schema: type: boolean default: false - name: enrich_with_template in: query description: If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on. required: false schema: type: boolean default: true - name: clear_transient in: query description: If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update required: false schema: type: boolean default: false responses: '200': description: Standard response. content: application/json: schema: $ref: '#/components/schemas/ElasticsearchResourceInfo' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Info /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ccr: post: tags: - Deployments summary: Migrate Elasticsearch and associated Kibana resources to enable CCR description: Migrates the specified Elasticsearch resource and its associated Kibana to enable CCR (if supported). operationId: enable-deployment-resource-ccr parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: validate_only in: query description: When `true`, will not enable CCR but returns warnings if any elements may lose availability during CCR enablement required: false schema: type: boolean default: false responses: '200': description: Standard response content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-ilm: post: tags: - Deployments summary: Migrate Elasticsearch resource to use ILM description: Migrates the specified Elasticsearch resource to use ILM. operationId: enable-deployment-resource-ilm parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: validate_only in: query description: When `true`, does not enable ILM but returns warnings if any applications may lose availability during ILM migration. required: false schema: type: boolean default: false responses: '200': description: Standard response content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands requestBody: content: application/json: schema: $ref: '#/components/schemas/EnableIlmRequest' description: Information to build the ILM policies that will be created required: true /deployments/{deployment_id}/elasticsearch/{ref_id}/_enable-slm: post: tags: - Deployments summary: Migrate Elasticsearch resource to use SLM description: Migrates the specified Elasticsearch resource to use SLM. operationId: enable-deployment-resource-slm parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: validate_only in: query description: When `true`, does not enable SLM but returns warnings if any applications may lose availability during SLM migration. required: false schema: type: boolean default: false responses: '200': description: Standard response content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/elasticsearch/{ref_id}/_reset-password: post: tags: - Deployments summary: Reset 'elastic' user password description: Resets the password of the 'elastic' user. operationId: reset-elasticsearch-user-password parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: check_completion in: query description: If true, will not reset elastic user password and instead will return a status code signaling whether or not the current credentials are ready to use (eg from creation or the last call to _reset_password) required: false schema: type: boolean default: false responses: '200': description: The password reset was out carried successfully content: application/json: schema: $ref: '#/components/schemas/ElasticsearchElasticUserPasswordResetResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'Failed to reset the ''elastic'' user''s password. (code: `deployments.elasticsearch.password_reset_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.elasticsearch.password_reset_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/elasticsearch/{ref_id}/_restart: post: tags: - Deployments summary: Restart Deployment Elasticsearch Resource description: 'Restarts an Elasticsearch Resource. If a Resource is active: this command re-applies the existing plan but applies a "cluster_reboot", which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.' operationId: restart-deployment-es-resource parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: restore_snapshot in: query description: When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available). required: false schema: type: boolean default: true - name: skip_snapshot in: query description: If true, will not take a snapshot of the cluster before restarting. required: false schema: type: boolean default: true - name: cancel_pending in: query description: If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error. required: false schema: type: boolean default: false - name: group_attribute in: query description: 'Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: ''\_\_all\_\_'' (restart all at once), ''\_\_zone\_\_'' by logical zone, ''\_\_name\_\_'' one instance at a time, or a comma-separated list of attributes of the instances' required: false schema: type: string default: __zone__ - name: shard_init_wait_time in: query description: 'The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)' required: false schema: type: integer default: 600 responses: '202': description: The restart command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '422': description: 'The command sent to a Resource found the Resource in an illegal state, the error message gives more details. (code: `deployments.deployment_resource_plan_change_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_plan_change_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/elasticsearch/{ref_id}/_shutdown: post: tags: - Deployments summary: Shutdown Deployment Elasticsearch Resource description: Shutdown Elasticsearch Resource belonging to a given Deployment. operationId: shutdown-deployment-es-resource parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: hide in: query description: Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators. required: false schema: type: boolean - name: skip_snapshot in: query description: If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible). required: false schema: type: boolean default: false responses: '200': description: Standard response. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '400': description: 'Parameter is restricted and can only be set by a Platform administrator. (code: `deployments.restricted_parameter`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.restricted_parameter content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters: post: tags: - Deployments summary: Get eligible remote clusters description: Returns the list of deployments which contain eligible remote clusters for the elasticsearch resource. operationId: get-deployment-es-resource-eligible-remote-clusters parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '200': description: List of deployments which contains eligible remote clusters for the resource content: application/json: schema: $ref: '#/components/schemas/DeploymentsSearchResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The resource specified doesn''t yet have a valid version for the current plan or the pending plan. (code: `deployments.resource_does_not_have_a_valid_version`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.resource_does_not_have_a_valid_version content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Remote Clusters requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' description: (Optional) The search query to run against all deployments containing eligible remote clusters. When not specified, all the eligible deployments are matched. /deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move: post: tags: - Deployments summary: Move Elasticsearch resource instances description: Moves one or more instances belonging to the given Elasticsearch resource to a different allocator. operationId: move-deployment-elasticsearch-resource-instances parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_ids in: path description: A comma-separated list of instance identifiers. required: true style: simple explode: false schema: type: array items: type: string - name: ignore_missing in: query description: When `true` and the instance does not exist, proceeds to the next instance, or treats the instance as an error. required: false schema: type: boolean default: false - name: force_update in: query description: When `true`, cancels and overwrites the pending plans, or treats the instance as an error. required: false schema: type: boolean default: false - name: instances_down in: query description: When `true`, the instances specified by `instance_ids` are considered permanently shut down for data migration logic. required: false schema: type: boolean default: false - name: move_only in: query description: When `true`, moves the specified instances and ignores the changes for the cluster state. required: false schema: type: boolean default: true - name: force_move in: query description: When `true`, moves instance data at file-system level (not via Elasticsearch), and re-creates instances on target allocator(s). required: false schema: type: boolean default: false - name: validate_only in: query description: When `true`, validates the move request, then returns the calculated plan without applying the plan. required: false schema: type: boolean default: false responses: '202': description: The move command was issued successfully. Use the "GET" command on the /{deployment_id} resource to monitor progress content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '200': description: If `validate_only` is `true`, the calculated plan is returned content: application/json: schema: $ref: '#/components/schemas/TransientElasticsearchPlanConfiguration' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Elasticsearch Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands requestBody: content: application/json: schema: $ref: '#/components/schemas/TransientElasticsearchPlanConfiguration' description: Overrides the default move configuration /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore: get: tags: - Deployments summary: Get the items in the Elasticsearch resource keystore description: Fetches the current fields and metadata (but not the values) of the keystore for the Elasticsearch resource. operationId: get-deployment-es-resource-keystore parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '200': description: The contents of the Elasticsearch keystore, with values redacted content: application/json: schema: $ref: '#/components/schemas/KeystoreContents' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD patch: tags: - Deployments summary: Add or remove items from the Elasticsearch resource keystore description: Adds the specified values to the Elasticsearch keystore, or removes the keys for the unspecified values. operationId: set-deployment-es-resource-keystore parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: validate_only in: query description: When `true`, does nothing except return the entries' allowlist and reloadability statuses. required: false schema: type: boolean default: false responses: '200': description: The new contents of the Elasticsearch keystore (or the proposed contents if validate_only is true) content: application/json: schema: $ref: '#/components/schemas/KeystoreContents' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD requestBody: content: application/json: schema: $ref: '#/components/schemas/KeystoreContents' description: The new settings that will be applied to the keystore of the Elasticsearch resource. required: true /deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters: get: tags: - Deployments summary: Get certificate based remote clusters description: Returns the list of certificate based remote clusters for the elasticsearch resource. operationId: get-deployment-es-resource-remote-clusters parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '200': description: List of certificate based remote clusters for the resource content: application/json: schema: $ref: '#/components/schemas/RemoteResources' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Remote Clusters put: tags: - Deployments summary: Set certificate based remote clusters description: Overwrites or creates the list of certificate based remote clusters for the elasticsearch resource. operationId: set-deployment-es-resource-remote-clusters parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '202': description: The Remote Clusters were updated content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Remote Clusters requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoteResources' description: List of certificate based remote clusters for the resource required: true /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository: get: tags: - Deployments summary: List the attached snapshot repositories description: Lists all the snapshot repositories this deployment has access to. These are snapshot repositories of other deployments that have been linked to this deployment. operationId: get-deployment-es-resource-snapshot-repository parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '200': description: List of snapshot repositories for this deployment content: application/json: schema: $ref: '#/components/schemas/SnapshotRepositories' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD post: tags: - Deployments summary: Create a snapshot repository for Elasticsearch resource description: 'Important: This API is currently in Tech Preview. While available for use, it is subject to change. Creates a snapshot dependency, allowing this cluster to access snapshots from the source deployment. Currently unavailable in self-hosted ECE.' operationId: create-deployment-es-resource-snapshot-repository parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '202': description: The request was accepted and the configuration change will be processed asynchronously content: application/json: schema: $ref: '#/components/schemas/CreateSnapshotDependencyResponse' '400': description: '* Cannot create a snapshot dependency from a deployment to itself. (code: `deployments.snapshot_dependency_cannot_link_to_self`) * Snapshot repository linking is not currently supported in this environment (e.g. self-hosted ECE). (code: `deployments.snapshot_dependency_not_supported_in_env`) * The request failed validation. (code: `clusters.cluster_invalid_plan`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.snapshot_dependency_cannot_link_to_self - deployments.snapshot_dependency_not_supported_in_env - clusters.cluster_invalid_plan content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: '* The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The source deployment cannot be found. (code: `deployments.snapshot_dependency_source_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_not_found - deployments.snapshot_dependency_source_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'Failed to create snapshot dependency. (code: `deployments.snapshot_dependency_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.snapshot_dependency_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD x-state: Technical preview requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSnapshotDependencyRequest' description: The source deployment to link snapshots from required: true /deployments/{deployment_id}/elasticsearch/{ref_id}/snapshot/repository/{repository_name}: delete: tags: - Deployments summary: Remove the attached snapshot repository description: Removes the attached snapshot repository. This is only possible if the repository is not in use anymore by any searchable snapshots. operationId: delete-deployment-es-resource-snapshot-repository parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: repository_name in: path description: The name of the snapshot repository to remove (e.g. _clone_abcd1234) required: true schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The snapshot repository specified by {repository_name} cannot be found. (code: `deployments.snapshot_dependency_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.snapshot_dependency_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD /deployments/{deployment_id}/elasticsearch/{ref_id}/tiers: get: tags: - Deployments summary: Get Elasticsearch tiers description: Retrieves the current memory size, zone count, and available sizes for all enabled Elasticsearch tiers in a Deployment. Disabled tiers are excluded. operationId: get-deployment-es-resource-tiers parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '200': description: The size configuration of all enabled Elasticsearch tiers content: application/json: schema: $ref: '#/components/schemas/TiersResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Elasticsearch Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD patch: tags: - Deployments summary: Update Elasticsearch tiers description: Updates the size and/or zone count of one or more Elasticsearch topology elements (tiers) within a Deployment. operationId: update-deployment-es-resource-tier parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '202': description: The tier configuration was updated and a plan change was initiated. content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more tier IDs in the request body are not valid for this deployment. (code: `deployments.tier_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.tier_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD requestBody: content: application/json: schema: $ref: '#/components/schemas/TiersUpdateRequest' description: A map of tier IDs to their desired configuration required: true /deployments/{deployment_id}/enterprise_search/{ref_id}: get: tags: - Deployments summary: Get Deployment Enterprise Search Resource Info description: Get info about an Enterprise Search Resource belonging to a given Deployment. operationId: get-deployment-enterprise-search-resource-info parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: show_metadata in: query description: Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials. required: false schema: type: boolean default: false - name: show_plans in: query description: Whether to include the full current and pending plan information in the response - can be large per cluster. required: false schema: type: boolean default: true - name: show_plan_logs in: query description: Whether to include with the current and pending plan information the attempt log - can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_history in: query description: Whether to include with the current and pending plan information the plan history- can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_defaults in: query description: If showing plans, whether to show values that are left at their default value (less readable but more informative). required: false schema: type: boolean default: false - name: show_settings in: query description: Whether to show cluster settings in the response. required: false schema: type: boolean default: false - name: clear_transient in: query description: If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update required: false schema: type: boolean default: false responses: '200': description: Standard response. content: application/json: schema: $ref: '#/components/schemas/EnterpriseSearchResourceInfo' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Info /deployments/{deployment_id}/heap_dumps: get: tags: - Deployments summary: Get details about heap dumps for a Deployment description: Gets details about existing heap dumps and in progress heap dump captures across all instances belonging to the deployment. operationId: get-deployment-heap-dumps parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string responses: '200': description: The heap dump details for all instances belonging to the deployment content: application/json: schema: $ref: '#/components/schemas/DeploymentHeapDumps' '404': description: 'The deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/integrations_server/{ref_id}: get: tags: - Deployments summary: Get Deployment Integrations Server Resource Info description: Get info about an Integrations Server Resource belonging to a given Deployment. operationId: get-deployment-integrations-server-resource-info parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: show_metadata in: query description: Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials. required: false schema: type: boolean default: false - name: show_plans in: query description: Whether to include the full current and pending plan information in the response - can be large per cluster. required: false schema: type: boolean default: true - name: show_plan_logs in: query description: Whether to include with the current and pending plan information the attempt log - can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_history in: query description: Whether to include with the current and pending plan information the plan history- can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_defaults in: query description: If showing plans, whether to show values that are left at their default value (less readable but more informative). required: false schema: type: boolean default: false - name: show_settings in: query description: Whether to show cluster settings in the response. required: false schema: type: boolean default: false - name: clear_transient in: query description: If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update required: false schema: type: boolean default: false responses: '200': description: Standard response. content: application/json: schema: $ref: '#/components/schemas/IntegrationsServerResourceInfo' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Info /deployments/{deployment_id}/kibana/{ref_id}: get: tags: - Deployments summary: Get Deployment Kibana Resource Info description: Get info about a Kibana Resource belonging to a given Deployment. operationId: get-deployment-kib-resource-info parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: show_metadata in: query description: Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials. required: false schema: type: boolean default: false - name: show_plans in: query description: Whether to include the full current and pending plan information in the response - can be large per cluster. required: false schema: type: boolean default: true - name: show_plan_logs in: query description: Whether to include with the current and pending plan information the attempt log - can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_history in: query description: Whether to include with the current and pending plan information the plan history- can be very large per cluster. required: false schema: type: boolean default: false - name: show_plan_defaults in: query description: If showing plans, whether to show values that are left at their default value (less readable but more informative). required: false schema: type: boolean default: false - name: convert_legacy_plans in: query description: If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true'). required: false schema: type: boolean default: false - name: show_settings in: query description: Whether to show cluster settings in the response. required: false schema: type: boolean default: false - name: clear_transient in: query description: If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update required: false schema: type: boolean default: false responses: '200': description: Standard response. content: application/json: schema: $ref: '#/components/schemas/KibanaResourceInfo' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Info /deployments/{deployment_id}/migrate_template: get: tags: - Deployments summary: Build request to migrate deployment to a different template description: Returns a deployment update request that would migrate this deployment to a different template. operationId: migrate-deployment-template parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: template_id in: query description: The ID of the deployment template to migrate to required: true schema: type: string - name: skip_instance_metrics_check in: query description: If true, will skip the instance metrics check for memory and disk usage calculations required: false schema: type: boolean default: false responses: '200': description: The request was valid and the deployment can be migrated to the template with the provided ID. content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateRequest' '400': description: The deployment cannot be successfully migrated to the template with the provided ID. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '401': description: You are not authorized to perform this action. content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD /deployments/{deployment_id}/tags: get: tags: - Deployments summary: Get the tags for a Deployment description: Returns the tags for a Deployment. operationId: get-deployment-tags parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string responses: '200': description: The deployment tags were successfully returned content: application/json: schema: $ref: '#/components/schemas/DeploymentTagsResponse' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD put: tags: - Deployments summary: Set the tags for a Deployment description: Sets the tags for a Deployment, replacing any existing tags. operationId: set-deployment-tags parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string responses: '200': description: The deployment tags were successfully updated content: application/json: schema: $ref: '#/components/schemas/DeploymentTagsResponse' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: '* The number of tags exceeds the maximum of 64 allowed per deployment. (code: `deployments.too_many_tags`) * A tag key exceeds the maximum of 32 characters or a tag value exceeds the maximum of 128 characters. (code: `deployments.lengthy_key_or_value`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.too_many_tags - deployments.lengthy_key_or_value content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - CRUD requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentTagsResponse' description: The tags to set on the deployment. required: true /deployments/{deployment_id}/upgrade: post: tags: - Deployments summary: Upgrade a Deployment to a new Elastic Stack version description: 'Important: This API is currently in Tech Preview. While available for use, it is subject to change. Upgrades all resources (Elasticsearch, Kibana, APM, Enterprise Search, etc.) in the deployment to the specified Elastic Stack version. Both the current deployment version and the target version must be >= 8.0.0.' operationId: upgrade-deployment parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string responses: '202': description: Deployment upgrade initiated successfully content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '400': description: '* The specified version is invalid or not available. (code: `deployments.invalid_version`) * The target version must be >= 8.0.0. (code: `deployments.upgrade.target_version_must_be_above_8_0_0`) * The current deployment version must be >= 8.0.0. (code: `deployments.upgrade.source_version_must_be_above_8_0_0`) * The target version must be greater than the current deployment version. (code: `deployments.upgrade_path_not_allowed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.invalid_version - deployments.upgrade.target_version_must_be_above_8_0_0 - deployments.upgrade.source_version_must_be_above_8_0_0 - deployments.upgrade_path_not_allowed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'A resource in the deployment has a failed last plan attempt. Resolve it before upgrading. (code: `deployments.upgrade_deployment_resource_last_plan_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.upgrade_deployment_resource_last_plan_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'Failed to upgrade the deployment. (code: `deployments.upgrade_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.upgrade_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD x-state: Technical preview requestBody: content: application/json: schema: $ref: '#/components/schemas/UpgradeDeploymentRequest' description: Target version must be >= 8.0.0. required: true /deployments/{deployment_id}/upgrade_assistant/status: get: tags: - Deployments summary: Get Deployment upgrade assistant status description: Get details about an Elasticsearch resource belonging to a given deployment. operationId: get-deployment-upgrade-assistant-status parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: target_version in: query description: If present, value is included in resource request to provide additional context (only supported for Kibana) required: false schema: type: string responses: '200': description: The Upgrade Assistant returned the status successfully content: application/json: schema: $ref: '#/components/schemas/DeploymentUpgradeAssistantStatusResponse' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Upgrade Assistant /deployments/{deployment_id}/{resource_kind}/{ref_id}/_restore: post: tags: - Deployments summary: Restores a shutdown resource description: Restores a shutdown resource belonging to a given Deployment. operationId: restore-deployment-resource parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: restore_snapshot in: query description: Whether or not to restore a snapshot for those resources that allow it. required: false schema: type: boolean default: false responses: '200': description: Standard Deployment Resource Crud Response content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCrudResponse' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: '* The Resource does not have a pending plan. (code: `deployments.resource_does_not_have_a_pending_plan`) * The resource is not shut down. (code: `deployments.resource_not_shutdown`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.resource_does_not_have_a_pending_plan - deployments.resource_not_shutdown content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD /deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id}: get: tags: - Deployments summary: Get plan activity description: Retrieves details for a single plan activity for the given resource. operationId: get-deployment-resource-plan-activity parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: attempt_id in: path description: Attempt id for the activity required: true schema: type: string responses: '200': description: Returning the single plan activity for the specified resource content: application/json: schema: $ref: '#/components/schemas/CommonClusterPlanInfo' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Plan - Activity /deployments/{deployment_id}/{resource_kind}/{ref_id}/diagnostics/_capture: post: tags: - Deployments summary: Capture diagnostics for an Elasticsearch or Kibana resource description: Retrieves a diagnostic bundle from an active cluster. To successfully retrieve a diagnostic bundle, the cluster must be responsive. operationId: capture-deployment-resource-diagnostics parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch or kibana). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: mode in: query description: Capture mode - whether to obtain all the diagnostics data or the lightweight, essential-only subset of it. Applicable only to Elasticsearch, ignored for any other components which have just one capture mode implemented. required: false schema: type: string enum: - full - light default: full responses: '200': description: The diagnostic bundle as a zip file content: application/json: schema: type: string format: byte '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '412': description: 'The diagnostics cannot be generated because the cluster is either stopped or initializing. (code: `clusters.cluster_plan_state_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - clusters.cluster_plan_state_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Diagnostics /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start: post: tags: - Deployments summary: Start all instances description: Starts all instances belonging to a Deployment Resource. operationId: start-deployment-resource-instances-all parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '202': description: The start command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The start maintenance mode command was prohibited for the given Resource. (code: `deployments.instance_update_prohibited_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.instance_update_prohibited_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_stop: post: tags: - Deployments summary: Stop all instances description: Stops all instances belonging to a Deployment Resource. operationId: stop-deployment-resource-instances-all parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '202': description: The stop command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The stop maintenance mode command was prohibited for the given Resource. (code: `deployments.instance_update_prohibited_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.instance_update_prohibited_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start: post: tags: - Deployments summary: Start maintenance mode (all instances) description: Starts maintenance mode of all instances belonging to a Deployment Resource. operationId: start-deployment-resource-instances-all-maintenance-mode parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '202': description: The start maintenance command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The start maintenance mode command was prohibited for the given Resource. (code: `deployments.instance_update_prohibited_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.instance_update_prohibited_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_stop: post: tags: - Deployments summary: Stop maintenance mode (all instances) description: Stops maintenance mode of all instances belonging to a Deployment Resource. operationId: stop-deployment-resource-instances-all-maintenance-mode parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string responses: '202': description: The stop maintenance mode command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The stop maintenance mode command was prohibited for the given Resource. (code: `deployments.instance_update_prohibited_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.instance_update_prohibited_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides: put: tags: - Deployments summary: Set size overrides description: Applies size overrides for all of the instances belonging to the given resource. Instance size overrides will be reset with the next plan change. operationId: set-all-instances-settings-overrides parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource. Only Elasticsearch resources are currently supported. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: restart_after_update in: query description: After overrides are set, restarts the instance to apply the changes. required: false schema: type: boolean default: false responses: '200': description: The updated overrides content: application/json: schema: $ref: '#/components/schemas/InstanceOverrides' '404': description: '* The deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot by found. (code: `deployments.deployment_resource_not_found`) * The specified override was out of range. Capacity must be in the range [1024, <>] and storage multiplier must be in the range [1.0, 1000.0]. (code: `instance_overrides.out_of_range`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - instance_overrides.out_of_range content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands requestBody: content: application/json: schema: $ref: '#/components/schemas/InstanceOverrides' description: The overrides to apply to all instances. Capacity overrides the RAM size in MB of the instance, and storage multiplier overrides the multiplier of the instance RAM size that determines the storage quota of the instance. Capacity must be in the range [1024, <>] and storage multiplier must be in the range [1.0, 1000.0]. required: true /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_start: post: tags: - Deployments summary: Start instances description: Starts instances belonging to a Deployment Resource. operationId: start-deployment-resource-instances parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_ids in: path description: A comma-separated list of instance identifiers. required: true style: simple explode: false schema: type: array items: type: string - name: ignore_missing in: query description: If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error required: false schema: type: boolean default: false responses: '202': description: The start command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The start maintenance mode command was prohibited for the given Resource. (code: `deployments.instance_update_prohibited_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.instance_update_prohibited_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/_stop: post: tags: - Deployments summary: Stop instances description: Stops instances belonging to a Deployment Resource. operationId: stop-deployment-resource-instances parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_ids in: path description: A comma-separated list of instance identifiers. required: true style: simple explode: false schema: type: array items: type: string - name: ignore_missing in: query description: If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error. required: false schema: type: boolean default: false responses: '202': description: The stop command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The start maintenance mode command was prohibited for the given Resource. (code: `deployments.instance_update_prohibited_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.instance_update_prohibited_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start: post: tags: - Deployments summary: Start maintenance mode description: Starts maintenance mode of instances belonging to a Deployment Resource. operationId: start-deployment-resource-maintenance-mode parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_ids in: path description: A comma-separated list of instance identifiers. required: true style: simple explode: false schema: type: array items: type: string - name: ignore_missing in: query description: If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error. required: false schema: type: boolean default: false responses: '202': description: The start maintenance command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The start maintenance mode command was prohibited for the given Resource. (code: `deployments.instance_update_prohibited_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.instance_update_prohibited_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_stop: post: tags: - Deployments summary: Stop maintenance mode description: Stops maintenance mode of instances belonging to a Resource. operationId: stop-deployment-resource-maintenance-mode parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_ids in: path description: A comma-separated list of instance identifiers. required: true style: simple explode: false schema: type: array items: type: string - name: ignore_missing in: query description: If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error. required: false schema: type: boolean default: false responses: '202': description: The stop maintenance mode command was issued successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * One or more instances of the given resource type are missing. (code: `deployments.instances_missing_on_update_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The stop maintenance mode command was prohibited for the given Resource. (code: `deployments.instance_update_prohibited_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.instance_update_prohibited_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'A Resource that was previously stored no longer exists. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides: put: tags: - Deployments summary: Set size overrides description: Applies size overrides for the given instances belonging to the given resource. Instance size overrides will be reset with the next plan change. operationId: set-instance-settings-overrides parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource. Only Elasticsearch resources are currently supported. required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_ids in: path description: A comma-separated list of instance identifiers. required: true style: simple explode: false schema: type: array items: type: string - name: restart_after_update in: query description: After overrides are set, restarts the instance to apply the changes. required: false schema: type: boolean default: false - name: ignore_missing in: query description: When `false` and a specified instance is missing, will return an error and not update any instances. When `true` will update only existing instances and not treat a missing instance as an error. required: false schema: type: boolean default: false responses: '200': description: The updated overrides content: application/json: schema: $ref: '#/components/schemas/InstanceOverrides' '404': description: '* The deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot by found. (code: `deployments.deployment_resource_not_found`) * One or more instances weren''t found, and `ignore_missing` is false or unspecified. (code: `deployments.instances_missing_on_update_error`) * The specified override was out of range. Capacity must be in the range [1024, <>] and storage multiplier must be in the range [1.0, 1000.0]. (code: `instance_overrides.out_of_range`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instances_missing_on_update_error - instance_overrides.out_of_range content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands requestBody: content: application/json: schema: $ref: '#/components/schemas/InstanceOverrides' description: The overrides to apply to the given instances. Capacity overrides the RAM size in MB of the instance, and storage multipler overrides the multiplier of the instance RAM size that determines the storage quota of the instance. Capacity must be in the range [1024, <>] and storage multiplier must be in the range [1.0, 1000.0]. required: true /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_capture: post: tags: - Deployments summary: Capture a new on-demand heap dump for the given instance description: Captures a new on-demand heap dump for the given instance. The capture is completed asynchronously, and you can check its progress by getting heap dumps for the given resource. operationId: capture-deployment-instance-heap-dump parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana or apm). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_id in: path description: The instance identifier required: true schema: type: string responses: '202': description: Indicates that the capture has started content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The specified instance cannot be found. (code: `deployments.instance_not_found_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instance_not_found_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/heap_dump/_download: get: tags: - Deployments summary: Download the given instance's heap dump description: Returns the given instance's heap dump for download. operationId: download-deployment-instance-heap-dump parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana or apm). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_id in: path description: The instance identifier required: true schema: type: string responses: '200': description: The given instance's heap dump content: application/json: schema: type: string format: byte '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The specified instance cannot be found. (code: `deployments.instance_not_found_error`) * The specified instance does not have a heap dump available to download. (code: `heap_dumps.heap_dump_not_found`) * The specified instance''s heap dump is not ready to download. (code: `heap_dumps.heap_dump_not_ready`) * The specified instance''s heap dump failed to capture. (code: `heap_dumps.heap_dump_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instance_not_found_error - heap_dumps.heap_dump_not_found - heap_dumps.heap_dump_not_ready - heap_dumps.heap_dump_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_id}/thread_dump/_capture: post: tags: - Deployments summary: Capture a new thread dump for the given instance description: Captures a new thread dump for the given instance and returns the thread dump contents. operationId: capture-deployment-instance-thread-dump parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: resource_kind in: path description: The kind of resource (one of elasticsearch, kibana or apm). required: true schema: type: string - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: instance_id in: path description: The instance identifier required: true schema: type: string responses: '200': description: The thread dump contents content: application/json: schema: type: string format: byte '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The specified instance cannot be found. (code: `deployments.instance_not_found_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - deployments.instance_not_found_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw: post: tags: - Deployments summary: Set a Deployment's resource metadata description: 'Advanced use only. Sets the internal metadata, in free-form JSON, for the resource. Only use the parameter to set the modified JSON that is returned from the get version of the metadata.' operationId: set-deployment-resource-raw-metadata parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: version in: query description: If specified, checks for conflicts against the metadata version (returned in 'x-cloud-resource-version' of the GET request) required: false schema: type: string responses: '200': description: The resource metadata was successfully changed (the updated JSON is returned) headers: x-cloud-resource-version: description: The resource version, which is used to avoid update conflicts with concurrent operations schema: type: string x-cloud-resource-created: description: The date-time when the resource was created (ISO format relative to UTC) schema: type: string x-cloud-resource-last-modified: description: The date-time when the resource was last modified (ISO format relative to UTC) schema: type: string content: application/json: schema: type: string '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The metadata is invalid. (code: `deployments.invalid_metadata`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.invalid_metadata content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '449': description: 'Please retry. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD requestBody: content: application/json: schema: type: string description: The freeform JSON for the cluster (should always be based on the current version retrieved from the GET) required: true patch: tags: - Deployments summary: Patch a Deployment's resource metadata description: Advanced use only. Patches the internal metadata with the given data. operationId: patch-deployment-resource-raw-metadata parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '200': description: The resource metadata was successfully changed (the updated JSON is returned) headers: x-cloud-resource-version: description: The resource version, which is used to avoid update conflicts with concurrent operations schema: type: string x-cloud-resource-created: description: The date-time when the resource was created (ISO format relative to UTC) schema: type: string x-cloud-resource-last-modified: description: The date-time when the resource was last modified (ISO format relative to UTC) schema: type: string content: application/json: schema: type: string '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The metadata is invalid. (code: `deployments.invalid_metadata`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.invalid_metadata content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '449': description: 'Please retry. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD requestBody: content: application/json: schema: type: string description: The data that should be patched into the metadata. required: true /deployments/{deployment_id}/{resource_kind}/{ref_id}/plan/pending: delete: tags: - Deployments summary: Cancel resource pending plan description: Cancels the pending plan of a Resource belonging to a given Deployment. operationId: cancel-deployment-resource-pending-plan parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: force_delete in: query description: When `true`, deletes the pending plan instead of attempting a graceful cancellation. The default is `false`. required: false schema: type: boolean default: false - name: ignore_missing in: query description: When `true`, returns successfully, even when plans are missing. The default is `false`. required: false schema: type: boolean default: false responses: '200': description: Standard Deployment Resource Crud Response content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCrudResponse' '404': description: 'The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The Resource does not have a pending plan. (code: `deployments.resource_does_not_have_a_pending_plan`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.resource_does_not_have_a_pending_plan content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'Vacate plans can only be cancelled by platform administrators. (code: `deployments.vacate_plan_cancellation_restricted`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.vacate_plan_cancellation_restricted content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD /deployments/{deployment_id}/{resource_kind}/{ref_id}/proxy/{proxy_path}: get: tags: - Deployments summary: Proxy HTTP GET request description: 'Proxies the HTTP GET request to the deployment resource. You must specify the `X-Management-Request` HTTP header. NOTE: Use this endpoint for management purposes. It does not provide high performance.' operationId: get-deployment-resource-proxy-requests parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: proxy_path in: path description: 'The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health' required: true schema: type: string - name: X-Management-Request in: header description: 'You must specify the `X-Management-Request` HTTP header with value `true`. NOTE: Use this endpoint for management purposes. It does not provide high performance.' required: true schema: type: string responses: '200': description: The request has been processed successfully through the proxy. content: application/json: schema: $ref: '#/components/schemas/GenericResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `clusters.cluster_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - clusters.cluster_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - Proxy requestBody: content: application/text: schema: type: string application/json: schema: type: string application/x-ndjson: schema: type: string description: The JSON payload to proxy to the deployment resource. post: tags: - Deployments summary: Proxy HTTP POST request description: 'Proxies the HTTP POST request to the deployment resource. You must specify the `X-Management-Request` HTTP header. NOTE: Use this endpoint for management purposes. It does not provide high performance.' operationId: post-deployment-resource-proxy-requests parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: proxy_path in: path description: 'The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health' required: true schema: type: string - name: X-Management-Request in: header description: 'You must specify the `X-Management-Request` HTTP header with value `true`. NOTE: Use this endpoint for management purposes. It does not provide high performance.' required: true schema: type: string responses: '200': description: The request has been processed successfully through the proxy. content: application/json: schema: $ref: '#/components/schemas/GenericResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `clusters.cluster_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - clusters.cluster_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - Proxy requestBody: content: application/text: schema: type: string application/json: schema: type: string application/x-ndjson: schema: type: string description: The JSON payload to proxy to the deployment resource. put: tags: - Deployments summary: Proxy HTTP PUT request description: 'Proxies the HTTP PUT request to the deployment resource. You must specify the `X-Management-Request` HTTP header. NOTE: Use this endpoint for management purposes. It does not provide high performance.' operationId: put-deployment-resource-proxy-requests parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: proxy_path in: path description: 'The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health' required: true schema: type: string - name: X-Management-Request in: header description: 'You must specify the `X-Management-Request` HTTP header with value `true`. NOTE: Use this endpoint for management purposes. It does not provide high performance.' required: true schema: type: string responses: '200': description: The request has been processed successfully through the proxy. content: application/json: schema: $ref: '#/components/schemas/GenericResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `clusters.cluster_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - clusters.cluster_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - Proxy requestBody: content: application/text: schema: type: string application/json: schema: type: string application/x-ndjson: schema: type: string description: The JSON payload to proxy to the deployment resource. delete: tags: - Deployments summary: Proxy HTTP DELETE request description: 'Proxies the HTTP DELETE request to the deployment resource. You must specify the `X-Management-Request` HTTP header. NOTE: Use this endpoint for management purposes. It does not provide high performance.' operationId: delete-deployment-resource-proxy-requests parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string - name: proxy_path in: path description: 'The URL part to proxy to the deployment resource. Example: _cat/indices, /api/spaces/space or /api/ent/v1/internal/health' required: true schema: type: string - name: X-Management-Request in: header description: 'You must specify the `X-Management-Request` HTTP header with value `true`. NOTE: Use this endpoint for management purposes. It does not provide high performance.' required: true schema: type: string responses: '200': description: The request has been processed successfully through the proxy. content: application/json: schema: $ref: '#/components/schemas/GenericResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `clusters.cluster_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found - clusters.cluster_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - Proxy requestBody: content: application/text: schema: type: string application/json: schema: type: string application/x-ndjson: schema: type: string description: The JSON payload to proxy to the deployment resource. /deployments/{deployment_id}/{resource_kind}/{ref_id}/user_settings: get: tags: - Deployments summary: Get the user settings of a Deployment resource description: Retrieves the current user-defined settings for a resource belonging to a given Deployment. operationId: get-deployment-resource-user-settings parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '200': description: The current user-defined settings for the resource content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceUserSettingsResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.metadata_internal_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.metadata_internal_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD put: tags: - Deployments summary: Update user settings for a deployment resource description: Replaces the component-level user-defined settings for the specified resource kind in the deployment. All existing component-level user settings are overwritten with the provided values. Submitting an empty object will remove all component-level user settings for the resource. This endpoint does not support tier/topology-level user settings overrides. operationId: update-deployment-resource-user-settings parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: resource_kind in: path description: The kind of resource required: true schema: type: string enum: - elasticsearch - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '202': description: The updated user settings for the deployment resource content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceUserSettings' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: '* Plan or user settings validation failed. (code: `clusters.cluster_invalid_plan`) * The deployment plan could not be applied; see the error message. (code: `user_settings.update_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - clusters.cluster_invalid_plan - user_settings.update_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceUserSettings' description: The user settings to apply to the deployment resource. Replaces all existing user settings. required: true /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}: delete: tags: - Deployments summary: Delete Stateless Resource from Deployment description: Delete Stateless Resource belonging to a given Deployment. Deployment must be shutdown already. operationId: delete-deployment-stateless-resource parameters: - name: deployment_id in: path description: Identifier for the Deployment required: true schema: type: string - name: stateless_resource_kind in: path description: The kind of stateless resource required: true schema: type: string enum: - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one) required: true schema: type: string responses: '200': description: Standard Deployment Resource Crud Response content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCrudResponse' '400': description: 'Resource has still instances. (code: `deployments.resource_has_instances`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.resource_has_instances content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment Resources - CRUD /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_restart: post: tags: - Deployments summary: Restart Deployment Stateless Resource description: 'Restarts a Stateless Resource. If a Resource is active: this command re-applies the existing plan but applies a "cluster_reboot", which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.' operationId: restart-deployment-stateless-resource parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: stateless_resource_kind in: path description: The kind of stateless resource required: true schema: type: string enum: - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: cancel_pending in: query description: If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error. required: false schema: type: boolean default: false responses: '202': description: The restart command was issued successfully content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '422': description: 'The command sent to a Resource found the Resource in an illegal state, the error message gives more details. (code: `deployments.deployment_resource_plan_change_error`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_plan_change_error content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_shutdown: post: tags: - Deployments summary: Shutdown Deployment Stateless Resource description: 'Shut down Stateless Resource belonging to a given Deployment. Kibana cannot be shut down on Elasticsearch Service as it is required for Elasticsearch administrative functions, such as Snapshot Lifecycle Management and version upgrades.' operationId: shutdown-deployment-stateless-resource parameters: - name: deployment_id in: path description: Identifier for the Deployment. required: true schema: type: string - name: stateless_resource_kind in: path description: The kind of stateless resource required: true schema: type: string enum: - kibana - apm - appsearch - enterprise_search - integrations_server - name: ref_id in: path description: User-specified RefId for the Resource (or '_main' if there is only one). required: true schema: type: string - name: hide in: query description: Hide cluster on shutdown. Hidden clusters are not listed by default. Only applicable for Platform administrators. required: false schema: type: boolean - name: skip_snapshot in: query description: If true, will skip taking a snapshot of the cluster before shutting the cluster down (if even possible) required: false schema: type: boolean default: false responses: '200': description: Standard response content: application/json: schema: $ref: '#/components/schemas/DeploymentResourceCommandResponse' '400': description: 'Parameter is restricted and can only be set by a Platform administrator. (code: `deployments.restricted_parameter`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.restricted_parameter content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: '* The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`) * The Resource specified by {ref_id} cannot be found. (code: `deployments.deployment_resource_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_not_found - deployments.deployment_resource_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'We have failed you. (code: `deployments.deployment_resource_no_longer_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - deployments.deployment_resource_no_longer_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Deployment - Commands components: schemas: ClusterInstanceMemoryInfo: type: object required: - instance_capacity properties: instance_capacity: type: integer format: int32 description: The memory capacity in MB of the instance instance_capacity_planned: type: integer format: int32 description: The planned memory capacity in MB of the instance (only shown when an override is present) memory_pressure: type: integer format: int32 description: The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues) native_memory_pressure: type: integer format: int32 description: The % memory pressure of the instance Docker container (if available) description: Information about the specific instances memory capacity and its usage DeploymentsListResponse: type: object required: - deployments properties: deployments: type: array description: The deployments items: $ref: '#/components/schemas/DeploymentsListingData' description: Contains a list of deployments ElasticsearchPayload: type: object required: - plan - ref_id - region properties: ref_id: type: string description: A locally-unique user-specified id for this Elasticsearch cluster display_name: type: string description: The human readable name for the cluster (defaults to the generated cluster id if not specified) region: type: string description: The region where this resource exists plan: description: The plan for building this Elasticsearch cluster $ref: '#/components/schemas/ElasticsearchClusterPlan' settings: description: The settings for building this Elasticsearch cluster $ref: '#/components/schemas/ElasticsearchClusterSettings' description: An alias for an Elasticsearch Cluster paired with a request for creating one DeploymentHeapDumps: type: object required: - elasticsearch - enterprise_search properties: elasticsearch: type: array description: The list of Elasticsearch resources and their heap dumps items: $ref: '#/components/schemas/ResourceHeapDumps' enterprise_search: type: array description: The list of Enterprise Search resources and their heap dumps items: $ref: '#/components/schemas/ResourceHeapDumps' AppSearchConfiguration: type: object properties: version: type: string description: The version of the AppSearch cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.) docker_image: type: string description: A docker URI that allows overriding of the default docker image specified for this version system_settings: $ref: '#/components/schemas/AppSearchSystemSettings' user_settings_json: type: object description: An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings) properties: {} user_settings_yaml: type: string description: An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of AppSearch settings) user_settings_override_json: type: object description: An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings) properties: {} user_settings_override_yaml: type: string description: An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of AppSearch settings) AppSearch: type: object required: - backend_plan - display_name - elasticsearch_cluster_ref_id - ref_id properties: ref_id: type: string description: A locally-unique user-specified id display_name: type: string description: The human readable name (defaults to the generated cluster id if not specified) elasticsearch_cluster_ref_id: type: string description: The user-specified id of the Elasticsearch Cluster that this will link to backend_plan: type: object description: The backend plan as JSON properties: {} description: Holds diagnostics for an AppSearch resource EnterpriseSearchPlansInfo: type: object required: - healthy - history properties: healthy: type: boolean description: Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed) current: $ref: '#/components/schemas/EnterpriseSearchPlanInfo' pending: $ref: '#/components/schemas/EnterpriseSearchPlanInfo' history: type: array items: $ref: '#/components/schemas/EnterpriseSearchPlanInfo' description: Information about current, pending, and past Enterprise Search Server plans. TransientEnterpriseSearchPlanConfiguration: type: object properties: strategy: $ref: '#/components/schemas/PlanStrategy' plan_configuration: $ref: '#/components/schemas/EnterpriseSearchPlanControlConfiguration' description: Defines configuration parameters that control how the plan (i.e. consisting of the cluster topology and Enterprise Search settings) is applied ClusterPlanAttemptError: type: object required: - details - message - timestamp properties: timestamp: type: string format: date-time description: Timestamp marking on info log of step message: type: string description: Human readable error message details: type: object description: A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively. additionalProperties: type: string failure_type: type: string description: The failure type description: Information about an error during a plan attempt. BoolQuery: type: object properties: must: type: array items: $ref: '#/components/schemas/QueryContainer' should: type: array items: $ref: '#/components/schemas/QueryContainer' must_not: type: array items: $ref: '#/components/schemas/QueryContainer' filter: type: array items: $ref: '#/components/schemas/QueryContainer' minimum_should_match: type: integer format: int32 description: The minimum number of optional should clauses to match. description: A query for documents that match boolean combinations of other queries. DeploymentDiagnostics: type: object properties: creates: description: Diagnostics for resources to be created $ref: '#/components/schemas/Creates' updates: description: Diagnostics for existing resources that may be updated $ref: '#/components/schemas/Updates' description: Describes the diagnostics for a given Deployment-modifying payload ElasticsearchNodeType: type: object properties: master: type: boolean description: 'Defines whether this node can be elected master (default: false)' data: type: boolean description: 'Defines whether this node can hold data (default: false)' ingest: type: boolean description: 'Defines whether this node can run an ingest pipeline (default: false)' ml: type: boolean description: 'Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)' description: 'Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.' IntegrationsServerInfo: type: object required: - elasticsearch_cluster - external_links - healthy - id - name - plan_info - status - topology properties: id: type: string description: The id of the Integrations Server name: type: string description: The name of the Integrations Server elasticsearch_cluster: $ref: '#/components/schemas/TargetElasticsearchCluster' deployment_id: type: string description: The id of the deployment that this Integrations Server belongs to. healthy: type: boolean description: 'Whether the Integrations Server is healthy or not (one or more of the info subsections will have healthy: false)' status: type: string description: Integrations Server status enum: - initializing - stopping - stopped - rebooting - restarting - reconfiguring - started plan_info: $ref: '#/components/schemas/IntegrationsServerPlansInfo' metadata: $ref: '#/components/schemas/ClusterMetadataInfo' topology: $ref: '#/components/schemas/ClusterTopologyInfo' external_links: type: array description: External resources related to the Integrations Server uniqueItems: true items: $ref: '#/components/schemas/ExternalHyperlink' links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' settings: description: The cluster metadata settings for the Integrations Server $ref: '#/components/schemas/IntegrationsServerSettings' region: type: string description: The region that this Integrations Server belongs to. Only populated in SaaS or federated ECE. apm_server_mode: type: string description: The mode APM is operating in. enum: - standalone - managed description: The overview information for the Integrations Server. InstanceOverrides: type: object properties: capacity: type: integer format: int32 description: Sets the memory capacity for the instances container. Requires a restart to take effect. storage_multiplier: type: number format: double description: Overrides the disk quota multiplier for the instance EnterpriseSearchResourceInfo: type: object required: - elasticsearch_cluster_ref_id - id - info - ref_id - region properties: ref_id: type: string description: The locally-unique user-specified id of a Resource elasticsearch_cluster_ref_id: type: string description: The Elasticsearch cluster that this resource depends on. id: type: string description: The randomly-generated id of a Resource region: type: string description: The region where this resource exists info: description: Info for the resource. $ref: '#/components/schemas/EnterpriseSearchInfo' description: Describes an Enterprise Search resource belonging to a Deployment ObservabilityIssue: type: object required: - description - severity properties: description: type: string description: A user-friendly description of the observability health issue severity: type: string description: Severity of the health issue description: Observability health issue ApmPlanInfo: type: object required: - healthy - plan_attempt_log - warnings properties: plan_attempt_id: type: string description: A UUID for each plan attempt plan_attempt_name: type: string description: A human readable name for each plan attempt, only populated when retrieving plan histories healthy: type: boolean description: Either the plan ended successfully, or is not yet completed (and no errors have occurred) attempt_start_time: type: string format: date-time description: When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC) attempt_end_time: type: string format: date-time description: If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC) plan_end_time: type: string format: date-time description: If this plan is not current or pending, when the plan was no longer active (ISO format in UTC) plan: $ref: '#/components/schemas/ApmPlan' plan_attempt_log: type: array items: $ref: '#/components/schemas/ClusterPlanStepInfo' source: description: Information describing the source that facilitated the plans current state $ref: '#/components/schemas/ChangeSourceInfo' warnings: type: array items: $ref: '#/components/schemas/ClusterPlanWarning' error: $ref: '#/components/schemas/ClusterPlanAttemptError' description: Information about the APM Server plan. DeploymentResources: type: object required: - apm - appsearch - elasticsearch - enterprise_search - integrations_server - kibana properties: elasticsearch: type: array description: List of Elasticsearch resources in your Deployment items: $ref: '#/components/schemas/ElasticsearchResourceInfo' kibana: type: array description: List of Kibana resources in your Deployment items: $ref: '#/components/schemas/KibanaResourceInfo' apm: type: array description: List of Apm resources in your Deployment items: $ref: '#/components/schemas/ApmResourceInfo' appsearch: type: array description: List of App Search resources in your Deployment items: $ref: '#/components/schemas/AppSearchResourceInfo' enterprise_search: type: array description: List of Enterprise Search resources in your Deployment items: $ref: '#/components/schemas/EnterpriseSearchResourceInfo' integrations_server: type: array description: List of Integrations Server resources in your Deployment items: $ref: '#/components/schemas/IntegrationsServerResourceInfo' description: Describes a resource belonging to a Deployment ReadOnlyRequest: type: object required: - enabled properties: enabled: type: boolean description: Enabled or disabled read-only mode description: Read-only mode request payload KibanaClusterInfo: type: object required: - cluster_id - cluster_name - elasticsearch_cluster - external_links - healthy - metadata - plan_info - status - topology properties: cluster_id: type: string description: The id of the cluster cluster_name: type: string description: The name of the cluster elasticsearch_cluster: $ref: '#/components/schemas/TargetElasticsearchCluster' deployment_id: type: string description: The id of the deployment to which this Kibana Server belongs to. healthy: type: boolean description: 'Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)' status: type: string description: Cluster status enum: - initializing - stopping - stopped - rebooting - restarting - reconfiguring - started plan_info: $ref: '#/components/schemas/KibanaClusterPlansInfo' metadata: $ref: '#/components/schemas/ClusterMetadataInfo' topology: $ref: '#/components/schemas/ClusterTopologyInfo' external_links: type: array description: External resources related to the cluster uniqueItems: true items: $ref: '#/components/schemas/ExternalHyperlink' links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' settings: description: The cluster metadata settings for a kibana cluster $ref: '#/components/schemas/KibanaClusterSettings' region: type: string description: The region that this cluster belongs to. Only populated in SaaS or federated ECE. description: The top-level object information for a Kibana instance. ClusterMetadataResourcesSettings: type: object properties: cpu: $ref: '#/components/schemas/ClusterMetadataCpuResourcesSettings' description: The top-level configuration settings for the Elasticsearch cluster resources. HeapDump: type: object required: - captured - instance_id - status - type properties: instance_id: type: string description: The Elastic Cloud name/id of the instance (container) size: type: integer format: int64 description: The size in bytes of the heap dump type: type: string description: The type of heap dump status: type: string description: The status of the heap dump error: type: string description: An error message if the heap dump failed captured: type: string description: The time at which the heap dump was captured IndexSynchronizationResults: type: object required: - created - deleted - errors - updated properties: created: type: array description: The ids of documents created in the index by index version items: type: string updated: type: array description: The ids of documents updated in the index by index version items: type: string deleted: type: array description: The ids of documents deleted from the index by index version items: type: string errors: type: array description: The regions where document synchronization may have failed items: type: string description: Results from synchronizing indices ExistsQuery: type: object required: - field properties: field: type: string description: The field to check for non-null values in. description: Matches documents that have at least one non-`null` value in the original field. DeploymentCreateResources: type: object properties: elasticsearch: type: array description: A list of payloads for Elasticsearch cluster creation. items: $ref: '#/components/schemas/ElasticsearchPayload' kibana: type: array description: A list of payloads for Kibana creation. items: $ref: '#/components/schemas/KibanaPayload' apm: type: array description: 'A list of payloads for APM creation. WARNING: For stack versions 8.0.0 and higher the integrations_server payload should be used instead, as this field becomes deprecated.' items: $ref: '#/components/schemas/ApmPayload' appsearch: type: array description: A list of payloads for AppSearch updates. AppSearch has been replaced by Enterprise Search in the Elastic Stack 7.7 and higher. items: $ref: '#/components/schemas/AppSearchPayload' enterprise_search: type: array description: A list of payloads for Enterprise Search creation. items: $ref: '#/components/schemas/EnterpriseSearchPayload' integrations_server: type: array description: A list of payloads for Integrations Server creation. items: $ref: '#/components/schemas/IntegrationsServerPayload' description: Describes the resources that will belong to a Deployment DeploymentUpdateResources: type: object properties: elasticsearch: type: array description: A list of payloads for Elasticsearch cluster updates items: $ref: '#/components/schemas/ElasticsearchPayload' kibana: type: array description: A list of payloads for Kibana updates items: $ref: '#/components/schemas/KibanaPayload' apm: type: array description: A list of payloads for APM updates items: $ref: '#/components/schemas/ApmPayload' appsearch: type: array description: A list of payloads for AppSearch updates. AppSearch has been replaced by Enterprise Search in the Elastic Stack 7.7 and higher items: $ref: '#/components/schemas/AppSearchPayload' enterprise_search: type: array description: A list of payloads for Enterprise Search updates items: $ref: '#/components/schemas/EnterpriseSearchPayload' integrations_server: type: array description: A list of payloads for Integrations Server updates items: $ref: '#/components/schemas/IntegrationsServerPayload' description: Describes the Deployment resource updates RestoreSnapshotConfiguration: type: object required: - snapshot_name properties: repository_name: type: string description: If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots') snapshot_name: type: string description: The name of the snapshot to restore. Use '\_\_latest_success\_\_' to get the most recent snapshot from the specified repository repository_config: description: Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id $ref: '#/components/schemas/RestoreSnapshotRepoConfiguration' restore_payload: $ref: '#/components/schemas/RestoreSnapshotApiConfiguration' strategy: type: string description: The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only enum: - partial - full - recovery source_cluster_id: type: string description: If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config description: Restores a snapshot from a local or remote repository. AutoOpsSettings: type: object required: - status properties: status: type: string description: See AutoOps integration status for this deployment. enum: - connected - not_connected - excluded description: AutoOps settings for this deployment. Creates: type: object properties: elasticsearch: type: array description: Diagnostics for Elasticsearch clusters items: $ref: '#/components/schemas/Elasticsearch' kibana: type: array description: Diagnostics for Kibanas items: $ref: '#/components/schemas/Kibana' apm: type: array description: Diagnostics for APMs items: $ref: '#/components/schemas/Apm' integrations_server: type: array description: Diagnostics for Integrations Server items: $ref: '#/components/schemas/IntegrationsServer' appsearch: type: array description: Diagnostics for AppSearches items: $ref: '#/components/schemas/AppSearch' enterprise_search: type: array description: Diagnostics for Enterprise Search resources items: $ref: '#/components/schemas/EnterpriseSearch' description: Holds diagnostics for resources that will be created SnapshotRepositories: type: object required: - repositories properties: repositories: type: array description: List of snapshot repositories (other deployments whose snapshots this deployment can access) items: $ref: '#/components/schemas/SnapshotDependency' description: The snapshot repositories linked to this deployment. DeploymentShutdownResponse: type: object required: - id - name properties: id: type: string description: The id of the deployment name: type: string description: The name of the deployment orphaned: description: Details about orphaned resources $ref: '#/components/schemas/Orphaned' description: A response returned from the Deployment shutdown endpoint Kibana: type: object required: - backend_plan - display_name - elasticsearch_cluster_ref_id - ref_id properties: ref_id: type: string description: A locally-unique user-specified id display_name: type: string description: The human readable name (defaults to the generated cluster id if not specified) elasticsearch_cluster_ref_id: type: string description: The user-specified id of the Elasticsearch Cluster that this will link to backend_plan: type: object description: The backend plan as JSON properties: {} description: Holds diagnostics for a Kibana resource CommonClusterPlanInfo: type: object required: - healthy - plan_attempt_log - warnings properties: plan_attempt_id: type: string plan_attempt_name: type: string healthy: type: boolean attempt_start_time: type: string format: date-time attempt_end_time: type: string format: date-time plan_end_time: type: string format: date-time plan: type: object properties: {} plan_attempt_log: type: array items: $ref: '#/components/schemas/ClusterPlanStepInfo' source: $ref: '#/components/schemas/ChangeSourceInfo' warnings: type: array items: $ref: '#/components/schemas/ClusterPlanWarning' error: $ref: '#/components/schemas/ClusterPlanAttemptError' DeploymentResourceCommandResponse: type: object properties: warnings: type: array description: List of warnings generated from validating command items: $ref: '#/components/schemas/ReplyWarning' description: Response returned when a command is successfully issued against a given Deployment resource DeploymentResource: type: object required: - id - kind - ref_id - region properties: ref_id: type: string description: A locally-unique friendly alias for this Elasticsearch cluster elasticsearch_cluster_ref_id: type: string description: The Elasticsearch cluster that this resource depends on. id: type: string description: A system-unique id for the created resource kind: type: string description: The kind of resource region: type: string description: Identifier of the region in which this resource runs. cloud_id: type: string description: An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana credentials: description: Credentials for logging into a created resource. Only provided on initial create and absent otherwise. $ref: '#/components/schemas/ClusterCredentials' secret_token: type: string description: Secret token for using a created resource. Only provided on initial create and absent otherwise. warnings: type: array description: List of warnings generated from validating resource updates items: $ref: '#/components/schemas/ReplyWarning' description: Data for a deployment resource TiersUpdateRequest: type: object properties: hot_content: description: Configuration for the hot_content tier $ref: '#/components/schemas/TierConfig' warm: description: Configuration for the warm tier $ref: '#/components/schemas/TierConfig' cold: description: Configuration for the cold tier $ref: '#/components/schemas/TierConfig' frozen: description: Configuration for the frozen tier $ref: '#/components/schemas/TierConfig' master: description: Configuration for the master tier $ref: '#/components/schemas/TierConfig' coordinating: description: Configuration for the coordinating tier $ref: '#/components/schemas/TierConfig' ml: description: Configuration for the ml tier $ref: '#/components/schemas/TierConfig' description: Update the size and/or zone count of one or more Elasticsearch tiers. Only include the tiers you want to modify. ElasticsearchScriptTypeSettings: type: object properties: enabled: type: boolean description: 'If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if ''sandbox_mode'' is disabled (or for 6.x). NOTES: (Corresponds to the parameter ''script.file|stored/indexed|inline'')' sandbox_mode: type: boolean description: 'If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the ''painless_enabled'', ''mustache_enabled'' ''expression_enabled'' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters ''script.engine.[painless|mustache|expressions].[file|stored|inline]'')' description: Enables scripting for the specified type and controls other parameters. Store scripts in indexes (`stored`), upload in file bundles (`file`), or use in API requests (`inline`). TierInfo: type: object properties: memory_size: type: integer format: int32 description: The memory size in MB for this tier. zone_count: type: integer format: int32 description: The number of availability zones for this tier. available_sizes: type: array description: Discrete memory sizes in MB from this tier's instance configuration. Sizes up to the allowed multiple of the maximum discrete size may also be valid. items: type: integer format: int32 description: Current configuration of an individual Elasticsearch tier DeploymentUpdateResponse: type: object required: - id - name - resources properties: id: type: string description: The id of the deployment name: type: string description: The name of the deployment alias: type: string description: A user-defined alias to use in place of ResourceIds for user-friendly resource URLs resources: type: array description: List of resources that are part of the deployment after the update operation. items: $ref: '#/components/schemas/DeploymentResource' shutdown_resources: description: List of resources that have been shut down $ref: '#/components/schemas/Orphaned' diagnostics: description: Backend diagnostics. Sent if validation is requested. $ref: '#/components/schemas/DeploymentDiagnostics' settings: description: Additional configuration for this Deployment $ref: '#/components/schemas/DeploymentSettings' description: A response returned from the Deployment update endpoint ElasticsearchConfiguration: type: object properties: version: type: string description: The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified. docker_image: type: string description: A docker URI that allows overriding of the default docker image specified for this version system_settings: $ref: '#/components/schemas/ElasticsearchSystemSettings' user_settings_json: type: object description: 'An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and ''user_settings_yaml'' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with ''user_settings_override*'' and ''system_settings'' defines the total set of Elasticsearch settings)' properties: {} user_settings_yaml: type: string description: 'An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and ''user_settings_json'' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with ''user_settings_override*'' and ''system_settings'' defines the total set of Elasticsearch settings)' user_settings_override_json: type: object description: 'An arbitrary JSON object allowing ECE admins owners to set clusters'' parameters (only one of this and ''user_settings_override_yaml'' is allowed), ie in addition to the documented ''system_settings''. NOTES: (This field together with ''system_settings'' and ''user_settings*'' defines the total set of Elasticsearch settings)' properties: {} user_settings_override_yaml: type: string description: 'An arbitrary YAML object allowing ECE admins owners to set clusters'' parameters (only one of this and ''user_settings_override_json'' is allowed), ie in addition to the documented ''system_settings''. NOTES: (This field together with ''system_settings'' and ''user_settings*'' defines the total set of Elasticsearch settings)' enabled_built_in_plugins: type: array description: 'A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)' items: type: string user_plugins: type: array description: A list of admin-uploaded plugin objects that are available for this user. items: $ref: '#/components/schemas/ElasticsearchUserPlugin' user_bundles: type: array description: A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user. items: $ref: '#/components/schemas/ElasticsearchUserBundle' curation: description: Defines the index curation routing for the cluster $ref: '#/components/schemas/ElasticsearchCuration' node_attributes: type: object description: Defines the Elasticsearch node attributes for the instances in the topology additionalProperties: type: string description: The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings. DeploymentUpgradeAssistantStatusResponse: type: object required: - details - ready_for_upgrade properties: ready_for_upgrade: type: boolean description: A boolean indicating whether or not the cluster is ready to be upgraded details: type: string description: Message with information about the number of Elasticsearch and Kibana deprecations description: The status of your cluster and its readiness to be upgraded Apm: type: object required: - backend_plan - display_name - elasticsearch_cluster_ref_id - ref_id properties: ref_id: type: string description: A locally-unique user-specified id display_name: type: string description: The human readable name (defaults to the generated cluster id if not specified) elasticsearch_cluster_ref_id: type: string description: The user-specified id of the Elasticsearch Cluster that this will link to backend_plan: type: object description: The backend plan as JSON properties: {} description: Holds diagnostics for an APM resource EmptyResponse: type: object DiscreteSizes: type: object required: - sizes properties: sizes: type: array description: List of supported sizes items: type: integer format: int32 default_size: type: integer format: int32 description: The default size resource: type: string description: The unit that each size represents. If not specified, it will default to 'memory'. enum: - memory - storage description: Instance sizes that are supported by the Elasticsearch instance, Kibana instance, or APM Server configuration. ElasticsearchElasticUserPasswordResetResponse: type: object required: - password - username properties: username: type: string description: The username for the newly-reset password for the given Elasticsearch cluster password: type: string description: The newly-reset password for the given Elasticsearch cluster description: Envelope holding the newly-reset password for a cluster's user ApmConfiguration: type: object properties: version: type: string description: The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.) docker_image: type: string description: A docker URI that allows overriding of the default docker image specified for this version system_settings: $ref: '#/components/schemas/ApmSystemSettings' user_settings_json: type: object description: An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings) properties: {} user_settings_yaml: type: string description: An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings) user_settings_override_json: type: object description: An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings) properties: {} user_settings_override_yaml: type: string description: An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings) description: The configuration options for the APM Server. ManagedMonitoringSettings: type: object required: - target_cluster_id properties: target_cluster_id: type: string description: The Id of the target cluster to which to send monitoring information description: The settings for sending monitoring information to another cluster. ElasticsearchClusterTrustSettings: type: object properties: accounts: type: array description: The list of trust relationships with different accounts items: $ref: '#/components/schemas/AccountTrustRelationship' external: type: array description: The list of trust relationships with external entities items: $ref: '#/components/schemas/ExternalTrustRelationship' direct: type: array description: The list of trust relationships where the certificate is bundled with the trust setting. Allows configuring trust for clusters running outside of an Elastic Cloud managed environment or in an Elastic Cloud environment without an environment level trust established. items: $ref: '#/components/schemas/DirectTrustRelationship' description: Configuration of trust with other clusters. AppSearchSubInfo: type: object required: - app_search_id - enabled properties: app_search_id: type: string description: The App Search Id enabled: type: boolean description: Whether the associated App Search is currently available links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' description: Information about the APM Servers associated with the Elasticsearch cluster. ApmSubInfo: type: object required: - apm_id - enabled properties: apm_id: type: string description: The APM cluster Id enabled: type: boolean description: Whether the associated APM cluster is currently available links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' description: Information about the APM Servers associated with the Elasticsearch cluster. IntegrationsServerPlansInfo: type: object required: - healthy - history properties: healthy: type: boolean description: Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed) current: $ref: '#/components/schemas/IntegrationsServerPlanInfo' pending: $ref: '#/components/schemas/IntegrationsServerPlanInfo' history: type: array items: $ref: '#/components/schemas/IntegrationsServerPlanInfo' description: Information about current, pending, and past Integrations Server plans. TargetElasticsearchCluster: type: object required: - elasticsearch_id properties: elasticsearch_id: type: string description: The Elasticsearch cluster Id links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' description: Information about the specified Elasticsearch cluster. ElasticsearchClusterInfo: type: object required: - associated_apm_clusters - associated_appsearch_clusters - associated_enterprise_search_clusters - associated_kibana_clusters - cluster_id - cluster_name - elasticsearch - external_links - healthy - metadata - plan_info - snapshots - status - topology properties: cluster_id: type: string description: The id of the cluster cluster_name: type: string description: The name of the cluster deployment_id: type: string description: The id of the deployment that this Elasticsearch belongs to. healthy: type: boolean description: 'Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)' status: type: string description: Cluster status enum: - initializing - stopping - stopped - rebooting - restarting - reconfiguring - started plan_info: $ref: '#/components/schemas/ElasticsearchClusterPlansInfo' elasticsearch: $ref: '#/components/schemas/ElasticsearchInfo' metadata: $ref: '#/components/schemas/ClusterMetadataInfo' topology: $ref: '#/components/schemas/ClusterTopologyInfo' system_alerts: type: array description: List of cluster system alerts items: $ref: '#/components/schemas/ClusterSystemAlert' associated_kibana_clusters: type: array items: $ref: '#/components/schemas/KibanaSubClusterInfo' associated_apm_clusters: type: array items: $ref: '#/components/schemas/ApmSubInfo' associated_appsearch_clusters: type: array items: $ref: '#/components/schemas/AppSearchSubInfo' associated_enterprise_search_clusters: type: array items: $ref: '#/components/schemas/EnterpriseSearchSubInfo' security: $ref: '#/components/schemas/ElasticsearchClusterSecurityInfo' elasticsearch_monitoring_info: $ref: '#/components/schemas/ElasticsearchMonitoringInfo' snapshots: $ref: '#/components/schemas/SnapshotStatusInfo' external_links: type: array description: External resources related to the cluster uniqueItems: true items: $ref: '#/components/schemas/ExternalHyperlink' links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' settings: $ref: '#/components/schemas/ElasticsearchClusterSettings' region: type: string description: The region that this cluster belongs to. Only populated in SaaS or federated ECE. locked: type: boolean description: Whether or not this cluster is locked. Only populated in SaaS. description: The information for an Elasticsearch cluster. IntegrationsServerConfiguration: type: object properties: version: type: string description: The version of the Integrations Server cluster (must be one of the ECE supported versions, and won't work unless it matches the Integrations Server version. Leave blank to auto-detect version.) docker_image: type: string description: A docker URI that allows overriding of the default docker image specified for this version system_settings: $ref: '#/components/schemas/IntegrationsServerSystemSettings' user_settings_json: type: object description: An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings) properties: {} user_settings_yaml: type: string description: An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Integrations Server settings) user_settings_override_json: type: object description: An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings) properties: {} user_settings_override_yaml: type: string description: An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Integrations Server settings) mode: type: string description: The mode the Integrations Server is operating in. enum: - standalone - managed description: The configuration options for the Integrations Server. DeploymentCreateMetadata: type: object properties: system_owned: type: boolean description: Indicates if a deployment is system owned (restricts the set of operations that can be performed on it) tags: type: array description: Arbitrary user-defined metadata associated with this deployment items: $ref: '#/components/schemas/MetadataItem' description: Additional information about the new deployment object. ElasticsearchClusterBlockingIssueElement: type: object required: - description - instances properties: description: type: string description: Description of the issue instances: type: array description: A list of instances that are affected by the issue items: type: string description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Use `blocks` in `cluster_blocking_issues` instead Information about an issue and the Elasticsearch instance it affects.' ClusterCurationSpec: type: object required: - index_pattern - trigger_interval_seconds properties: index_pattern: type: string description: Index matching pattern trigger_interval_seconds: type: integer format: int32 description: Number of seconds after index creation to trigger this spec description: Specifies the conditions to trigger an Elasticsearch cluster curation. ApmCrudResponse: type: object required: - secret_token properties: apm_id: type: string description: For an operation creating or updating an APM server, the Id of that server secret_token: type: string description: The secret token for accessing the server diagnostics: type: object description: If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation) properties: {} description: The response to an APM CRUD (create/update-plan) request. TermQuery: type: object required: - value properties: value: type: string description: The exact value to query for. description: A query for documents that contain the specified term in the inverted index. EnterpriseSearchPayload: type: object required: - elasticsearch_cluster_ref_id - plan - ref_id - region properties: ref_id: type: string description: A locally-unique user-specified id for Enterprise Search elasticsearch_cluster_ref_id: type: string description: Alias to the Elasticsearch Cluster to attach Enterprise Search to display_name: type: string description: 'The human readable name for the Enterprise Search cluster (default: takes the name of its Elasticsearch cluster)' region: type: string description: The region where this resource exists plan: $ref: '#/components/schemas/EnterpriseSearchPlan' settings: description: The settings for building this Enterprise Search cluster $ref: '#/components/schemas/EnterpriseSearchSettings' description: An Enterprise Search creation request paired with the alias of the Elasticsearch cluster it should be paired with TopologyElementControl: type: object required: - min properties: min: description: Absolute minimum size limit for a topology element created with a deployment template. If the value is 0, that means the topology element can be disabled. $ref: '#/components/schemas/TopologySize' description: Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment. QueryContainer: type: object properties: match: type: object additionalProperties: $ref: '#/components/schemas/MatchQuery' match_all: $ref: '#/components/schemas/MatchAllQuery' match_none: $ref: '#/components/schemas/MatchNoneQuery' term: type: object additionalProperties: $ref: '#/components/schemas/TermQuery' bool: $ref: '#/components/schemas/BoolQuery' query_string: $ref: '#/components/schemas/QueryStringQuery' nested: $ref: '#/components/schemas/NestedQuery' prefix: type: object additionalProperties: $ref: '#/components/schemas/PrefixQuery' exists: $ref: '#/components/schemas/ExistsQuery' range: type: object additionalProperties: $ref: '#/components/schemas/RangeQuery' simple_query_string: $ref: '#/components/schemas/SimpleQueryStringQuery' description: The container for all of the allowed Elasticsearch queries. Specify only one property each time. InstanceMoveRequest: type: object required: - from properties: from: type: string description: The instance id that is going to be moved to: type: array description: An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy) items: type: string instance_down: type: boolean description: 'Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)' description: The request that specifies the Elasticsearch or stateless (eg Kibana) instances to move to allocators as part of the upgrade plan. When used in conjunction with '\_\_all\_\_' (roll all instances as a single unit) strategy, these instances are not restarted, which can sometimes enable recovery plans when these instances are boot-looping. AllocatorMoveRequest: type: object required: - from properties: from: type: string description: The allocator id off which all instances in the cluster should be moved to: type: array description: An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy) items: type: string allocator_down: type: boolean description: 'Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)' description: As part of the upgrade plan, identifies the move requests for the Kibana instances or APM Servers on the allocators. KibanaPlanControlConfiguration: type: object properties: timeout: type: integer format: int64 description: The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB) calm_wait_time: type: integer format: int64 description: This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s move_instances: type: array items: $ref: '#/components/schemas/InstanceMoveRequest' move_allocators: type: array items: $ref: '#/components/schemas/AllocatorMoveRequest' reallocate_instances: type: boolean description: 'If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created' preferred_allocators: type: array description: List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used) items: type: string preferred_allocator_tags: type: object description: Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators additionalProperties: type: string extended_maintenance: type: boolean description: If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster cluster_reboot: type: string description: Set to 'forced' to force a reboot as part of the upgrade plan enum: - forced override_failsafe: type: boolean description: If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints. description: The configuration settings for the timeout and fallback parameters. RollingGrowShrinkStrategyConfig: type: object description: A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity. KibanaClusterPlansInfo: type: object required: - healthy - history properties: healthy: type: boolean description: Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed) current: $ref: '#/components/schemas/KibanaClusterPlanInfo' pending: $ref: '#/components/schemas/KibanaClusterPlanInfo' history: type: array items: $ref: '#/components/schemas/KibanaClusterPlanInfo' description: Information about the current, pending, or past Kibana instance plans. ElasticsearchClusterSecurityInfo: type: object required: - last_modified - roles - users - users_roles - version properties: version: type: integer format: int32 description: The resource version number of the security settings last_modified: type: string format: date-time description: The most recent time the security settings were changed (ISO format in UTC) users: type: array items: $ref: '#/components/schemas/ElasticsearchClusterUser' roles: type: object description: An arbitrarily nested JSON object mapping roles to sets of resources and permissions - see the Elasticsearch security documentation for more details on roles properties: {} users_roles: type: array items: $ref: '#/components/schemas/ElasticsearchClusterRole' description: For 2.x Elasticsearch clusters, specifies the information about the users and roles. For 5.x Elasticsearch clusters, use the Kibana management UI. ClusterInstanceDiskInfo: type: object required: - disk_space_used - storage_multiplier properties: disk_space_available: type: integer format: int64 description: If known, the amount of total disk space available to the container in MB disk_space_used: type: integer format: int64 description: The amount of disk space being used by the service in MB storage_multiplier: type: number format: double description: The storage multiplier originally defined to calculate disk space. description: Information about the use and storage capacity of a Kibana instance or APM Server. SnapshotDependency: type: object required: - cluster_id - repository_name properties: cluster_id: type: string description: Elasticsearch cluster id deployment_id: type: string description: Deployment id deployment_name: type: string description: Deployment name repository_name: type: string description: The name of the snapshot repository in Elasticsearch (e.g. _clone_abcd1234) description: The additional resource of Elasticsearch cluster. DeploymentCreateResponse: type: object required: - created - id - name - resources properties: id: type: string description: The id of the deployment name: type: string description: The name of the deployment alias: type: string description: A user-defined deployment alias for user-friendly resource URLs created: type: boolean description: Whether or not the deployment was freshly created resources: type: array description: List of created resources. items: $ref: '#/components/schemas/DeploymentResource' diagnostics: description: Backend diagnostics. Sent if validation is requested. $ref: '#/components/schemas/DeploymentDiagnostics' description: A response returned from the Deployment create endpoint ElasticsearchUserPlugin: type: object required: - elasticsearch_version - name - url properties: name: type: string description: The name of the plugin url: type: string description: The URL of the plugin (must be accessible from the ECE infrastructure) elasticsearch_version: type: string description: The supported Elasticsearch version (must match the version in the plan) description: A list of admin-uploaded plugin objects. OrphanedElasticsearch: type: object required: - dependents - id properties: id: type: string description: The id of the orphaned resource dependents: type: array description: List of orphaned dependent resources items: $ref: '#/components/schemas/ElasticsearchDependant' description: Details about an orphaned Elasticsearch resources. CreateSnapshotDependencyResponse: type: object required: - message properties: message: type: string description: Message indicating the request status description: Response from creating a snapshot dependency DeploymentResourceUserSettingsResponse: type: object properties: user_settings: type: object description: The user-defined settings for the resource properties: {} description: The user-defined settings for a Deployment resource. GrowShrinkStrategyConfig: type: object description: A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances. `GrowShrinkStrategyConfig` is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. KibanaPayload: type: object required: - elasticsearch_cluster_ref_id - plan - ref_id - region properties: ref_id: type: string description: A locally-unique user-specified id for Kibana elasticsearch_cluster_ref_id: type: string description: Alias to the Elasticsearch Cluster to attach Kibana to display_name: type: string description: 'The human readable name for the Kibana cluster (default: takes the name of its Elasticsearch cluster)' region: type: string description: The region where this resource exists plan: $ref: '#/components/schemas/KibanaClusterPlan' settings: description: The settings for building this Kibana cluster $ref: '#/components/schemas/KibanaClusterSettings' description: A Kibana creation request paired with the alias of the Elasticsearch cluster it should be paired with ClusterSnapshotRetention: type: object properties: snapshots: type: integer format: int32 description: Number of snapshots to retain max_age: type: string description: 'Total retention period for all snapshots, with the format ''length unit'' (space is optional), where unit can be one of: d (day), h (hour), min (minute)' description: Information about the Elasticsearch cluster snapshot retention. DeploymentsSearchResponse: type: object required: - deployments - return_count properties: return_count: type: integer format: int32 description: The number of deployments actually returned, either as deployment instances or as minimalMetadata objects match_count: type: integer format: int32 description: If a query is supplied, then the total number of deployments that matched deployments: type: array items: $ref: '#/components/schemas/DeploymentSearchResponse' minimal_metadata: type: array items: type: object properties: {} cursor: type: string description: To retrieve the next batch of deployments from this search, specify this value in the cursor field of the next search request. For paginated searches, it is recommended to sort on a static and unique field, like deployment or cluster id. A static and unique sort avoids concurrent updates causing a deployment to move across pages and becoming a duplicate or lost entry. The default sort of rank and modified date is often good for getting a particular deployment into the first page, but if a not yet seen deployment is modified in between page requests, then it would be left out from the next page. description: Contains a list of Deployments as result of a search request. DeploymentObservability: type: object required: - healthy properties: healthy: type: boolean description: 'Whether the deployment observability is healthy or not (one or more of the subsections will have healthy: false)' logging: description: The logging information for the deployment $ref: '#/components/schemas/DeploymentLogging' metrics: description: The metrics information for the deployment $ref: '#/components/schemas/DeploymentMetrics' issues: type: array description: General observability health issues for the deployment items: $ref: '#/components/schemas/ObservabilityIssue' description: Observability information for a deployment BasicFailedReplyElement: type: object required: - code - message properties: code: type: string description: A structured code representing the error type that occurred message: type: string description: A human readable message describing the error that occurred fields: type: array description: If the error can be tied to a specific field or fields in the user request, this lists those fields items: type: string ApmInfo: type: object required: - elasticsearch_cluster - external_links - healthy - id - name - plan_info - status - topology properties: id: type: string description: The id of the APM name: type: string description: The name of the APM elasticsearch_cluster: $ref: '#/components/schemas/TargetElasticsearchCluster' deployment_id: type: string description: The id of the deployment that this APM Server belongs to. healthy: type: boolean description: 'Whether the APM is healthy or not (one or more of the info subsections will have healthy: false)' status: type: string description: APM status enum: - initializing - stopping - stopped - rebooting - restarting - reconfiguring - started plan_info: $ref: '#/components/schemas/ApmPlansInfo' metadata: $ref: '#/components/schemas/ClusterMetadataInfo' topology: $ref: '#/components/schemas/ClusterTopologyInfo' external_links: type: array description: External resources related to the APM uniqueItems: true items: $ref: '#/components/schemas/ExternalHyperlink' links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' settings: description: The cluster metadata settings for the APM $ref: '#/components/schemas/ApmSettings' region: type: string description: The region that this APM belongs to. Only populated in SaaS or federated ECE. apm_server_mode: type: string description: The mode APM is operating in. enum: - standalone - managed description: The overview information for the APM Server. ClusterPlanWarning: type: object required: - code - message properties: code: type: string description: A unique warning code message: type: string description: A description of the warning step_id: type: string description: The ID of the step which produced a warning, if any description: Information about a warning from a plan. ElasticsearchCuration: type: object required: - from_instance_configuration_id - to_instance_configuration_id properties: from_instance_configuration_id: type: string description: The source instance configuration to_instance_configuration_id: type: string description: The destination instance configuration description: The structure that defines the routing settings for index curation. ElasticsearchMasterInfo: type: object required: - healthy - instances_with_no_master - masters properties: healthy: type: boolean description: Whether the master situation in the cluster is healthy (ie is the number of masters != 1), or do any instances have no master masters: type: array items: $ref: '#/components/schemas/ElasticsearchMasterElement' instances_with_no_master: type: array description: A list of any instances with no master items: type: string description: Information about the master nodes in the Elasticsearch cluster. InstanceConfigurationInfo: type: object required: - discrete_sizes - name properties: id: type: string description: Unique identifier for the instance configuration name: type: string description: Display name for the instance configuration. config_version: type: integer format: int32 description: If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty. description: type: string description: Optional description for the instance configuration instance_type: type: string description: The type of instance. For instance configurations where the type is specified in the 'id', the default value of 'instance_type' will be automatically inferred. enum: - elasticsearch - kibana - apm - integrations_server - appsearch - enterprise_search node_types: type: array description: Node types (master, data) for the instance. For instance configurations where the type (and tier) is specified in the 'id', the default value of 'node_types' will be automatically inferred. items: type: string discrete_sizes: description: Numerics representing possible instance sizes that the instance configuration supports. $ref: '#/components/schemas/DiscreteSizes' storage_multiplier: type: number format: double description: Settings for the instance storage multiplier cpu_multiplier: type: number format: double description: Settings for the instance CPU multiplier metadata: type: object description: Optional arbitrary metadata to associate with this template. properties: {} max_zones: type: integer format: int32 description: The maximum number of availability zones in which this instance configuration has allocators. This field will be missing unless explicitly requested with the show_max_zones parameter. readOnly: true description: The configuration template for Elasticsearch instances, Kibana instances, and APM Servers. EnterpriseSearchSettings: type: object properties: metadata: $ref: '#/components/schemas/ClusterMetadataSettings' description: The settings for the Enterprise Search. IntegrationsServerPayload: type: object required: - elasticsearch_cluster_ref_id - plan - ref_id - region properties: ref_id: type: string description: A locally-unique user-specified id for the Integrations Server elasticsearch_cluster_ref_id: type: string description: Alias to the Elasticsearch Cluster to attach the Integrations Server to display_name: type: string description: 'The human readable name for the Integrations Server cluster (default: takes the name of its Elasticsearch cluster)' region: type: string description: The region where this resource exists plan: $ref: '#/components/schemas/IntegrationsServerPlan' settings: description: The settings for building this Integrations Server cluster $ref: '#/components/schemas/IntegrationsServerSettings' description: An Integrations Server creation request paired with the alias of the Elasticsearch cluster it should be paired with PublicCertificate: type: object required: - active - metadata - pem properties: active: type: boolean description: If true, this certificate is the one which has been used to sign the current certificates. Otherwise, it may be the one that will be used when this certificate expires. pem: type: string description: The public certificate as string in PEM format. metadata: description: Metadata about the certificate, including fingerprint and expiry date. Generated by the Cloud service and ignored on write. $ref: '#/components/schemas/CertificateMetaData' description: A certificate used to sign the certificates of this deployment AppSearchTopologyElement: type: object properties: node_type: description: Defines the AppSearch node type $ref: '#/components/schemas/AppSearchNodeTypes' instance_configuration_id: type: string description: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration. instance_configuration_version: type: integer format: int32 description: The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'. size: $ref: '#/components/schemas/TopologySize' zone_count: type: integer format: int32 description: number of zones in which nodes will be placed appsearch: $ref: '#/components/schemas/AppSearchConfiguration' description: Defines the topology of the AppSearch nodes (eg number/capacity of nodes, and where they can be allocated) AutodetectStrategyConfig: type: object description: A strategy that lets constructor choose the most optimal way to execute the plan. ElasticsearchShardElement: type: object required: - instance_name - shard_count properties: instance_name: type: string description: The Elastic Cloud name/id of the instance (container) shard_count: type: integer format: int32 description: The number of shards of the given type (available/unavailable) on this instance description: 'Information about the shards for each Elasticsearch instance container that hosts an Elasticsearch node. TIP: When the shard is unavailable, the cluster is unable to serve all of the data.' ExternalHyperlink: type: object required: - id - label properties: id: type: string description: Identifier of the external link label: type: string description: Human-readable description of the external link uri: type: string description: hyperlink to an external resource TransientAppSearchPlanConfiguration: type: object properties: strategy: $ref: '#/components/schemas/PlanStrategy' plan_configuration: $ref: '#/components/schemas/AppSearchPlanControlConfiguration' description: Defines configuration parameters that control how the plan (ie consisting of the cluster topology and AppSearch settings) is applied ApmResourceInfo: type: object required: - elasticsearch_cluster_ref_id - id - info - ref_id - region properties: ref_id: type: string description: The locally-unique user-specified id of a Resource elasticsearch_cluster_ref_id: type: string description: The Elasticsearch cluster that this resource depends on. id: type: string description: The randomly-generated id of a Resource region: type: string description: The region where this resource exists info: description: Info for the resource. $ref: '#/components/schemas/ApmInfo' description: Describes an APM resource belonging to a Deployment ClusterMetadataInfo: type: object required: - last_modified - version properties: version: type: integer format: int32 description: The resource version number of the cluster metadata last_modified: type: string format: date-time description: The most recent time the cluster metadata was changed (ISO format in UTC) endpoint: type: string description: The DNS name of the cluster endpoint, if available service_url: type: string description: The full URL to access this deployment resource aliased_endpoint: type: string description: The DNS name of the cluster endpoint derived from the deployment alias, if available aliased_url: type: string description: The full aliased URL to access this deployment resource cloud_id: type: string description: The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist) raw: type: object description: 'An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the `raw` field can change at any time. ' properties: {} ports: description: The ports that allow communication with the cluster using various protocols. $ref: '#/components/schemas/ClusterMetadataPortInfo' services_urls: type: array description: A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available items: $ref: '#/components/schemas/ServiceUrl' description: Information about the public and internal state, and the configuration settings of an Elasticsearch cluster. ElasticsearchClusterPlansInfo: type: object required: - healthy - history properties: healthy: type: boolean description: Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed) current: $ref: '#/components/schemas/ElasticsearchClusterPlanInfo' pending: $ref: '#/components/schemas/ElasticsearchClusterPlanInfo' history: type: array items: $ref: '#/components/schemas/ElasticsearchClusterPlanInfo' description: Information about the current, pending, and past Elasticsearch cluster plans. ClusterInstanceConfigurationInfo: type: object required: - id - name - resource properties: id: type: string description: The id of the configuration used to create the instance name: type: string description: The name of the configuration used to create the instance config_version: type: integer format: int32 description: If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty. resource: type: string description: The resource type of the instance configuration enum: - memory - storage description: Information about a configuration that creates a Kibana instance or APM Server. RestoreSnapshotRepoConfiguration: type: object properties: raw_settings: type: object description: The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats properties: {} description: Configures the location of a remote repository. The default is the system repository. TrustedCertificate: type: object required: - pem properties: pem: type: string description: The public ca certificate as string in PEM format. metadata: description: Metadata about the certificate, including fingerprint and expiry date. Generated by the Cloud service and ignored on write. readOnly: true $ref: '#/components/schemas/CertificateMetaData' description: An x509 certificate used by a DirectTrustRelationship TiersResponse: type: object properties: hot_content: description: Configuration for the hot_content tier $ref: '#/components/schemas/TierInfo' warm: description: Configuration for the warm tier $ref: '#/components/schemas/TierInfo' cold: description: Configuration for the cold tier $ref: '#/components/schemas/TierInfo' frozen: description: Configuration for the frozen tier $ref: '#/components/schemas/TierInfo' master: description: Configuration for the master tier $ref: '#/components/schemas/TierInfo' coordinating: description: Configuration for the coordinating tier $ref: '#/components/schemas/TierInfo' ml: description: Configuration for the ml tier $ref: '#/components/schemas/TierInfo' description: Size configuration of Elasticsearch tiers in a deployment. Disabled tiers are omitted from responses. EnableIlmRequest: type: object required: - index_patterns properties: index_patterns: type: array description: A locally-unique user-specified id for Kibana items: $ref: '#/components/schemas/IndexPattern' description: Request sent to enable ILM on a deployment. EnterpriseSearchPlanInfo: type: object required: - healthy - plan_attempt_log - warnings properties: plan_attempt_id: type: string description: A UUID for each plan attempt plan_attempt_name: type: string description: A human readable name for each plan attempt, only populated when retrieving plan histories healthy: type: boolean description: Either the plan ended successfully, or is not yet completed (and no errors have occurred) attempt_start_time: type: string format: date-time description: When this plan attempt (ie to apply the plan to the Enterprise Search) started (ISO format in UTC) attempt_end_time: type: string format: date-time description: If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC) plan_end_time: type: string format: date-time description: If this plan is not current or pending, when the plan was no longer active (ISO format in UTC) plan: $ref: '#/components/schemas/EnterpriseSearchPlan' plan_attempt_log: type: array items: $ref: '#/components/schemas/ClusterPlanStepInfo' source: description: Information describing the source that facilitated the plans current state $ref: '#/components/schemas/ChangeSourceInfo' warnings: type: array items: $ref: '#/components/schemas/ClusterPlanWarning' error: $ref: '#/components/schemas/ClusterPlanAttemptError' description: Information about the Enterprise Search Server plan. MatchAllQuery: type: object description: A query that matches all documents. ApmSettings: type: object properties: metadata: $ref: '#/components/schemas/ClusterMetadataSettings' description: The settings for the APM Server. CreateSnapshotDependencyRequest: type: object required: - source_deployment_id properties: source_deployment_id: type: string description: Source deployment ID whose snapshots will be accessible from the target cluster description: Request to create a snapshot dependency between deployments ClusterInstanceInfo: type: object required: - container_started - healthy - instance_name - maintenance_mode - service_running properties: instance_name: type: string description: The name of the instance in Elastic Cloud instance_configuration: $ref: '#/components/schemas/ClusterInstanceConfigurationInfo' service_version: type: string description: The version of the service that the instance is running (eg Elasticsearch or Kibana), if available healthy: type: boolean description: Whether the instance is healthy (ie started and running) container_started: type: boolean description: Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container) service_running: type: boolean description: Whether the service launched inside the container -ie Elasticsearch- is actually running maintenance_mode: type: boolean description: Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it) zone: type: string description: The zone in which this instance is being allocated allocator_id: type: string description: The id of the allocator on which this instance is running (if the container is started or starting) memory: $ref: '#/components/schemas/ClusterInstanceMemoryInfo' disk: $ref: '#/components/schemas/ClusterInstanceDiskInfo' service_roles: type: array description: 'List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml' items: type: string node_roles: type: array description: A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch. items: type: string enum: - master - ingest - ml - data_hot - data_content - data_warm - data_cold - data_frozen - remote_cluster_client - transform - voting_only instance_overrides: description: Instance overrides $ref: '#/components/schemas/InstanceOverrides' description: Information about each Kibana instance and APM Server in the Elasticsearch cluster. ServiceUrl: type: object required: - service - url properties: service: type: string description: Name of the service url: type: string description: The full URL to access the service description: A URL to access the service of a resource RollingStrategyConfig: type: object properties: group_by: type: string description: Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '\_\_all\_\_' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '\_\_name\_\_' (roll one instance at a time, the default if not specified). Note that '\_\_all\_\_' is required when performing a major version upgrade allow_inline_resize: type: boolean description: 'Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing' skip_synced_flush: type: boolean description: 'Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy' shard_init_wait_time: type: integer format: int64 description: 'The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)' description: 'Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and ''group_by'' is set to ''pass:macros[__all__]'';, rolling is required.' ApmPlan: type: object required: - apm properties: cluster_topology: type: array items: $ref: '#/components/schemas/ApmTopologyElement' apm: $ref: '#/components/schemas/ApmConfiguration' transient: $ref: '#/components/schemas/TransientApmPlanConfiguration' description: The plan for the APM Server. KibanaSystemSettings: type: object properties: elasticsearch_username: type: string description: Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only. elasticsearch_password: type: string description: Optionally override the account within Elasticsearch - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only. description: 'A subset of Kibana settings. TIP: To define the complete set of Elasticsearch settings, use `KibanaSystemSettings` with `user_settings_override_` and `user_settings_`.' IntegrationsServerPlanControlConfiguration: type: object properties: timeout: type: integer format: int64 description: The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB) calm_wait_time: type: integer format: int64 description: This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s move_instances: type: array items: $ref: '#/components/schemas/InstanceMoveRequest' move_allocators: type: array items: $ref: '#/components/schemas/AllocatorMoveRequest' reallocate_instances: type: boolean description: 'If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created' preferred_allocators: type: array description: List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used) items: type: string preferred_allocator_tags: type: object description: Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators additionalProperties: type: string extended_maintenance: type: boolean description: If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster cluster_reboot: type: string description: Set to 'forced' to force a reboot as part of the upgrade plan enum: - forced override_failsafe: type: boolean description: If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints. description: The plan control configuration options for the Integrations Server. ClusterSystemAlert: type: object required: - alert_type - instance_name - timestamp properties: timestamp: type: string format: date-time description: Timestamp marking the system alert instance_name: type: string description: Instance that caused the system alert alert_type: type: string description: Type of system alert enum: - automatic_restart - heap_dump - unknown_event url: type: string description: 'The URL related to the event. Only applicable for alert_type: heap_dump' exit_code: type: integer format: int32 description: 'The exit_code related to the event. Only applicable for alert_type: slain' description: Information about a system alert on an Elasticsearch cluster. DeploymentCreateSettings: type: object properties: traffic_filter_settings: description: The traffic filter rulesets to apply to this deployment. $ref: '#/components/schemas/TrafficFilterSettings' observability: description: Observability settings for this deployment $ref: '#/components/schemas/DeploymentObservabilitySettings' byok: description: BYOK settings for this deployment. Not supported on ECE. $ref: '#/components/schemas/ByokSettings' autoscaling_enabled: type: boolean description: Enable autoscaling for this deployment. solution_type: type: string description: 'An optional string that declares the deployment''s expected application. Example supported values are: elasticsearch, observability, security.' description: Additional configuration for the new deployment object. ClusterSnapshotRepositoryStatic: type: object properties: repository_type: type: string description: 'Type of snapshot repository, ie: S3' settings: type: object description: Settings associated with snapshot repository properties: {} description: The static object for the Elasticsearch cluster snapshot repository. AppSearchResourceInfo: type: object required: - elasticsearch_cluster_ref_id - id - info - ref_id - region properties: ref_id: type: string description: The locally-unique user-specified id of a Resource elasticsearch_cluster_ref_id: type: string description: The Elasticsearch cluster that this resource depends on. id: type: string description: The randomly-generated id of a Resource region: type: string description: The region where this resource exists info: description: Info for the resource. $ref: '#/components/schemas/AppSearchInfo' description: Describes an App Search resource belonging to a Deployment DeploymentRestoreResponse: type: object required: - id properties: id: type: string description: The id of the deployment description: A response returned from the Deployment restore endpoint ClusterMetadataPortInfo: type: object required: - http - https - transport_passthrough properties: http: type: integer format: int32 description: Port where the cluster listens for HTTP traffic https: type: integer format: int32 description: Port where the cluster listens for HTTPS traffic transport_passthrough: type: integer format: int32 description: Port where the cluster listens for transport traffic using TLS description: Information about the ports that allow communication between the Elasticsearch cluster and various protocols. KibanaClusterSettings: type: object properties: metadata: $ref: '#/components/schemas/ClusterMetadataSettings' description: The settings for multiple Kibana instances. ApmPayload: type: object required: - elasticsearch_cluster_ref_id - plan - ref_id - region properties: ref_id: type: string description: A locally-unique user-specified id for APM elasticsearch_cluster_ref_id: type: string description: Alias to the Elasticsearch Cluster to attach APM to display_name: type: string description: 'The human readable name for the APM cluster (default: takes the name of its Elasticsearch cluster)' region: type: string description: The region where this resource exists plan: $ref: '#/components/schemas/ApmPlan' settings: description: The settings for building this APM cluster $ref: '#/components/schemas/ApmSettings' description: An APM creation request paired with the alias of the Elasticsearch cluster it should be paired with DirectTrustRelationship: type: object required: - certificates - name - trust_all properties: uid: type: string description: Auto generated identifier for this trust, allows distinguishing between update vs remove and add. name: type: string description: a human readable name of the trust relationship type: type: string description: The type can either be ESS, ECE, generic or proxy. If none is specified, then generic is assumed. If proxy is specified, trust_all should be false and trust_allowlist, scope_id and additional_node_names should be omitted. enum: - ECE - ESS - generic - proxy trust_all: type: boolean description: If true, scope_id is required and the `trust_allowlist` is ignored and all clusters matching the scope id will be trusted. trust_allowlist: type: array description: The list of clusters with matching scope to trust. Only used when `trust_all` is false. Providing one or more clusters makes scope_id mandatory. items: type: string scope_id: type: string example: abc123 description: A lowercase alphanumerical string of max 32 characters. Usually an organization id or an environment id, but could really be any suitable suffix for clusters using the CA certificate of this trust. Required unless trust_all is false and trust_allowlist is empty. additional_node_names: type: array description: A list of node names trusted in addition to those deducible from trust_allowlist and scope id. Allows trusting nodes that don't have a scoped name at the cost of maintaining the list. Mandatory if scope id is not defined. Wildcards are not allowed. items: type: string certificates: type: array description: The public ca certificate(s) to trust. Only one is required, but it is possible to specify multiple certificates in order to facilitate key rotation. items: $ref: '#/components/schemas/TrustedCertificate' description: The trust relationship with entities trusted directly having their certificate bundled together with the trust settings. SnapshotDependencyConfiguration: type: object required: - source_cluster_id properties: source_cluster_id: type: string description: The cluster ID of the source cluster whose snapshots will be made available description: Configuration for attaching a snapshot repository dependency from another cluster. This creates a snapshot repository in the target cluster pointing to the source cluster's snapshots. ClusterSnapshotSettings: type: object properties: repository: description: Snapshot repository configuration $ref: '#/components/schemas/ClusterSnapshotRepositoryInfo' interval: type: string description: 'Interval between snapshots, with the format ''length unit'' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 30 minutes' pending_interval: type: string description: 'Interval between snapshot progress checks, with the format ''length unit'' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 1 minute' wait_time_after_snapshotting: type: string description: 'The time to wait between snapshot phases (snapshot, purge), with the format ''length unit'' (space is optional), where unit can be one of: d (day), h (hour), min (minute). Default is 10 minutes' enabled: type: boolean description: Indicates if Snapshotting is enabled suspended: type: array description: List of temporary snapshot suspensions items: type: string retention: description: Cluster snapshot retention information $ref: '#/components/schemas/ClusterSnapshotRetention' slm: type: boolean description: When set to true, the deployment will have SLM enabled. Default value is true. readOnly: true cron_expression: type: string description: Cron expression indicating when should snapshots be taken. This can be enabled only if SLM is enabled for the deployment and 'interval' is not present description: The snapshot configuration settings for an Elasticsearch cluster. ByokSettings: type: object required: - key_resource_path properties: key_resource_path: type: string description: Key path (i.e arn:aws:kms:us-east-1:1234567890:key/12345678-0000-0000-0000-000000000000). description: Information required to create a Bring Your Own Key (BYOK) deployment. KeystoreSecret: type: object properties: value: type: object description: 'Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.' properties: {} as_file: type: boolean description: Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object. is_allowlisted: type: boolean description: Read-only field, ignored on write. Only returned when calling the set-deployment-es-resource-keystore endpoint with `validate_only=true`. True if this setting/value pair is allowlisted (the allowlist is for informational purposes). is_reloadable: type: boolean description: Read-only field, ignored on write. Only returned when calling the set-deployment-es-resource-keystore endpoint with `validate_only=true`. True if this setting is reloadable, or if false it requires a cluster restart. description: The value that you configure for the Elasticsearch keystore secret. Hyperlink: type: object properties: need_elevated_permissions: type: boolean description: Whether the operation requires elevated permissions (when the field is present, elevated permissions are required). ApmSystemSettings: type: object properties: elasticsearch_username: type: string description: Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only. elasticsearch_password: type: string description: Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only. secret_token: type: string description: Optionally override the secret token within APM - defaults to the previously existing secretToken debug_enabled: type: boolean description: Optionally enable debug mode for APM servers - defaults false description: "A structure that defines a curated subset of the APM Server settings. \nTIP: To define the complete set of APM Server setting, use `ApmSystemSettings` with `user_settings_override_` and `user_settings_`." ElasticsearchMonitoringInfo: type: object required: - destination_cluster_ids - healthy - last_modified - last_update_status - source_cluster_ids properties: healthy: type: boolean description: Whether the Monitoring configuration has been successfully applied last_modified: type: string format: date-time description: The time the monitoring configuration was last changed last_update_status: type: string description: The status message from the last update (successful or not) source_cluster_ids: type: array description: The list of clusters Ids from which this cluster is currently receiving monitoring data items: type: string destination_cluster_ids: type: array description: The list of clusters Ids to which this cluster is currently sending monitoring data items: type: string description: Information about the monitoring status for the Elasticsearch cluster. ElasticsearchMasterElement: type: object required: - instances - master_node_id properties: master_node_id: type: string description: The Elasticsearch node id of a master node master_instance_name: type: string description: The corresponding instance name of the container hosting the Elasticsearch master node, if available instances: type: array description: The names of the instance/container hosting the node belong to the cluster with the given master items: type: string description: Information about the Elasticsearch instances. For split-brain cases, this also includes sub-clusters. EnterpriseSearchNodeTypes: type: object required: - appserver - connector - worker properties: appserver: type: boolean description: Defines whether this instance should run as Application/API server worker: type: boolean description: Defines whether this instance should run as background worker connector: type: boolean description: Defines whether this instance should run as Connector description: Node types to enable for an Enterprise Search instance ClusterMetadataSettings: type: object properties: name: type: string description: The display name of the cluster owner_id: type: string description: The user id (referencing whatever user database is in use) of the cluster owner organization_id: type: string description: The organization that owns the deployment readOnly: true subscription_level: type: string description: Subscription level of the cluster system_owned: type: boolean description: Indicates if a cluster is system owned (restricts the set of operations that can be performed on it) contact_email: type: string description: Contact email for the cluster hidden: type: boolean description: Whether or not this cluster is hidden from the normal clusters list readOnly: true resources: $ref: '#/components/schemas/ClusterMetadataResourcesSettings' description: The top-level configuration settings for the Elasticsearch cluster. ElasticsearchPlanControlConfiguration: type: object properties: timeout: type: integer format: int64 description: 'The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.' calm_wait_time: type: integer format: int64 description: This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s move_instances: type: array items: $ref: '#/components/schemas/InstanceMoveRequest' move_allocators: type: array items: $ref: '#/components/schemas/AllocatorMoveRequest' move_only: type: boolean description: 'If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored' reallocate_instances: type: boolean description: 'If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created' preferred_allocators: type: array description: List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used) items: type: string preferred_allocator_tags: type: object description: Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators additionalProperties: type: string skip_snapshot: type: boolean description: 'If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster' max_snapshot_attempts: type: integer format: int32 description: 'If taking a snapshot (ie unless ''skip_snapshots'': true) then will retry on failure at most this number of times (default: 5)' max_snapshot_age: type: integer format: int64 description: When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300 extended_maintenance: type: boolean description: If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster cluster_reboot: type: string description: 'Set to ''forced'' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting ''transient.plan_configuration.cluster_reboot'': ''forced'' will reboot the cluster)' enum: - forced override_failsafe: type: boolean description: If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints skip_data_migration: type: boolean description: 'If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)' skip_upgrade_checker: type: boolean description: If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed skip_post_upgrade_steps: type: boolean description: If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured) skip_snapshot_post_major_upgrade: type: boolean description: If false (the default), the cluster will perform a snapshot after a major version upgrade takes place description: The configuration settings for the timeout and fallback parameters. DeploymentLogging: type: object required: - healthy properties: healthy: type: boolean description: Whether the deployment logging is healthy or not urls: type: object description: The URLs to view this deployment's logs in Kibana additionalProperties: type: string issues: type: array description: Logging health issues for the deployment items: $ref: '#/components/schemas/ObservabilityIssue' description: Logging information for a deployment KibanaClusterPlanInfo: type: object required: - healthy - plan_attempt_log - warnings properties: plan_attempt_id: type: string description: A UUID for each plan attempt plan_attempt_name: type: string description: A human readable name for each plan attempt, only populated when retrieving plan histories healthy: type: boolean description: Either the plan ended successfully, or is not yet completed (and no errors have occurred) attempt_start_time: type: string format: date-time description: When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC) attempt_end_time: type: string format: date-time description: If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC) plan_end_time: type: string format: date-time description: If this plan is not current or pending, when the plan was no longer active (ISO format in UTC) plan: $ref: '#/components/schemas/KibanaClusterPlan' plan_attempt_log: type: array items: $ref: '#/components/schemas/ClusterPlanStepInfo' source: description: Information describing the source that facilitated the plans current state $ref: '#/components/schemas/ChangeSourceInfo' warnings: type: array items: $ref: '#/components/schemas/ClusterPlanWarning' error: $ref: '#/components/schemas/ClusterPlanAttemptError' description: Information about the current, pending, or past Kibana instance plan. IntegrationsServerPlan: type: object required: - integrations_server properties: cluster_topology: type: array items: $ref: '#/components/schemas/IntegrationsServerTopologyElement' integrations_server: $ref: '#/components/schemas/IntegrationsServerConfiguration' transient: $ref: '#/components/schemas/TransientIntegrationsServerPlanConfiguration' description: The plan for the Integrations Server. TrafficFilterSettings: type: object required: - rulesets properties: rulesets: type: array description: IDs of the traffic filter rulesets items: type: string description: The configuration settings for the traffic filter. TransientKibanaPlanConfiguration: type: object properties: strategy: $ref: '#/components/schemas/PlanStrategy' plan_configuration: $ref: '#/components/schemas/KibanaPlanControlConfiguration' description: Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Kibana instance settings. IntegrationsServerTopologyElement: type: object properties: instance_configuration_id: type: string description: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration. instance_configuration_version: type: integer format: int32 description: The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'. size: $ref: '#/components/schemas/TopologySize' zone_count: type: integer format: int32 description: number of zones in which nodes will be placed integrations_server: $ref: '#/components/schemas/IntegrationsServerConfiguration' description: Defines the topology of the Integrations Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes. TransientIntegrationsServerPlanConfiguration: type: object properties: strategy: $ref: '#/components/schemas/PlanStrategy' plan_configuration: $ref: '#/components/schemas/IntegrationsServerPlanControlConfiguration' description: Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Integrations Server settings. DeploymentSettings: type: object required: - auto_ops properties: traffic_filter_settings: description: The traffic filter rulesets for this deployment. $ref: '#/components/schemas/TrafficFilterSettings' observability: description: Logging and monitoring settings for this deployment. $ref: '#/components/schemas/DeploymentObservabilitySettings' autoscaling_enabled: type: boolean description: If autoscaling is enabled for this deployment. auto_ops: description: See AutoOps integration status for this deployment. $ref: '#/components/schemas/AutoOpsSettings' byok: description: Bring Your Own Key (BYOK) settings for this deployment. Not supported on ECE. $ref: '#/components/schemas/ByokSettings' solution_type: type: string description: 'An optional string that declares the deployment''s expected application. Example supported values are: elasticsearch, observability, security.' description: Additional configuration about the current deployment object. RestoreSnapshotApiConfiguration: type: object properties: indices: type: array description: The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation) items: type: string raw_settings: type: object description: This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats properties: {} description: The configuration for the restore command, such as which indices you want to restore. DeploymentTagsResponse: type: object properties: tags: type: array description: Arbitrary user-defined metadata associated with this deployment items: $ref: '#/components/schemas/MetadataItem' description: A response returned from the Deployment tags endpoints DeploymentUpdateRequest: type: object required: - prune_orphans properties: name: type: string description: A new name for the deployment, otherwise stays the same. prune_orphans: type: boolean description: Whether or not to prune orphan resources that are no longer mentioned in this request. Note that resourcesare tracked by ref_id, and if a resource's ref_id is changed, any previous running resources created with that previousref_id are considered to be orphaned as well. resources: description: New information about the Resources that will have this Deployment, otherwise they stay the same $ref: '#/components/schemas/DeploymentUpdateResources' settings: description: Any new configuration for the current deployment object. If there is no new configuration the value is unchanged. $ref: '#/components/schemas/DeploymentUpdateSettings' metadata: description: Any new information about the current deployment object. If there is no new information the value is unchanged. $ref: '#/components/schemas/DeploymentUpdateMetadata' alias: type: string description: A user-defined alias to use in place of Cluster IDs for user-friendly URLs description: A request for updating a Deployment consisting of multiple resources SearchRequest: type: object properties: from: type: integer format: int32 description: Deprecated, use cursor for a more scalable approach to paging. cursor: type: string description: To retrieve the next page of hits, set this to the cursor value of the previous response. When set, all other fields are ignored. size: type: integer format: int32 description: The maximum number of search results to return. query: $ref: '#/components/schemas/QueryContainer' sort: type: array description: An array of fields to sort the search results by. Defaults to query rank and last modified date descending. items: type: object properties: {} description: An Elasticsearch search request with a subset of options. KibanaSubClusterInfo: type: object required: - enabled - kibana_id properties: kibana_id: type: string description: The Kibana cluster Id enabled: type: boolean description: Whether the associated Kibana cluster is currently available links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' description: Information about the Kibana instances associated with the Elasticsearch cluster. ClusterTopologyInfo: type: object required: - healthy - instances properties: healthy: type: boolean description: Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available instances: type: array items: $ref: '#/components/schemas/ClusterInstanceInfo' description: The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The `ClusterTopologyInfo` also includes the instances and containers, and where they are located. EnterpriseSearchSubInfo: type: object required: - enabled - enterprise_search_id properties: enterprise_search_id: type: string description: The Enterprise Search Id enabled: type: boolean description: Whether the associated Enterprise Search is currently available links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' description: Information about the APM Servers associated with the Elasticsearch cluster. AppSearchNodeTypes: type: object required: - appserver - worker properties: appserver: type: boolean description: Defines whether this instance should run as Application/API server worker: type: boolean description: Defines whether this instance should run as background worker description: Node types to enable for an AppSearch instance ElasticsearchClusterSettings: type: object properties: snapshot: description: The snapshot settings for this deployment. When provided, snapshot settings are changed as specified. A `null` value reverts the field to the default value. Otherwise, all snapshot settings remain as they were set previously. $ref: '#/components/schemas/ClusterSnapshotSettings' monitoring: description: The monitoring settings for this deployment. When provided, monitoring settings are changed as specified. A `null` value reverts the field to the default value. Otherwise, all monitoring settings remain as they were set previously. $ref: '#/components/schemas/ManagedMonitoringSettings' metadata: $ref: '#/components/schemas/ClusterMetadataSettings' curation: description: The curation settings for this deployment. When provided, curation settings are changed as specified. A `null` value reverts the field to the default value. Otherwise, all curation settings remain as they were set previously. $ref: '#/components/schemas/ClusterCurationSettings' dedicated_masters_threshold: type: integer format: int32 description: Threshold starting from which the number of instances in the cluster results in the introduction of dedicated masters. If the cluster is downscaled to a number of nodes below this one, dedicated masters will be removed. Limit is inclusive. When provided the threshold setting is updated. A `null` value removes the field. Otherwise, the setting remains as it was set previously. traffic_filter: description: The rulesets to apply to all resources in this cluster. When specified, the set of rulesets is updated and the same rulesets will be applied to Kibana and APM clusters as well. If not specified, the rulesets remain as they were set previously. $ref: '#/components/schemas/TrafficFilterSettings' trust: description: Configuration of trust with other clusters. When provided, trust settings are changed as specified. A `null` value reverts the field to the default value. Otherwise, all trust settings remain as they were set previously. $ref: '#/components/schemas/ElasticsearchClusterTrustSettings' keystore_contents: description: The contents of the Elasticsearch keystore. It's a write only field. $ref: '#/components/schemas/KeystoreContents' description: The settings for an Elasticsearch cluster. DeploymentCreateRequest: type: object properties: name: type: string description: A name for the deployment; otherwise this will be the generated deployment id resources: description: The Resources that will belong to this Deployment $ref: '#/components/schemas/DeploymentCreateResources' settings: description: Additional configuration for this Deployment $ref: '#/components/schemas/DeploymentCreateSettings' metadata: description: Additional information about this deployment $ref: '#/components/schemas/DeploymentCreateMetadata' alias: type: string description: A user-defined alias to use in place of Cluster IDs for user-friendly URLs region: type: string description: Identifier of the region to be used as the default for all the resources of the deployment version: type: string description: The version for all the resources of the deployment (must be one of the supported versions). Defaults to the latest version if not specified. description: A request for creating a new Deployment consisting of multiple clusters SnapshotStatusInfo: type: object required: - count - healthy - recent_success properties: healthy: type: boolean description: Health status of snapshots for this cluster count: type: integer format: int32 description: Number of snapshots stored for this cluster latest_successful: type: boolean description: Latest snapshot status latest_status: type: string description: Status of the latest snapshot attempt, if any exist. scheduled_time: type: string format: date-time description: Scheduled time of next snapshot attempt latest_end_time: type: string format: date-time description: The end time of the most recently attempted snapshot latest_successful_end_time: type: string format: date-time description: The end time of the most recently successful snapshot recent_success: type: boolean description: Indicates whether the cluster has a relatively recent successful snapshot. description: Information about the snapshot status for the Elasticsearch cluster. For example, the health status. EnterpriseSearchPlanControlConfiguration: type: object properties: timeout: type: integer format: int64 description: The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB) calm_wait_time: type: integer format: int64 description: This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s move_instances: type: array items: $ref: '#/components/schemas/InstanceMoveRequest' move_allocators: type: array items: $ref: '#/components/schemas/AllocatorMoveRequest' reallocate_instances: type: boolean description: 'If true (default: false) does not allow re-using any existing instances currently in the cluster, i.e. even unchanged instances will be re-created' preferred_allocators: type: array description: List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used) items: type: string preferred_allocator_tags: type: object description: Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators additionalProperties: type: string extended_maintenance: type: boolean description: If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster cluster_reboot: type: string description: Set to 'forced' to force a reboot as part of the upgrade plan enum: - forced override_failsafe: type: boolean description: If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints. Orphaned: type: object required: - apm - appsearch - elasticsearch - enterprise_search - integrations_server - kibana properties: elasticsearch: type: array description: List of orphaned Elasticsearch resources items: $ref: '#/components/schemas/OrphanedElasticsearch' kibana: type: array description: List of orphaned Kibana resource ids items: type: string apm: type: array description: List of orphaned APM resource ids items: type: string appsearch: type: array description: List of orphaned AppSearch resource ids items: type: string enterprise_search: type: array description: List of orphaned Enterprise Search resource ids items: type: string integrations_server: type: array description: List of orphaned Integrations Server resource ids items: type: string description: Details about orphaned resources. DeploymentGetResponse: type: object required: - healthy - id - name - resources properties: id: type: string description: A randomly-generated id of this Deployment name: type: string description: The name of this deployment alias: type: string description: A user-defined deployment alias for user-friendly resource URLs healthy: type: boolean description: 'Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)' resources: description: The Resources that belong to this Deployment $ref: '#/components/schemas/DeploymentResources' settings: description: Additional configuration for this Deployment $ref: '#/components/schemas/DeploymentSettings' metadata: description: Additional information about this deployment $ref: '#/components/schemas/DeploymentMetadata' observability: description: The observability information for this deployment $ref: '#/components/schemas/DeploymentObservability' instance_configurations: type: array description: List of instance configurations used in the deployment. items: $ref: '#/components/schemas/InstanceConfigurationInfo' description: Describes a given Deployment AccountTrustRelationship: type: object required: - account_id - trust_all properties: account_id: type: string description: the ID of the Account name: type: string description: A human readable name of the trust relationship trust_all: type: boolean description: If true, all clusters in this account will by default be trusted and the `trust_allowlist` is ignored. trust_allowlist: type: array description: The list of clusters to trust. Only used when `trust_all` is false. items: type: string description: The trust relationship with the clusters of one account. RemoteResources: type: object required: - resources properties: resources: type: array description: The remote resources items: $ref: '#/components/schemas/RemoteResourceRef' description: The list of resources used as remote clusters AppSearchPlansInfo: type: object required: - healthy - history properties: healthy: type: boolean description: Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed) current: $ref: '#/components/schemas/AppSearchPlanInfo' pending: $ref: '#/components/schemas/AppSearchPlanInfo' history: type: array items: $ref: '#/components/schemas/AppSearchPlanInfo' description: Information about current, pending, and past App Search Server plans. ElasticsearchClusterRole: type: object required: - roles - username properties: username: type: string description: The username roles: type: array description: The list of roles for this user items: type: string description: The authorization information for an Elasticsearch cluster user. AppSearchPlanControlConfiguration: type: object properties: timeout: type: integer format: int64 description: The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB) calm_wait_time: type: integer format: int64 description: This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s move_instances: type: array items: $ref: '#/components/schemas/InstanceMoveRequest' move_allocators: type: array items: $ref: '#/components/schemas/AllocatorMoveRequest' reallocate_instances: type: boolean description: 'If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created' preferred_allocators: type: array description: List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used) items: type: string preferred_allocator_tags: type: object description: Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators additionalProperties: type: string extended_maintenance: type: boolean description: If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster cluster_reboot: type: string description: Set to 'forced' to force a reboot as part of the upgrade plan enum: - forced override_failsafe: type: boolean description: If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints. ClusterCurationSettings: type: object required: - specs properties: specs: type: array description: Specifications for curation items: $ref: '#/components/schemas/ClusterCurationSpec' description: The index curation settings for an Elasticsearch cluster. IntegrationsServerSettings: type: object properties: metadata: $ref: '#/components/schemas/ClusterMetadataSettings' description: The settings for the Integrations Server. IndexPattern: type: object required: - index_pattern - policy_name properties: index_pattern: type: string description: Index pattern to which the ILM policy will be applied. policy_name: type: string description: Name of the policy to create node_attributes: type: object description: Defines the Elasticsearch node attributes for the warm element of the topology additionalProperties: type: string description: An index pattern described indicating how it has to be migrated to ILM. DeploymentObservabilitySettings: type: object properties: logging: description: The logging settings for the deployment $ref: '#/components/schemas/DeploymentLoggingSettings' metrics: description: The metrics settings for the deployment $ref: '#/components/schemas/DeploymentMetricsSettings' description: The observability settings for a deployment ObservabilityAbsoluteDeployment: type: object required: - deployment_id properties: deployment_id: type: string description: The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'. ref_id: type: string description: RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource. description: The destination to send logs and metrics to KeystoreContents: type: object required: - secrets properties: secrets: type: object description: List of secrets additionalProperties: $ref: '#/components/schemas/KeystoreSecret' description: The contents of the Elasticsearch keystore. AppSearchSystemSettings: type: object properties: elasticsearch_url: type: string description: Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL) elasticsearch_username: type: string description: Optionally override the account within App Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only. elasticsearch_password: type: string description: Optionally override the account within App Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only. secret_session_key: type: string description: Optionally override the secret session key within App Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only. description: This structure defines a curated subset of the AppSearch settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of AppSearch settings) ElasticsearchBlockingIssueElement: type: object required: - description - level properties: description: type: string description: Description of the block level: type: string description: Applicable level for the block. Either global ie. cluster-wide or index level enum: - index - global description: Information about index or cluster blocks DeploymentResourceCrudResponse: type: object required: - id - kind - ref_id properties: id: type: string description: The id of the deployment kind: type: string description: The kind of the stateless resource ref_id: type: string description: The reference id of the resource description: A response returned from the Deployment Resource endpoints CertificateAuthority: type: object required: - public_certificates - recommended_trust_restriction properties: recommended_trust_restriction: type: string description: The trust restriction expression to use that would provide trust with the Elasticsearch nodes of this deployment public_certificates: type: array description: The certificates used by this certificate authority. The active certificate is the one that has been used to sign the current certificates of the Elasticsearch instances. All others are either certificates used in the past or certificates that will be used in the future when the currently active certificate expires. items: $ref: '#/components/schemas/PublicCertificate' description: The certificate authority used to sign the certificates of this deployment DeploymentUpdateMetadata: type: object properties: system_owned: type: boolean description: Indicates if a deployment is system owned (restricts the set of operations that can be performed on it) hidden: type: boolean description: Whether or not this deployment is hidden from the normal deployment list tags: type: array description: Arbitrary user-defined metadata associated with this deployment items: $ref: '#/components/schemas/MetadataItem' description: Additional information about the current deployment object. ClusterPlanStepLogMessageInfo: type: object required: - details - message - stage - timestamp properties: timestamp: type: string format: date-time description: Timestamp marking on info log of step delta_in_millis: type: integer format: int64 description: Time in milliseconds since previous log message stage: type: string description: Stage that info log message takes place in enum: - starting - completed - in_progress message: type: string description: Human readable log message details: type: object description: A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively. additionalProperties: type: string internal_details: type: object description: A json object with sensitive details for the log, visible only to admins. May contain nested json objects. additionalProperties: type: string failure_type: type: string description: The failure type, in case the step failed description: The log message from a specified stage of an executed step in a plan. DeploymentLoggingSettings: type: object required: - destination properties: destination: description: The destination deployment that this deployment's logs will be sent to $ref: '#/components/schemas/ObservabilityAbsoluteDeployment' description: The logging settings for a deployment ClusterMetadataCpuResourcesSettings: type: object properties: boost: type: boolean description: Indicates if the CPU boost flag is enabled or not. hard_limit: type: boolean description: Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares. description: Specifies the CPU resource settings for the Elasticsearch cluster. NestedQuery: type: object required: - path - query properties: query: description: The actual query to execute on the nested objects. $ref: '#/components/schemas/QueryContainer' path: type: string description: The path to the nested object. score_mode: type: string description: Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details. enum: - avg - sum - min - max - none description: A query that matches nested objects. KibanaResourceInfo: type: object required: - elasticsearch_cluster_ref_id - id - info - ref_id - region properties: ref_id: type: string description: The locally-unique user-specified id of a Resource elasticsearch_cluster_ref_id: type: string description: The Elasticsearch cluster that this resource depends on. id: type: string description: The randomly-generated id of a Resource region: type: string description: The region where this resource exists info: description: Info for the resource. $ref: '#/components/schemas/KibanaClusterInfo' description: Describes an Kibana resource belonging to a Deployment Elasticsearch: type: object required: - backend_plan - display_name - ref_id properties: ref_id: type: string description: A locally-unique user-specified id display_name: type: string description: The human readable name for the cluster (defaults to the generated cluster id if not specified) backend_plan: type: object description: The backend plan as JSON properties: {} description: Holds diagnostics for an Elasticsearch cluster ElasticsearchClusterUser: type: object required: - password_hash - username properties: username: type: string description: The username password_hash: type: string description: The hashed password description: The information about an Elasticsearch cluster user. KibanaClusterPlan: type: object required: - kibana properties: cluster_topology: type: array items: $ref: '#/components/schemas/KibanaClusterTopologyElement' kibana: $ref: '#/components/schemas/KibanaConfiguration' transient: $ref: '#/components/schemas/TransientKibanaPlanConfiguration' description: The plan for the Kibana instance. RangeQuery: type: object properties: gt: type: object description: Greater-than properties: {} gte: type: object description: Greater-than or equal to properties: {} lt: type: object description: Less-than properties: {} lte: type: object description: Less-than or equal to. properties: {} boost: type: number format: float description: An optional boost value to apply to the query. format: type: string description: Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter. time_zone: type: string description: Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter. description: The query that matches documents with fields that contain terms within a specified range. TierConfig: type: object properties: memory_size: type: integer format: int32 description: The desired memory size in MB for this tier. zone_count: type: integer format: int32 description: The number of availability zones for this tier. If omitted, the current zone count is preserved. description: Desired configuration for an individual Elasticsearch tier RemoteResourceInfo: type: object required: - compatible - connected - healthy - trusted - trusted_back properties: healthy: type: boolean description: Whether or not the remote cluster is healthy connected: type: boolean description: Whether or not there is at least one connection to the remote cluster. compatible: type: boolean description: Whether or not the remote cluster version is compatible with this cluster version. trusted: type: boolean description: Whether or not the remote cluster is trusted by this cluster. trusted_back: type: boolean description: Whether or not the remote cluster trusts this cluster back. description: Information about a Remote Cluster. BasicFailedReply: type: object required: - errors properties: errors: type: array description: A list of errors that occurred in the failing request items: $ref: '#/components/schemas/BasicFailedReplyElement' EnterpriseSearchTopologyElement: type: object properties: node_type: description: Defines the EnterpriseSearch node type $ref: '#/components/schemas/EnterpriseSearchNodeTypes' instance_configuration_id: type: string description: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration. instance_configuration_version: type: integer format: int32 description: The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'. size: $ref: '#/components/schemas/TopologySize' zone_count: type: integer format: int32 description: number of zones in which nodes will be placed enterprise_search: $ref: '#/components/schemas/EnterpriseSearchConfiguration' allocator_filter: type: object properties: {} node_configuration: type: string memory_per_node: type: object properties: {} node_count_per_zone: type: object properties: {} description: Defines the topology of the Enterprise Search nodes (e.g. number/capacity of nodes, and where they can be allocated) IntegrationsServerPlanInfo: type: object required: - healthy - plan_attempt_log - warnings properties: plan_attempt_id: type: string description: A UUID for each plan attempt plan_attempt_name: type: string description: A human readable name for each plan attempt, only populated when retrieving plan histories healthy: type: boolean description: Either the plan ended successfully, or is not yet completed (and no errors have occurred) attempt_start_time: type: string format: date-time description: When this plan attempt (ie to apply the plan to the Integrations Server) started (ISO format in UTC) attempt_end_time: type: string format: date-time description: If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC) plan_end_time: type: string format: date-time description: If this plan is not current or pending, when the plan was no longer active (ISO format in UTC) plan: $ref: '#/components/schemas/IntegrationsServerPlan' plan_attempt_log: type: array items: $ref: '#/components/schemas/ClusterPlanStepInfo' source: description: Information describing the source that facilitated the plans current state $ref: '#/components/schemas/ChangeSourceInfo' warnings: type: array items: $ref: '#/components/schemas/ClusterPlanWarning' error: $ref: '#/components/schemas/ClusterPlanAttemptError' description: Information about the Integrations Server plan. TopologySize: type: object required: - resource - value properties: value: type: integer format: int32 description: Amount of resource resource: type: string description: Type of resource. In ESS the resource used should always be `memory`. enum: - memory - storage description: Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration. AppSearchSettings: type: object properties: metadata: $ref: '#/components/schemas/ClusterMetadataSettings' description: The settings for the App Search. RemoteResourceRef: type: object required: - alias - deployment_id - elasticsearch_ref_id properties: deployment_id: type: string description: The id of the deployment elasticsearch_ref_id: type: string description: The locally-unique user-specified id of an Elasticsearch Resource alias: type: string description: The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores skip_unavailable: type: boolean description: 'If true, skip this cluster during search if it is disconnected. Default: false' info: description: Information about a Remote Cluster. readOnly: true $ref: '#/components/schemas/RemoteResourceInfo' description: The Elasticsearch resource used as a Remote Cluster. ElasticsearchUserBundle: type: object required: - elasticsearch_version - name - url properties: name: type: string description: The name of the bundle url: type: string description: The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle elasticsearch_version: type: string description: The supported Elasticsearch version (must match the version in the plan) description: A list of admin-uploaded bundle objects, such as scripts and synonym files. PrefixQuery: type: object required: - value properties: value: type: string description: The prefix to search for. boost: type: number format: float description: An optional boost value to apply to the query. description: The query that matches documents with fields that contain terms with a specified, not analyzed, prefix. ClusterPlanStepInfo: type: object required: - info_log - stage - started - status - step_id properties: step_id: type: string description: ID of current step started: type: string format: date-time description: When the step started (ISO format in UTC) completed: type: string format: date-time description: When the step completed (ISO format in UTC) duration_in_millis: type: integer format: int64 description: The duration of the step in MS status: type: string description: The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan) enum: - success - warning - error - pending stage: type: string description: Current stage that the step is in enum: - starting - completed - in_progress info_log: type: array description: Human readable summaries of the step, including messages for each stage of the step items: $ref: '#/components/schemas/ClusterPlanStepLogMessageInfo' description: Information about a step in a plan. ClusterSnapshotRepositoryDefault: type: object description: The default object for the Elasticsearch cluster snapshot repository. ElasticsearchShardsInfo: type: object required: - available_shards - healthy - unavailable_replicas - unavailable_shards properties: healthy: type: boolean description: Whether the shard situation is healthy (any unavailable shards is unhealthy) available_shards: type: array items: $ref: '#/components/schemas/ElasticsearchShardElement' unavailable_shards: type: array items: $ref: '#/components/schemas/ElasticsearchShardElement' unavailable_replicas: type: array items: $ref: '#/components/schemas/ElasticsearchReplicaElement' description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Use `shards_status` instead. Information about the shards and replicas that comprise the Elasticsearch indices.' TransientApmPlanConfiguration: type: object properties: strategy: $ref: '#/components/schemas/PlanStrategy' plan_configuration: $ref: '#/components/schemas/ApmPlanControlConfiguration' description: Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings. ApmTopologyElement: type: object properties: instance_configuration_id: type: string description: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration. instance_configuration_version: type: integer format: int32 description: The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'. size: $ref: '#/components/schemas/TopologySize' zone_count: type: integer format: int32 description: number of zones in which nodes will be placed apm: $ref: '#/components/schemas/ApmConfiguration' description: Defines the topology of the APM Server nodes. For example, the number or capacity of the nodes, and where you can allocate the nodes. AppSearchPlan: type: object required: - appsearch properties: cluster_topology: type: array items: $ref: '#/components/schemas/AppSearchTopologyElement' appsearch: $ref: '#/components/schemas/AppSearchConfiguration' transient: $ref: '#/components/schemas/TransientAppSearchPlanConfiguration' description: The plan for the App Search cluster. EnterpriseSearchPlan: type: object required: - enterprise_search properties: cluster_topology: type: array items: $ref: '#/components/schemas/EnterpriseSearchTopologyElement' enterprise_search: $ref: '#/components/schemas/EnterpriseSearchConfiguration' transient: $ref: '#/components/schemas/TransientEnterpriseSearchPlanConfiguration' description: The plan for the Enterprise Search cluster. KibanaConfiguration: type: object properties: version: type: string description: The version of the Kibana cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.) docker_image: type: string description: A docker URI that allows overriding of the default docker image specified for this version system_settings: $ref: '#/components/schemas/KibanaSystemSettings' user_settings_json: type: object description: An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings) properties: {} user_settings_yaml: type: string description: An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Kibana settings) user_settings_override_json: type: object description: An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings) properties: {} user_settings_override_yaml: type: string description: An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Kibana settings) description: The Kibana instance settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings. ApmPlanControlConfiguration: type: object properties: timeout: type: integer format: int64 description: The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB) calm_wait_time: type: integer format: int64 description: This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s move_instances: type: array items: $ref: '#/components/schemas/InstanceMoveRequest' move_allocators: type: array items: $ref: '#/components/schemas/AllocatorMoveRequest' reallocate_instances: type: boolean description: 'If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created' preferred_allocators: type: array description: List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used) items: type: string preferred_allocator_tags: type: object description: Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators additionalProperties: type: string extended_maintenance: type: boolean description: If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster cluster_reboot: type: string description: Set to 'forced' to force a reboot as part of the upgrade plan enum: - forced override_failsafe: type: boolean description: If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints. description: The plan control configuration options for the APM Server. ElasticsearchClusterPlanInfo: type: object required: - healthy - plan_attempt_log - warnings properties: plan_attempt_id: type: string description: A UUID for each plan attempt plan_attempt_name: type: string description: A human readable name for each plan attempt, only populated when retrieving plan histories healthy: type: boolean description: Either the plan ended successfully, or is not yet completed (and no errors have occurred) attempt_start_time: type: string format: date-time description: When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC) attempt_end_time: type: string format: date-time description: If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC) plan_end_time: type: string format: date-time description: If this plan is not current or pending, when the plan was no longer active (ISO format in UTC) plan: $ref: '#/components/schemas/ElasticsearchClusterPlan' plan_attempt_log: type: array items: $ref: '#/components/schemas/ClusterPlanStepInfo' source: description: Information describing the source that facilitated the plans current state $ref: '#/components/schemas/ChangeSourceInfo' warnings: type: array items: $ref: '#/components/schemas/ClusterPlanWarning' error: $ref: '#/components/schemas/ClusterPlanAttemptError' description: Information about the Elasticsearch cluster plan. MatchQuery: type: object required: - query properties: query: type: string description: The text/numeric/date to query for. operator: type: string description: The operator flag can be set to or or and to control the boolean clauses (defaults to or). minimum_should_match: type: integer format: int32 description: The minimum number of optional should clauses to match. analyzer: type: string description: The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field. description: Consumes and analyzes text, numbers, and dates, then constructs a query. ExternalTrustRelationship: type: object required: - trust_all - trust_relationship_id properties: trust_relationship_id: type: string description: The ID of the external trust relationship name: type: string description: The name of the external trust relationship. Retrieved from the TrustRelationship and ignored on write. trust_all: type: boolean description: If true, all clusters in this external entity will be trusted and the `trust_allowlist` is ignored. trust_allowlist: type: array description: The list of clusters to trust. Only used when `trust_all` is false. items: type: string description: The trust relationship with external entities (remote environments, remote accounts...). ApmPlansInfo: type: object required: - healthy - history properties: healthy: type: boolean description: Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed) current: $ref: '#/components/schemas/ApmPlanInfo' pending: $ref: '#/components/schemas/ApmPlanInfo' history: type: array items: $ref: '#/components/schemas/ApmPlanInfo' description: Information about current, pending, and past APM Server plans. DeploymentDeleteResponse: type: object required: - id - name properties: id: type: string description: The id of the deployment name: type: string description: The name of the deployment orphaned: description: Details about orphaned resources $ref: '#/components/schemas/Orphaned' description: A response returned from the Deployment delete endpoint ElasticsearchSystemSettings: type: object properties: scripting: $ref: '#/components/schemas/ElasticsearchScriptingUserSettings' reindex_whitelist: type: array description: Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands items: type: string auto_create_index: type: boolean description: 'If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter ''action.auto_create_index'')' enable_close_index: type: boolean description: 'Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices'' data. NOTES: (Corresponds to the parameter ''cluster.indices.close.enable'')' destructive_requires_name: type: boolean description: 'If true (default is false) then the index deletion API will not support wildcards or ''_all''. NOTES: (Corresponds to the parameter ''action.destructive_requires_name'')' watcher_trigger_engine: type: string description: 'The trigger engine for Watcher, defaults to ''scheduler'' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter ''(xpack.)watcher.trigger.schedule.engine'', depending on version. Ignored from 6.x onwards.)' default_shards_per_index: type: integer format: int32 description: (2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x) monitoring_collection_interval: type: integer format: int32 description: 'The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter ''marvel.agent.interval'' in 2.x and ''xpack.monitoring.collection.interval'' in 5.x)' monitoring_history_duration: type: string description: 'The duration for which monitoring history is stored (format ''(NUMBER)d'' eg ''3d'' for 3 days). NOTES: (''Corresponds to the parameter xpack.monitoring.history.duration'' in 5.x, defaults to ''7d'')' description: 'A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use `ElasticsearchSystemSettings` with `user_settings_override*` and `user_settings*`.' ElasticsearchInfo: type: object required: - blocking_issues - healthy - master_info - shard_info properties: healthy: type: boolean description: Whether the Elasticsearch cluster is healthy (check the sub-objects for more details if not) shard_info: description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Use `shards_status` instead. Elasticsearch shard info' $ref: '#/components/schemas/ElasticsearchShardsInfo' shards_status: $ref: '#/components/schemas/ElasticsearchShardsStatus' master_info: $ref: '#/components/schemas/ElasticsearchMasterInfo' blocking_issues: description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Use `cluster_blocking_issues` instead. cluster-wide and/or index blocks' $ref: '#/components/schemas/ElasticsearchClusterBlockingIssues' cluster_blocking_issues: $ref: '#/components/schemas/ElasticsearchBlockingIssues' description: Information about the Elasticsearch cluster. DeploymentSearchResponse: type: object required: - healthy - id - name - resources properties: id: type: string description: A randomly-generated id of this Deployment name: type: string description: The name of this deployment alias: type: string description: A user-defined deployment alias for user-friendly resource URLs healthy: type: boolean description: 'Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)' resources: description: The Resources that belong to this Deployment $ref: '#/components/schemas/DeploymentResources' settings: description: Additional configuration for this Deployment $ref: '#/components/schemas/DeploymentSettings' metadata: description: Additional information about this deployment $ref: '#/components/schemas/DeploymentMetadata' description: Describes a searched Deployment ReplyWarning: type: object required: - code properties: code: type: string description: A structured code representing the error type that occurred message: type: string description: A human readable message describing the warning that occurred EnterpriseSearchSystemSettings: type: object properties: elasticsearch_username: type: string description: Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only. elasticsearch_password: type: string description: Optionally override the account within Enterprise Search - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only. secret_session_key: type: string description: Optionally override the secret session key within Enterprise Search - defaults to the previously existing secretSession. Note that this field is never returned from the API, it is write only. description: This structure defines a curated subset of the Enterprise Search settings. (This field together with 'user_settings_override*' and 'user_settings*' defines the total set of Enterprise Search settings) ChangeSourceInfo: type: object required: - action - date - facilitator properties: facilitator: type: string description: The service where the change originated from action: type: string description: The type of plan change that was initiated date: type: string format: date-time description: The time the change was initiated user_id: type: string description: The user that requested the change admin_id: type: string description: The admin user that requested the change remote_addresses: type: array description: The host addresses of the user that originated the change items: type: string description: A container for information about the source of a change. DeploymentMetadata: type: object required: - last_modified properties: owner_id: type: string description: The user id (referencing whatever user database is in use) of the deployment owner organization_id: type: string description: The organization that owns the deployment readOnly: true system_owned: type: boolean description: Indicates if a deployment is system owned (restricts the set of operations that can be performed on it) hidden: type: boolean description: Whether or not this deployment is hidden from the normal deployment list readOnly: true subscription_level: type: string description: Subscription level of the cluster readOnly: true last_modified: type: string format: date-time description: The most recent time the cluster metadata was changed (ISO format in UTC) last_resource_plan_modified: type: string format: date-time description: The most recent time the resource's plan was changed (ISO format in UTC) tags: type: array description: Arbitrary user-defined metadata associated with this deployment items: $ref: '#/components/schemas/MetadataItem' byok_enabled: type: boolean description: Indicates if the Deployment is BYOK enabled or not readOnly: true byok_migration: type: boolean description: True if a BYOK migration was requested for this deployment via the migrate_to_byok API. Set at request time, before any plan runs ��� not a completion signal. readOnly: true created_at: type: string format: date-time description: The time the cluster was created (ISO format in UTC) description: Additional information about the current deployment object. ReadOnlyResponse: type: object required: - enabled properties: enabled: type: boolean description: Whether read-only mode is enabled or disabled description: Read-only mode response AppSearchPlanInfo: type: object required: - healthy - plan_attempt_log - warnings properties: plan_attempt_id: type: string description: A UUID for each plan attempt plan_attempt_name: type: string description: A human readable name for each plan attempt, only populated when retrieving plan histories healthy: type: boolean description: Either the plan ended successfully, or is not yet completed (and no errors have occurred) attempt_start_time: type: string format: date-time description: When this plan attempt (ie to apply the plan to the App Search) started (ISO format in UTC) attempt_end_time: type: string format: date-time description: If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC) plan_end_time: type: string format: date-time description: If this plan is not current or pending, when the plan was no longer active (ISO format in UTC) plan: $ref: '#/components/schemas/AppSearchPlan' plan_attempt_log: type: array items: $ref: '#/components/schemas/ClusterPlanStepInfo' source: description: Information describing the source that facilitated the plans current state $ref: '#/components/schemas/ChangeSourceInfo' warnings: type: array items: $ref: '#/components/schemas/ClusterPlanWarning' error: $ref: '#/components/schemas/ClusterPlanAttemptError' description: Information about the App Search Server plan. PlanStrategy: type: object properties: rolling: $ref: '#/components/schemas/RollingStrategyConfig' grow_and_shrink: $ref: '#/components/schemas/GrowShrinkStrategyConfig' rolling_grow_and_shrink: $ref: '#/components/schemas/RollingGrowShrinkStrategyConfig' autodetect: $ref: '#/components/schemas/AutodetectStrategyConfig' description: The options for performing a plan change. Specify only one property each time. The default is `grow_and_shrink`. ElasticsearchClusterTopologyElement: type: object properties: id: type: string description: Unique identifier of this topology element node_type: $ref: '#/components/schemas/ElasticsearchNodeType' node_roles: type: array description: 'The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform' items: type: string enum: - master - ingest - ml - data_hot - data_content - data_warm - data_cold - data_frozen - remote_cluster_client - transform memory_per_node: type: integer format: int32 description: The memory capacity in MB for each node of this type built in each zone. node_count_per_zone: type: integer format: int32 description: The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone = `node_count_per_zone` * `memory_per_node` in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists. zone_count: type: integer format: int32 description: The default number of zones in which data nodes will be placed elasticsearch: $ref: '#/components/schemas/ElasticsearchConfiguration' instance_configuration_id: type: string description: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration. instance_configuration_version: type: integer format: int32 description: The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'. size: $ref: '#/components/schemas/TopologySize' autoscaling_min: description: The minimum size of this topology element when autoscaling is enabled. This property is only supported, and must be provided, for ML topology elements. $ref: '#/components/schemas/TopologySize' autoscaling_max: description: The maximum size of this topology element when autoscaling is enabled. This property is only supported, and must be provided, for data and ML topology elements. $ref: '#/components/schemas/TopologySize' autoscaling_policy_override_json: type: object description: An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing. properties: {} topology_element_control: $ref: '#/components/schemas/TopologyElementControl' autoscaling_tier_override: type: boolean description: Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier description: The topology of the Elasticsearch nodes, including the number, capacity, and type of nodes, and where they can be allocated. MetadataItem: type: object required: - key - value properties: key: type: string description: The metadata field name value: type: string description: The metadata value description: The key-value pair. QueryStringQuery: type: object required: - query properties: query: type: string description: The actual query to be parsed. default_field: type: string description: The default field for query terms if no prefix field is specified. analyzer: type: string description: The analyzer used to analyze each term of the query when creating composite queries. default_operator: type: string description: The default operator used if no explicit operator is specified. allow_leading_wildcard: type: boolean description: When set, * or ? are allowed as the first character. Defaults to false. description: A query that uses the strict query string syntax for parsing. Will return an error for invalid syntax. EnterpriseSearchInfo: type: object required: - elasticsearch_cluster - external_links - healthy - id - name - plan_info - status - topology properties: id: type: string description: The id of the Enterprise Search name: type: string description: The name of the Enterprise Search elasticsearch_cluster: $ref: '#/components/schemas/TargetElasticsearchCluster' deployment_id: type: string description: The id of the deployment that this Enterprise Search belongs to. healthy: type: boolean description: 'Whether the Enterprise Search is healthy or not (one or more of the info subsections will have healthy: false)' status: type: string description: Enterprise Search status enum: - initializing - stopping - stopped - rebooting - restarting - reconfiguring - started plan_info: $ref: '#/components/schemas/EnterpriseSearchPlansInfo' metadata: $ref: '#/components/schemas/ClusterMetadataInfo' topology: $ref: '#/components/schemas/ClusterTopologyInfo' external_links: type: array description: External resources related to the Enterprise Search uniqueItems: true items: $ref: '#/components/schemas/ExternalHyperlink' links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' settings: description: The cluster metadata settings for the Enterprise Search $ref: '#/components/schemas/EnterpriseSearchSettings' region: type: string description: The region that this Enterprise Search belongs to. Only populated in SaaS or federated ECE. description: The overview information for the Enterprise Search Server. ElasticsearchClusterPlan: type: object required: - cluster_topology - elasticsearch properties: cluster_topology: type: array items: $ref: '#/components/schemas/ElasticsearchClusterTopologyElement' elasticsearch: $ref: '#/components/schemas/ElasticsearchConfiguration' deployment_template: description: Documents which deployment template was used in the creation of this plan $ref: '#/components/schemas/DeploymentTemplateReference' transient: $ref: '#/components/schemas/TransientElasticsearchPlanConfiguration' autoscaling_enabled: type: boolean description: Enable autoscaling for this Elasticsearch cluster. description: The plan for the Elasticsearch cluster. DeploymentUpdateSettings: type: object properties: observability: description: Logging and monitoring settings for this deployment. If provided it will change observability settings, if null observability will be removed from the deployment, otherwise will stay the same $ref: '#/components/schemas/DeploymentObservabilitySettings' autoscaling_enabled: type: boolean description: Enable autoscaling for this deployment. auto_ops: description: See AutoOps integration status for this deployment. $ref: '#/components/schemas/AutoOpsSettings' description: Additional configuration for the new deployment object. CertificateMetaData: type: object required: - fingerprint - valid_from - valid_to properties: fingerprint: type: string description: The fingerprint of the certificate valid_to: type: string format: date-time description: The expiry date of the certificate in UTC valid_from: type: string format: date-time description: The valid from date of the certificate in UTC also_trusted_by: type: array description: Other deployments also trusting this certificate items: type: string description: The certificate MetaData ElasticsearchScriptingUserSettings: type: object properties: painless_enabled: type: boolean description: '(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if ''sandbox_mode'' is set to true. NOTES: (Corresponds to the parameters ''script.engine.painless.[file|stored|inline]'')' mustache_enabled: type: boolean description: '(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if ''sandbox_mode'' is set to true. NOTES: (Corresponds to the parameters ''script.engine.mustache.[file|stored|inline]'')' expressions_enabled: type: boolean description: '(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if ''sandbox_mode'' is set to true. NOTES: (Corresponds to the parameters ''script.engine.expression.[file|stored|inline]'')' stored: $ref: '#/components/schemas/ElasticsearchScriptTypeSettings' file: $ref: '#/components/schemas/ElasticsearchScriptTypeSettings' inline: $ref: '#/components/schemas/ElasticsearchScriptTypeSettings' description: 'Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.' KibanaClusterTopologyElement: type: object properties: memory_per_node: type: integer format: int32 description: The memory capacity in MB for each node of this type built in each zone. node_count_per_zone: type: integer format: int32 description: The number of nodes of this type that are allocated within each zone (i.e. total capacity per zone = `node_count_per_zone` * `memory_per_node` in MB). instance_configuration_id: type: string description: Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration. instance_configuration_version: type: integer format: int32 description: The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'. size: $ref: '#/components/schemas/TopologySize' zone_count: type: integer format: int32 description: number of zones in which nodes will be placed kibana: $ref: '#/components/schemas/KibanaConfiguration' description: The topology of the Kibana nodes, including the number, capacity, and type of nodes, and where they can be allocated. ElasticsearchClusterBlockingIssues: type: object required: - cluster_level - healthy - index_level properties: healthy: type: boolean description: Whether the cluster has issues (false) or not (true) cluster_level: type: array description: A list of issues that affect availability of entire cluster items: $ref: '#/components/schemas/ElasticsearchClusterBlockingIssueElement' index_level: type: array description: A list of issues that affect availability of the cluster's indices items: $ref: '#/components/schemas/ElasticsearchClusterBlockingIssueElement' description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Use `cluster_blocking_issues` instead Issues that prevent the Elasticsearch cluster or index from operating correctly.' IntegrationsServer: type: object required: - backend_plan - display_name - elasticsearch_cluster_ref_id - ref_id properties: ref_id: type: string description: A locally-unique user-specified id display_name: type: string description: The human readable name (defaults to the generated cluster id if not specified) elasticsearch_cluster_ref_id: type: string description: The user-specified id of the Elasticsearch Cluster that this will link to backend_plan: type: object description: The backend plan as JSON properties: {} description: Holds diagnostics for an Integrations Server resource DeploymentMetricsSettings: type: object required: - destination properties: destination: description: The destination deployment that this deployment's metrics will be sent to $ref: '#/components/schemas/ObservabilityAbsoluteDeployment' force_legacy_monitoring: type: boolean description: Set to true to force the deployment to use legacy monitoring instead of Metricbeat-based monitoring. Only available for versions lower than 9.0. description: The metrics settings for a deployment EnterpriseSearchConfiguration: type: object properties: version: type: string description: The version of the Enterprise Search cluster (must be one of the ECE supported versions, and won't work unless it matches the Elasticsearch version. Leave blank to auto-detect version.) docker_image: type: string description: A docker URI that allows overriding of the default docker image specified for this version system_settings: $ref: '#/components/schemas/EnterpriseSearchSystemSettings' user_settings_json: type: object description: An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings) properties: {} user_settings_yaml: type: string description: An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Enterprise Search settings) user_settings_override_json: type: object description: An arbitrary JSON object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings) properties: {} user_settings_override_yaml: type: string description: An arbitrary YAML object allowing ECE admins to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), i.e. in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Enterprise Search settings) ClusterSnapshotRepositoryInfo: type: object properties: static: description: Cluster snapshot static repository settings, containing repository type and settings $ref: '#/components/schemas/ClusterSnapshotRepositoryStatic' reference: description: Cluster snapshot reference repository settings, containing the repository name in ECE fashion $ref: '#/components/schemas/ClusterSnapshotRepositoryReference' default: description: Cluster snapshot default repository settings $ref: '#/components/schemas/ClusterSnapshotRepositoryDefault' description: Information about the Elasticsearch cluster snapshot repository. ClusterSnapshotRepositoryReference: type: object properties: repository_name: type: string description: ECE snapshot repository name, from the '/platform/configuration/snapshots/repositories' endpoint description: The reference object for the Elasticsearch cluster snapshot repository. AppSearchPayload: type: object required: - elasticsearch_cluster_ref_id - plan - ref_id - region properties: ref_id: type: string description: A locally-unique user-specified id for AppSearch elasticsearch_cluster_ref_id: type: string description: Alias to the Elasticsearch Cluster to attach AppSearch to display_name: type: string description: 'The human readable name for the AppSearch cluster (default: takes the name of its Elasticsearch cluster)' region: type: string description: The region where this resource exists plan: $ref: '#/components/schemas/AppSearchPlan' settings: description: The settings for building this AppSearch cluster $ref: '#/components/schemas/AppSearchSettings' description: An AppSearch creation request paired with the alias of the Elasticsearch cluster it should be paired with EnterpriseSearch: type: object required: - backend_plan - display_name - elasticsearch_cluster_ref_id - ref_id properties: ref_id: type: string description: A locally-unique user-specified id display_name: type: string description: The human readable name (defaults to the generated cluster id if not specified) elasticsearch_cluster_ref_id: type: string description: The user-specified id of the Elasticsearch Cluster that this will link to backend_plan: type: object description: The backend plan as JSON properties: {} description: Holds diagnostics for an Enterprise Search resource Updates: type: object properties: elasticsearch: type: array description: Diagnostics for Elasticsearch clusters items: $ref: '#/components/schemas/Elasticsearch' kibana: type: array description: Diagnostics for Kibanas items: $ref: '#/components/schemas/Kibana' apm: type: array description: Diagnostics for APMs items: $ref: '#/components/schemas/Apm' integrations_server: type: array description: Diagnostics for Integrations Server items: $ref: '#/components/schemas/IntegrationsServer' appsearch: type: array description: Diagnostics for AppSearches items: $ref: '#/components/schemas/AppSearch' enterprise_search: type: array description: Diagnostics for Enterprise Search resources items: $ref: '#/components/schemas/EnterpriseSearch' description: Holds diagnostics for existing resources that might be updated MatchNoneQuery: type: object description: A query that doesn't match any documents. DeploymentResourceUserSettings: type: object required: - user_settings properties: user_settings: type: object description: A JSON object containing the user settings for the resource. Replaces all existing user settings when submitted via PUT. properties: {} description: The user-defined settings for a deployment resource ElasticsearchShardsStatus: type: object required: - status properties: status: type: string description: Indicates the elasticsearch cluster health status as a color enum: - green - red - yellow description: Shards status represented as green, yellow, or red, as returned by the Elasticsearch cluster health API ElasticsearchDependant: type: object required: - id - kind properties: id: type: string description: The id of the orphaned resource kind: type: string description: The kind of resource description: Details about an orphaned Elasticsearch-dependent resources. IntegrationsServerSystemSettings: type: object properties: elasticsearch_username: type: string description: Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only. elasticsearch_password: type: string description: Optionally override the account within Integrations Server - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only. secret_token: type: string description: Optionally override the secret token within Integrations Server - defaults to the previously existing secretToken debug_enabled: type: boolean description: Optionally enable debug mode for Integrations Server - defaults false description: "A structure that defines a curated subset of the Integrations Server settings. \nTIP: To define the complete set of Integrations Server setting, use `IntegrationsSystemSettings` with `user_settings_override_` and `user_settings_`." TransientElasticsearchPlanConfiguration: type: object properties: strategy: $ref: '#/components/schemas/PlanStrategy' plan_configuration: $ref: '#/components/schemas/ElasticsearchPlanControlConfiguration' restore_snapshot: $ref: '#/components/schemas/RestoreSnapshotConfiguration' snapshot_dependency: description: Configuration for attaching a snapshot dependency from another cluster $ref: '#/components/schemas/SnapshotDependencyConfiguration' remote_clusters: description: The list of resources that will be configured as remote clusters $ref: '#/components/schemas/RemoteResources' cluster_settings_json: type: object description: 'If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them). - indices.store.throttle.max_bytes_per_sec: 120Mb - indices.recovery.max_bytes_per_sec: 120Mb - cluster.routing.allocation.cluster_concurrent_rebalance: 5 - cluster.routing.allocation.node_initial_primaries_recoveries: 5 - cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.' properties: {} description: Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings. ClusterCredentials: type: object required: - password - username properties: username: type: string description: The username of the newly created cluster password: type: string description: The password of the newly created cluster description: The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster `create` command. ResourceHeapDumps: type: object required: - heap_dumps - id - ref_id properties: ref_id: type: string description: The locally-unique user-specified id of the resource that the heap dump was captured from id: type: string description: The randomly-generated id of a Resource heap_dumps: type: array description: The heap dumps belonging to this resource items: $ref: '#/components/schemas/HeapDump' DeploymentTemplateReference: type: object required: - id properties: id: type: string description: The unique identifier of the deployment template version: type: string description: A version identifier to disambiguate multiple revisions of the same template description: Specifies the deployment template used to create the plan. SimpleQueryStringQuery: type: object required: - query properties: query: type: string description: The query expressed in simple query string syntax. fields: type: array description: Array of fields to search items: type: string default_operator: type: string description: The boolean operator used to combine the terms of the query. Valid values are `OR` (default) and `AND`. analyze_wildcard: type: boolean description: If `true`, the query attempts to analyze wildcard terms. Defaults to `false`. analyzer: type: string description: The name of the analyzer to use to convert the query text into tokens. auto_generate_synonyms_phrase_query: type: boolean description: If `true`, the parse creates a `match_phrase` uery for each multi-position token. Defaults to `true`. flags: type: string description: List of enabled operators for the simple query string syntax. Defaults to `ALL`. fuzzy_max_expansions: type: integer format: int32 description: Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50. fuzzy_prefix_length: type: integer format: int32 description: Number of beginning characters left unchanged for fuzzy matching. Defaults to 0. fuzzy_transpositions: type: boolean description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters. Defaults to `false`. lenient: type: boolean description: If `true`, format-based errors, such as providing a text value for a numeric field are ignored. Defaults to `false`. minimum_should_match: type: string description: Minimum number of clauses that must match for a document to be returned. quote_field_suffix: type: string description: Suffix appended to quoted text in the query string. description: A query that uses simple query string syntax. Will ignore invalid syntax. ElasticsearchBlockingIssues: type: object required: - blocks - healthy properties: healthy: type: boolean description: Whether the cluster has issues (false) or not (true) blocks: type: array description: A list of blocks that affect the availability of the cluster items: $ref: '#/components/schemas/ElasticsearchBlockingIssueElement' description: Issues that prevent the Elasticsearch cluster or index from correctly operating. DeploymentsListingData: type: object required: - id - name - resources properties: id: type: string description: The id of this deployment name: type: string description: The name of this deployment resources: type: array description: List of resources in this deployment items: $ref: '#/components/schemas/DeploymentResource' ElasticsearchReplicaElement: type: object required: - instance_name - replica_count properties: instance_name: type: string description: The Elastic Cloud name/id of the instance (container) replica_count: type: integer format: int32 description: The number of unavailable replicas on this instance description: 'Information about the unavailable replicas. NOTE: Unlike shards, unavailable replicas indicate a loss of redundancy rather than a loss of availability.' UpgradeDeploymentRequest: type: object required: - target_version properties: target_version: type: string description: Target Elastic Stack version to which to upgrade description: Request to upgrade a deployment to a new Elastic Stack version IntegrationsServerResourceInfo: type: object required: - elasticsearch_cluster_ref_id - id - info - ref_id - region properties: ref_id: type: string description: The locally-unique user-specified id of a Resource elasticsearch_cluster_ref_id: type: string description: The Elasticsearch cluster that this resource depends on. id: type: string description: The randomly-generated id of a Resource region: type: string description: The region where this resource exists info: description: Info for the resource. $ref: '#/components/schemas/IntegrationsServerInfo' description: Describes an Integrations Server resource belonging to a Deployment ElasticsearchResourceInfo: type: object required: - id - info - ref_id - region properties: ref_id: type: string description: The locally-unique user-specified id of a Resource id: type: string description: The randomly-generated id of a Resource region: type: string description: The region where this resource exists info: description: Info for the resource. $ref: '#/components/schemas/ElasticsearchClusterInfo' description: Describes an Elasticsearch resource belonging to a Deployment AppSearchInfo: type: object required: - elasticsearch_cluster - external_links - healthy - id - name - plan_info - status - topology properties: id: type: string description: The id of the App Search name: type: string description: The name of the App Search elasticsearch_cluster: $ref: '#/components/schemas/TargetElasticsearchCluster' deployment_id: type: string description: The id of the deployment that this App Search belongs to. healthy: type: boolean description: 'Whether the App Search is healthy or not (one or more of the info subsections will have healthy: false)' status: type: string description: App Search status enum: - initializing - stopping - stopped - rebooting - restarting - reconfiguring - started plan_info: $ref: '#/components/schemas/AppSearchPlansInfo' metadata: $ref: '#/components/schemas/ClusterMetadataInfo' topology: $ref: '#/components/schemas/ClusterTopologyInfo' external_links: type: array description: External resources related to the App Search uniqueItems: true items: $ref: '#/components/schemas/ExternalHyperlink' links: type: object description: A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation additionalProperties: $ref: '#/components/schemas/Hyperlink' settings: description: The cluster metadata settings for the App Search $ref: '#/components/schemas/AppSearchSettings' region: type: string description: The region that this App Search belongs to. Only populated in SaaS or federated ECE. description: The overview information for the App Search Server. GenericResponse: type: object required: - value properties: value: type: string DeploymentMetrics: type: object required: - healthy properties: healthy: type: boolean description: Whether the deployment metrics are healthy or not urls: type: object description: The URLs to view this deployment's metrics in Kibana additionalProperties: type: string issues: type: array description: Metrics health issues for the deployment items: $ref: '#/components/schemas/ObservabilityIssue' description: Metrics information for a deployment securitySchemes: apiKey: type: apiKey name: Authorization in: header basicAuth: type: http scheme: basic x-elastic: curl: auth: '-H "Authorization: ApiKey $ECE_API_KEY"'