openapi: 3.2.0 info: version: '1' title: Elastic Cloud Enterprise Platform Infrastructure API termsOfService: '' servers: - url: https://{{hostname}}/api/v1 security: - basicAuth: [] - apiKey: [] tags: - name: PlatformInfrastructure paths: /platform/configuration/api_base_url: get: tags: - PlatformInfrastructure summary: Get API base Url description: Gets the API base Url configuration value. operationId: get-api-base-url responses: '200': description: The API base Url was successfully retrieved 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/ApiBaseUrlData' '404': description: 'There is no configured API base value but optimistic locking was sent. (code: `adminconsole.base_url.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsole.base_url.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '500': description: 'The persisted Url is malformed. (code: `adminconsole.base_url.invalid_persisted_data`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsole.base_url.invalid_persisted_data content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: API - Base Url put: tags: - PlatformInfrastructure summary: Set API base Url description: Saves the API base Url configuration value. operationId: set-api-base-url parameters: - 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). If not specified, will unconditionally upsert. required: false schema: type: string - name: skip_cascading_operations in: query description: Whether or not to skip cascading operations, such as re-provisioning the Security Deployment. required: false schema: type: boolean default: false responses: '200': description: The API base Url was successfully saved. 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/ApiBaseUrlData' '400': description: 'The optimistic locking version format was wrong. (code: `adminconsole.base_url.bad_version_format`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsole.base_url.bad_version_format content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '412': description: 'skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: `security_deployment.cluster_pending_plan_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - security_deployment.cluster_pending_plan_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'There is no configured API base value but optimistic locking was sent. (code: `adminconsole.base_url.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsole.base_url.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'There was an optimistic locking version conflict. (code: `adminconsole.base_url.version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsole.base_url.version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: API - Base Url requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiBaseUrlData' description: Data containing the base Url to set required: true /platform/configuration/store: get: tags: - PlatformInfrastructure summary: List Config Store Option description: List all existing Config Store Option. operationId: list-config-store-option responses: '200': description: List of existing Config Store Option content: application/json: schema: $ref: '#/components/schemas/ConfigStoreOptionList' x-doc: tag: Platform - configuration - Store /platform/configuration/store/{config_option_id}: get: tags: - PlatformInfrastructure summary: Find Config Store Option by name description: Find Config Store Option by name. operationId: get-config-store-option parameters: - name: config_option_id in: path description: Name of the Config Store Option that you would like to find required: true schema: type: string responses: '200': description: Config Store Option retrieved successfully 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/ConfigStoreOption' '404': description: 'Config Store Option do not exist by that name. (code: `platform.config.store.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - platform.config.store.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - configuration - Store post: tags: - PlatformInfrastructure summary: Create Config Store Option description: Inserts new Config Store Option. operationId: create-config-store-option parameters: - name: config_option_id in: path description: Name of the Config Store Option that you would like to create required: true schema: type: string responses: '201': description: The Config Store Option was inserted successfully 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/ConfigStoreOption' '400': description: 'Config Store Option data already exists for the given name. (code: `platform.config.store.already_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - platform.config.store.already_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - configuration - Store requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigStoreOptionData' description: The Config Store Option definition required: true put: tags: - PlatformInfrastructure summary: Update Config Store Option description: Update existing Config Store Option. operationId: put-config-store-option parameters: - name: config_option_id in: path description: Name of the Config Store Option that you would like to modify required: true schema: type: string - 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: Config Store Option retrieved successfully 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/ConfigStoreOption' '404': description: 'There was no existing data for the given Config Store Id. (code: `platform.config.store.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - platform.config.store.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'There is a version conflict. (code: `platform.config.store.version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - platform.config.store.version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - configuration - Store requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfigStoreOptionData' description: The Config Store Option definition required: true delete: tags: - PlatformInfrastructure summary: Delete Config Store Option by name description: Delete Config Store Option by name. operationId: delete-config-store-option parameters: - name: config_option_id in: path description: Name of the Config Store Option that you would like to delete required: true schema: type: string responses: '200': description: Config Store Option deleted successfully 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/EmptyResponse' '404': description: 'Config Store Option do not exist by that name. (code: `platform.config.store.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - platform.config.store.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - configuration - Store /platform/infrastructure/adminconsoles: get: tags: - PlatformInfrastructure summary: Get adminconsoles description: Retrieves an overview of all adminconsoles. operationId: get-adminconsoles responses: '200': description: An overview of all adminconsoles. 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/AdminconsolesOverview' x-doc: tag: Platform - Adminconsoles /platform/infrastructure/adminconsoles/_reindex: post: tags: - PlatformInfrastructure summary: Reindex region indices description: Start reindex of all regional indices. operationId: reindex-adminconsoles responses: '202': description: Started reindexing of regional indices. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' x-doc: tag: Platform - Adminconsoles /platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings: get: tags: - PlatformInfrastructure summary: Get adminconsole logging settings description: Get the logging settings for this adminconsole instance. operationId: get-adminconsole-logging-settings parameters: - name: adminconsole_id in: path description: The identifier for the adminconsole instance required: true schema: type: string responses: '200': description: The logging settings for the adminconsole instance 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/LoggingSettings' '404': description: 'The logging settings for this adminconsole were not found. (code: `adminconsoles.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsoles.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Adminconsoles put: tags: - PlatformInfrastructure summary: Set adminconsole logging settings description: Set the logging settings for this adminconsole instance. operationId: set-adminconsole-logging-settings parameters: - name: adminconsole_id in: path description: The identifier for the adminconsole instance required: true schema: type: string responses: '200': description: The updated logging settings for the adminconsole instance 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/LoggingSettings' '404': description: 'The logging settings for this adminconsole were not found. (code: `adminconsoles.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsoles.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Adminconsoles requestBody: content: application/json: schema: $ref: '#/components/schemas/LoggingSettings' description: The new logging settings for the adminconsole instance required: true delete: tags: - PlatformInfrastructure summary: Delete adminconsole logging settings description: Reset the default logging settings for this adminconsole instance. operationId: delete-adminconsole-logging-settings parameters: - name: adminconsole_id in: path description: The identifier for the adminconsole instance required: true schema: type: string responses: '200': description: The updated logging settings for the adminconsole instance 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/LoggingSettings' '404': description: 'The logging settings for this adminconsole were not found. (code: `adminconsoles.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsoles.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Adminconsoles patch: tags: - PlatformInfrastructure summary: Update adminconsole logging settings description: All changes in the specified object are applied to the logging settings for this adminconsole instance according to the JSON Merge Patch processing rules. Omitting existing fields causes the same values to be reapplied. Specifying a `null` value reverts the field to the default value, or removes the field when no default value exists. operationId: update-adminconsole-logging-settings parameters: - name: adminconsole_id in: path description: The identifier for the adminconsole instance required: true schema: type: string responses: '200': description: The updated logging settings for the adminconsole instance 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/LoggingSettings' '404': description: 'The logging settings for this adminconsole were not found. (code: `adminconsoles.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - adminconsoles.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The update request is invalid. (code: `patch.request_malformed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - patch.request_malformed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Adminconsoles requestBody: content: application/json: schema: type: string description: The logging settings to update required: true /platform/infrastructure/allocators: get: tags: - PlatformInfrastructure summary: Get allocators description: Retrieves the information for all of the allocators in the platform. operationId: get-allocators parameters: - name: q in: query description: (Optional) The query that filters the allocators. Maps to an Elasticsearch `query_string` query. required: false schema: type: string - name: size in: query description: (Optional) The maximum number of search results to return. Defaults to 100. required: false schema: type: integer default: 100 - name: from in: query description: (Optional) The offset from the first result you want to fetch. Defaults to 0. required: false schema: type: integer default: 0 - name: sort in: query description: (Optional) A comma-separated array of fields to sort the search results by. Defaults to `allocator_id`. required: false schema: type: string responses: '200': description: An overview of all allocators content: application/json: schema: $ref: '#/components/schemas/AllocatorOverview' x-doc: tag: Platform - Allocators /platform/infrastructure/allocators/_resync: post: tags: - PlatformInfrastructure summary: Resynchronize allocators description: Asynchronously synchronizes all allocator information in the back-end search index. operationId: resync-allocators 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: '202': description: The ids of documents, organized by model version, that will be synchronized. content: application/json: schema: $ref: '#/components/schemas/ModelVersionIndexSynchronizationResults' x-doc: tag: Platform - Allocators /platform/infrastructure/allocators/_search: post: tags: - PlatformInfrastructure summary: Search allocators description: Retrieves the information for all the allocators in the platform that match a specified query. operationId: search-allocators responses: '200': description: An overview of allocators that matched the given search query content: application/json: schema: $ref: '#/components/schemas/AllocatorOverview' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' description: The optional search request to execute. If not supplied then all allocators are matched /platform/infrastructure/allocators/{allocator_id}: get: tags: - PlatformInfrastructure summary: Get allocator description: Retrieves the allocator by the ID. operationId: get-allocator parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string responses: '200': description: The information for the allocator specified by {allocator_id} content: application/json: schema: $ref: '#/components/schemas/AllocatorInfo' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators delete: tags: - PlatformInfrastructure summary: Delete allocator description: Deletes the allocator. operationId: delete-allocator parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: remove_instances in: query description: Removes the instances from the deleted allocator. required: false schema: type: boolean default: false responses: '200': description: The allocator specified by {allocator_id} was successfully deleted content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: '* The allocator specified by {allocator_id} could not be deleted. (code: `allocators.delete_connected_allocator_attempt`) * The allocator specified by {allocator_id} could not be deleted. (code: `allocators.delete_allocator_with_instances_attempt`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.delete_connected_allocator_attempt - allocators.delete_allocator_with_instances_attempt content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators /platform/infrastructure/allocators/{allocator_id}/_resync: post: tags: - PlatformInfrastructure summary: Resynchronize allocator description: Immediately synchronizes the allocator information in the back-end search index and caches. operationId: resync-allocator parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string responses: '200': description: The allocator resync operation executed successfully content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '500': description: 'The allocator resync operation failed for allocator {allocator_id}. (code: `allocators.resync_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.resync_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators /platform/infrastructure/allocators/{allocator_id}/clusters/_move: post: tags: - PlatformInfrastructure summary: Move clusters description: Moves the clusters to a different allocator. operationId: move-clusters parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - 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: 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`, execute a primitive vacate by moving data at file-system level, and recreating instances on the target allocator(s). required: false schema: type: boolean default: false - name: allocator_down in: query description: 'When `true`, considers all instances on the allocator as permanently shut down when deciding how to migrate data to new nodes.When left blank, the system automatically decides. NOTE: The default treats the allocator as up.' required: false schema: type: boolean - name: validate_only in: query description: When `true`, validates the plan overrides, then returns the plan without performing the move. required: false schema: type: boolean default: false responses: '202': description: The move command was issued successfully, use the "GET" command on each /{cluster_id} resource to monitor progress content: application/json: schema: $ref: '#/components/schemas/MoveClustersCommandResponse' '400': description: '* The cluster definition contained errors. (code: `clusters.cluster_invalid_plan`) * The cluster definition contained errors. (code: `clusters.plan_feature_not_implemented`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - clusters.cluster_invalid_plan - clusters.plan_feature_not_implemented content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The move command was prohibited for the given cluster. (code: `clusters.command_prohibited`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - clusters.command_prohibited content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveClustersRequest' description: Overrides defaults for the move of each cluster /platform/infrastructure/allocators/{allocator_id}/clusters/{cluster_type}/_move: post: tags: - PlatformInfrastructure summary: Move clusters by type description: Moves the clusters, by type, to a different allocator. operationId: move-clusters-by-type parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: cluster_type in: path description: 'The cluster types to move off of the allocator. NOTE: When unspecified, all clusters are moved.' required: true schema: type: string enum: - apm - appsearch - elasticsearch - enterprise_search - kibana - name: force_update in: query description: When true, cancels and overwrites pending plans, or treats instance as an error required: false schema: type: boolean default: false - name: move_only in: query description: When true, bypasses the cluster state changes, but continues to move the specified instances required: false schema: type: boolean default: true - name: force_move in: query description: When `true`, execute a primitive vacate by moving data at file-system level, and recreating instances on the target allocator(s). required: false schema: type: boolean default: false - name: allocator_down in: query description: 'When `true`, considers all instances on the allocator as permanently shut down when deciding how to migrate data to new nodes.When left blank, the system automatically decides. NOTE: The default treats the allocator as up.' required: false schema: type: boolean - name: validate_only in: query description: When `true`, validates the plan overrides, then returns the plan without performing the move. required: false schema: type: boolean default: false responses: '202': description: The move command was issued successfully, use the "GET" command on each /{cluster_id} resource to monitor progress content: application/json: schema: $ref: '#/components/schemas/MoveClustersCommandResponse' '400': description: '* The cluster definition contained errors. (code: `clusters.cluster_invalid_plan`) * The cluster definition contained errors. (code: `clusters.plan_feature_not_implemented`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - clusters.cluster_invalid_plan - clusters.plan_feature_not_implemented content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '403': description: 'The move command was prohibited for the given cluster. (code: `clusters.command_prohibited`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - clusters.command_prohibited content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: $ref: '#/components/schemas/MoveClustersRequest' description: Overrides defaults for the move of each cluster /platform/infrastructure/allocators/{allocator_id}/logging_settings: get: tags: - PlatformInfrastructure summary: Get allocator logging settings description: Get the logging settings for this allocator instance. operationId: get-allocator-logging-settings parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string responses: '200': description: The logging settings for the allocator instance 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/LoggingSettings' '404': description: 'The logging settings for this allocator were not found. (code: `allocators.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators put: tags: - PlatformInfrastructure summary: Set allocator logging settings description: Set the logging settings for this allocator instance. operationId: set-allocator-logging-settings parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string responses: '200': description: The updated logging settings for the allocator instance 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/LoggingSettings' '404': description: 'The logging settings for this allocator were not found. (code: `allocators.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: $ref: '#/components/schemas/LoggingSettings' description: The new logging settings for the allocator instance required: true delete: tags: - PlatformInfrastructure summary: Delete allocator logging settings description: Reset the default logging settings for this allocator instance. operationId: delete-allocator-logging-settings parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string responses: '200': description: The updated logging settings for the allocator instance 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/LoggingSettings' '404': description: 'The logging settings for this allocator were not found. (code: `allocators.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators patch: tags: - PlatformInfrastructure summary: Update allocator logging settings description: All changes in the specified object are applied to the logging settings for this allocator instance according to the JSON Merge Patch processing rules. Omitting existing fields causes the same values to be reapplied. Specifying a `null` value reverts the field to the default value, or removes the field when no default value exists. operationId: update-allocator-logging-settings parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string responses: '200': description: The updated logging settings for the allocator instance 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/LoggingSettings' '404': description: 'The logging settings for this allocator were not found. (code: `allocators.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The update request is invalid. (code: `patch.request_malformed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - patch.request_malformed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: type: string description: The logging settings to update required: true /platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start: post: tags: - PlatformInfrastructure summary: Start maintenance mode description: Starts maintenance mode on the allocator. operationId: start-allocator-maintenance-mode parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: reason in: query description: Provides a reason for changing the maintenance mode which will appear as a message on the allocator. required: false schema: type: string responses: '202': description: The start maintenance mode command was issued successfully content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '403': description: 'The start maintenance mode command was prohibited for the given allocator. (code: `root.unauthorized.rbac`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - root.unauthorized.rbac content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators /platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_stop: post: tags: - PlatformInfrastructure summary: Stop maintenance mode description: Stops maintenance mode on the allocator. operationId: stop-allocator-maintenance-mode parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: reason in: query description: Provides a reason for changing the maintenance mode which will appear as a message on the allocator. required: false schema: type: string responses: '202': description: The stop maintenance mode command was issued successfully content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '403': description: 'The stop maintenance mode command was prohibited for the given allocator. (code: `root.unauthorized.rbac`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - root.unauthorized.rbac content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators /platform/infrastructure/allocators/{allocator_id}/metadata: get: tags: - PlatformInfrastructure summary: Get allocator metadata description: Retrieves the allocator metadata. operationId: get-allocator-metadata parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string responses: '200': description: The allocator metadata was successfully 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: array items: $ref: '#/components/schemas/MetadataItem' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators put: tags: - PlatformInfrastructure summary: Set allocator metadata description: Sets the allocator metadata. operationId: set-allocator-metadata parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: version in: query description: Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header. required: false schema: type: string responses: '200': description: The allocator metadata was successfully changed (the updated JSON is returned) content: application/json: schema: type: array items: $ref: '#/components/schemas/MetadataItem' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The value specified is empty for at least one of the metadata tags. (code: `allocators.invalid_empty_metadata_items`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.invalid_empty_metadata_items content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: $ref: '#/components/schemas/MetadataItems' description: The metadata to update the allocator with required: true /platform/infrastructure/allocators/{allocator_id}/metadata/{key}: put: tags: - PlatformInfrastructure summary: Set allocator metadata item description: Adds or updates a single item in the allocator metadata. operationId: set-allocator-metadata-item parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: key in: path description: The metadata item key. required: true schema: type: string - name: version in: query description: Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header. required: false schema: type: string responses: '200': description: The allocator metadata was successfully changed (the updated JSON is returned) content: application/json: schema: type: array items: $ref: '#/components/schemas/MetadataItem' '404': description: '* The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`) * The metadata item specified by {key} cannot be found. (code: `allocators.metadata_item_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found - allocators.metadata_item_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The value specified for the metadata tag is empty. (code: `allocators.invalid_empty_metadata_item`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.invalid_empty_metadata_item content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: $ref: '#/components/schemas/MetadataItemValue' description: The value of the metadata item to add or update required: true delete: tags: - PlatformInfrastructure summary: Delete allocator metadata item description: Removes a single item from the allocator metadata. operationId: delete-allocator-metadata-item parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: key in: path description: The metadata item key. required: true schema: type: string - name: version in: query description: Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header. required: false schema: type: string responses: '200': description: The allocator metadata was successfully changed (the updated JSON is returned) content: application/json: schema: type: array items: $ref: '#/components/schemas/MetadataItem' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators /platform/infrastructure/allocators/{allocator_id}/settings: get: tags: - PlatformInfrastructure summary: Get allocator settings description: Retrieves the allocator override settings. operationId: get-allocator-settings parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string responses: '200': description: Returns the settings for the specified Allocator 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/AllocatorSettings' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators put: tags: - PlatformInfrastructure summary: Set allocator settings description: 'Overwrites the allocator settings with the specified settings. WARNING: Any unspecified fields are deleted.' operationId: set-allocator-settings parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: version in: query description: Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header. required: false schema: type: string responses: '200': description: Returns the updated settings for the specified allocator content: application/json: schema: $ref: '#/components/schemas/AllocatorSettings' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: $ref: '#/components/schemas/AllocatorSettings' description: The allocator settings to apply required: true patch: tags: - PlatformInfrastructure summary: Update allocator settings description: Applies the settings as a patch. Only the fields that are referenced in the update are altered. operationId: update-allocator-settings parameters: - name: allocator_id in: path description: The allocator identifier. required: true schema: type: string - name: version in: query description: Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header. required: false schema: type: string responses: '200': description: Returns the updated settings for the specified allocator content: application/json: schema: $ref: '#/components/schemas/AllocatorSettings' '404': description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - allocators.allocator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Allocators requestBody: content: application/json: schema: type: string description: The allocator settings to update required: true /platform/infrastructure/blueprinter/roles: get: tags: - PlatformInfrastructure summary: List roles description: Retrieve all persisted roles. operationId: list-blueprinter-roles responses: '200': description: The role aggregates. content: application/json: schema: $ref: '#/components/schemas/RoleAggregates' x-doc: tag: Roles post: tags: - PlatformInfrastructure summary: Create a role description: Create a Blueprinter role. operationId: create-blueprinter-role responses: '201': description: The role aggregate that was just created. content: application/json: schema: $ref: '#/components/schemas/RoleAggregate' '409': description: 'The role ID you specified is already in use. (code: `roles.already_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.already_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Roles requestBody: content: application/json: schema: $ref: '#/components/schemas/RoleAggregateCreateData' description: The data you want to use for creating a role. required: true /platform/infrastructure/blueprinter/roles/{blueprinter_role_id}: get: tags: - PlatformInfrastructure summary: Get role description: Retrieve a role. operationId: get-blueprinter-role parameters: - name: blueprinter_role_id in: path description: User-specified Blueprinter role ID. required: true schema: type: string responses: '200': description: The role aggregate definition. content: application/json: schema: $ref: '#/components/schemas/RoleAggregate' '404': description: 'The role can''t be found. (code: `roles.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Roles put: tags: - PlatformInfrastructure summary: Update role description: Update a role. operationId: update-blueprinter-role parameters: - name: blueprinter_role_id in: path description: User-specified Blueprinter role ID. required: true schema: type: string - name: version in: query description: When specified, 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: integer responses: '200': description: The role was successfully updated. content: application/json: schema: $ref: '#/components/schemas/RoleAggregate' '400': description: 'The role is currently running container sets. (code: `roles.in_use`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.in_use content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The role can''t be found. (code: `roles.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'Your request failed because the specified version does not match the persisted version. (code: `roles.version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Roles requestBody: content: application/json: schema: $ref: '#/components/schemas/Role' description: The role update data. required: true delete: tags: - PlatformInfrastructure summary: Delete role description: Delete a role. operationId: delete-blueprinter-role parameters: - name: blueprinter_role_id in: path description: User-specified Blueprinter role ID. required: true schema: type: string - name: skip_validations in: query description: When sent as true, ignores validation errors. required: false schema: type: boolean default: false - name: version in: query description: When specified, 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: integer responses: '200': description: The role was successfully deleted. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '400': description: 'The role is currently running container sets. (code: `roles.in_use`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.in_use content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The role can''t be found. (code: `roles.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'Your request failed because the specified version does not match the persisted version. (code: `roles.version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Roles /platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings: put: tags: - PlatformInfrastructure summary: Set blessings description: Set blessings for a role. operationId: set-blueprinter-blessings parameters: - name: blueprinter_role_id in: path description: User-specified Blueprinter role ID. required: true schema: type: string - name: version in: query description: When specified, 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: integer responses: '200': description: The blessings were successfully set. content: application/json: schema: $ref: '#/components/schemas/RoleAggregate' '404': description: 'The role can''t be found. (code: `roles.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'Your request failed because the specified version does not match the persisted version. (code: `roles.version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Roles requestBody: content: application/json: schema: $ref: '#/components/schemas/Blessings' description: The blessings to set. required: true /platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings/{runner_id}: put: tags: - PlatformInfrastructure summary: Add Blessing description: Add a Blessing for a runner to a role. operationId: add-blueprinter-blessing parameters: - name: blueprinter_role_id in: path description: User-specified Blueprinter role ID. required: true schema: type: string - name: runner_id in: path description: Runner ID for a blessing associated with a role. required: true schema: type: string - name: version in: query description: When specified, 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: integer responses: '200': description: Blessing added successfully. content: application/json: schema: $ref: '#/components/schemas/RoleAggregate' '404': description: 'The role can''t be found. (code: `roles.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'Your request failed because the specified version does not match the persisted version. (code: `roles.version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - roles.version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Roles requestBody: content: application/json: schema: $ref: '#/components/schemas/Blessing' description: The blessing to add. required: true /platform/infrastructure/constructors: get: tags: - PlatformInfrastructure summary: Get constructors description: Retrieves an overview of all constructors in an ECE installation. operationId: get-constructors responses: '200': description: An overview of all constructors. content: application/json: schema: $ref: '#/components/schemas/ConstructorOverview' x-doc: tag: Platform - Constructors /platform/infrastructure/constructors/_resync: post: tags: - PlatformInfrastructure summary: Resynchronize constructors description: Asynchronously synchronizes all constructor information in the back-end search index. operationId: resync-constructors 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: '202': description: The ids of documents, organized by model version, that will be synchronized. content: application/json: schema: $ref: '#/components/schemas/ModelVersionIndexSynchronizationResults' x-doc: tag: Platform - Constructors /platform/infrastructure/constructors/{constructor_id}: get: tags: - PlatformInfrastructure summary: Get constructor description: Retrieves a constructor by id. operationId: get-constructor parameters: - name: constructor_id in: path description: Identifier for the constructor required: true schema: type: string responses: '200': description: The information for the constructor specified by {constructor_id}. content: application/json: schema: $ref: '#/components/schemas/ConstructorInfo' '404': description: 'The constructor specified by {constructor_id} cannot be found. (code: `constructors.constructor_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.constructor_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Constructors /platform/infrastructure/constructors/{constructor_id}/_resync: post: tags: - PlatformInfrastructure summary: Resynchronize constructor description: Immediately resynchronizes the search index and cache for the selected constructor. operationId: resync-constructor parameters: - name: constructor_id in: path description: Identifier for the constructor required: true schema: type: string responses: '200': description: The constructor resync operation executed successfully content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '500': description: 'The constructor resync operation failed for allocator {constructor_id}. (code: `constructors.resync_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.resync_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Constructors /platform/infrastructure/constructors/{constructor_id}/logging_settings: get: tags: - PlatformInfrastructure summary: Get constructor logging settings description: Get the logging settings for this constructor instance. operationId: get-constructor-logging-settings parameters: - name: constructor_id in: path description: Identifier for the constructor required: true schema: type: string responses: '200': description: The logging settings for the constructor instance 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/LoggingSettings' '404': description: 'The logging settings for this constructor were not found. (code: `constructors.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Constructors put: tags: - PlatformInfrastructure summary: Set constructor logging settings description: Set the logging settings for this constructor instance. operationId: set-constructor-logging-settings parameters: - name: constructor_id in: path description: Identifier for the constructor required: true schema: type: string responses: '200': description: The updated logging settings for the constructor instance 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/LoggingSettings' '404': description: 'The logging settings for this constructor were not found. (code: `constructors.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Constructors requestBody: content: application/json: schema: $ref: '#/components/schemas/LoggingSettings' description: The new logging settings for the constructor instance required: true delete: tags: - PlatformInfrastructure summary: Delete constructor logging settings description: Reset the default logging settings for this constructor instance. operationId: delete-constructor-logging-settings parameters: - name: constructor_id in: path description: Identifier for the constructor required: true schema: type: string responses: '200': description: The updated logging settings for the constructor instance 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/LoggingSettings' '404': description: 'The logging settings for this constructor were not found. (code: `constructors.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Constructors patch: tags: - PlatformInfrastructure summary: Update constructor logging settings description: All changes in the specified object are applied to the logging settings for this constructor instance according to the JSON Merge Patch processing rules. Omitting existing fields causes the same values to be reapplied. Specifying a `null` value reverts the field to the default value, or removes the field when no default value exists. operationId: update-constructor-logging-settings parameters: - name: constructor_id in: path description: Identifier for the constructor required: true schema: type: string responses: '200': description: The updated logging settings for the constructor instance 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/LoggingSettings' '404': description: 'The logging settings for this constructor were not found. (code: `constructors.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The update request is invalid. (code: `patch.request_malformed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - patch.request_malformed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Constructors requestBody: content: application/json: schema: type: string description: The logging settings to update required: true /platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_start: post: tags: - PlatformInfrastructure summary: Start maintenance mode description: Start maintenance mode of a constructor. It will stop constructing new plans while continuing with on-going ones. operationId: start-constructor-maintenance-mode parameters: - name: constructor_id in: path description: Identifier for the constructor required: true schema: type: string responses: '202': description: The start maintenance mode command was issued successfully content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '403': description: 'The start maintenance mode command was prohibited for the given constructor. (code: `constructors.command_prohibited`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.command_prohibited content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The constructor specified by {constructor_id} cannot be found. (code: `constructors.constructor_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.constructor_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Constructors /platform/infrastructure/constructors/{constructor_id}/maintenance-mode/_stop: post: tags: - PlatformInfrastructure summary: Stop maintenance mode description: Stop maintenance mode of a constructor. It will resume the construction of submitted plans. operationId: stop-constructor-maintenance-mode parameters: - name: constructor_id in: path description: Identifier for the constructor required: true schema: type: string responses: '202': description: The stop maintenance mode command was issued successfully content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '403': description: 'The stop maintenance mode command was prohibited for the given constructor. (code: `constructors.command_prohibited`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.command_prohibited content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '404': description: 'The constructor specified by {constructor_id} cannot be found. (code: `constructors.constructor_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - constructors.constructor_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Constructors /platform/infrastructure/coordinators: get: tags: - PlatformInfrastructure summary: Get coordinators description: Retrieves an overview of all coordinators. operationId: get-coordinators responses: '200': description: An overview of all coordinators. content: application/json: schema: $ref: '#/components/schemas/CoordinatorsSummary' x-doc: tag: Platform - Coordinators /platform/infrastructure/coordinators/candidates: get: tags: - PlatformInfrastructure summary: Get coordinator candidates description: Retrieve a list of all coordinator candidates. operationId: get-coordinator-candidates responses: '200': description: A list of all coordinator candidates. content: application/json: schema: $ref: '#/components/schemas/CoordinatorCandidatesSummary' x-doc: tag: Platform - Coordinators /platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}: get: tags: - PlatformInfrastructure summary: Get a coordinator candidate description: Retrieve a coordinator candidate. operationId: get-coordinator-candidate parameters: - name: coordinator_candidate_id in: path description: The identifier for the coordinator candidate required: true schema: type: string responses: '200': description: Info about a coordinator candidate. content: application/json: schema: $ref: '#/components/schemas/CoordinatorCandidateInfo' '404': description: 'Unable to find coordinator candidate {coordinator_candidate_id}. Edit your request, then try again. (code: `coordinators.candidate_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - coordinators.candidate_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Coordinators delete: tags: - PlatformInfrastructure summary: Delete coordinator candidate description: Delete a coordinator candidate by id. operationId: delete-coordinator-candidate parameters: - name: coordinator_candidate_id in: path description: The identifier for the coordinator candidate required: true schema: type: string - name: version in: query description: cloud resource version required: false schema: type: string responses: '200': description: The coordinator candidate specified by {coordinator_candidate_id} was deleted. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: 'The coordinator candidate specified by {coordinator_candidate_id} cannot be found. (code: `coordinators.candidate_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - coordinators.candidate_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The coordinator specified by {coordinator_candidate_id} could not be deleted. (code: `coordinators.candidate_deletion_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - coordinators.candidate_deletion_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Coordinators /platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}/_promote: post: tags: - PlatformInfrastructure summary: Promote a coordinator candidate description: Promotes a coordinator candidate. operationId: promote-coordinator-candidate parameters: - name: coordinator_candidate_id in: path description: The identifier for the coordinator candidate required: true schema: type: string responses: '202': description: Accepted promote of coordinator candidate. content: application/json: schema: $ref: '#/components/schemas/CoordinatorCandidateInfo' '404': description: 'Unable to find coordinator candidate {coordinator_id}. Edit your request, then try again. (code: `coordinators.candidate_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - coordinators.candidate_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Coordinators /platform/infrastructure/coordinators/{coordinator_id}: get: tags: - PlatformInfrastructure summary: Get a coordinator description: Retrieve overview of a single coordinator. operationId: get-coordinator parameters: - name: coordinator_id in: path description: The identifier for the coordinator required: true schema: type: string responses: '200': description: An overview of a coordinator instance. content: application/json: schema: $ref: '#/components/schemas/CoordinatorSummary' '404': description: 'Unable to find coordinator {coordinator_id}. Edit your request, then try again. (code: `coordinators.coordinator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - coordinators.coordinator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Coordinators /platform/infrastructure/coordinators/{coordinator_id}/_demote: post: tags: - PlatformInfrastructure summary: Demote a coordinator description: Demotes a coordinator and removes Zookeeper from the host. operationId: demote-coordinator parameters: - name: coordinator_id in: path description: The identifier for the coordinator required: true schema: type: string responses: '200': description: Accepted demote of coordinator. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: 'Unable to find the coordinator {coordinator_id}. Edit your request, then try again. (code: `coordinators.coordinator_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - coordinators.coordinator_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The coordinator specified by {coordinator_id} could not be demoted. (code: `coordinators.coordinator_demote_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - coordinators.coordinator_demote_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Coordinators /platform/infrastructure/proxies: get: tags: - PlatformInfrastructure summary: Get proxies description: Retrieves an overview of all proxies. operationId: get-proxies responses: '200': description: An overview of all proxies. content: application/json: schema: $ref: '#/components/schemas/ProxyOverview' x-doc: tag: Platform - proxies /platform/infrastructure/proxies/filtered-groups: post: tags: - PlatformInfrastructure summary: Create filtered group of proxies description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Create the settings for a filtered group of proxies.' operationId: create-proxies-filtered-group responses: '200': description: Returns the created or updated filtered group of proxies 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/ProxiesFilteredGroup' '400': description: '* The filtered group of proxies has empty id. (code: `proxies.proxies_filtered_group_empty_id`) * A filtered group of proxies with the same identifier already exists. (code: `proxies.proxies_filtered_group_already_exists`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.proxies_filtered_group_empty_id - proxies.proxies_filtered_group_already_exists content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - proxies requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxiesFilteredGroup' description: Data for the filtered group of proxies to create required: true /platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}: get: tags: - PlatformInfrastructure summary: Get filtered group of proxies description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Get data for a filtered group of proxies.' operationId: get-proxies-filtered-group parameters: - name: proxies_filtered_group_id in: path description: '"The identifier for the filtered group of proxies' required: true schema: type: string responses: '200': description: Data for the filtered group of proxies identified by {proxies_filtered_group_id} 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/ProxiesFilteredGroup' '404': description: 'Unable to find the {proxies_filtered_group_id} specified filtered group of proxies. Edit your request, then try again. (code: `proxies.proxies_filtered_group_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.proxies_filtered_group_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - proxies put: tags: - PlatformInfrastructure summary: Update filtered group of proxies description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Update the settings for a filtered group of proxies.' operationId: update-proxies-filtered-group parameters: - name: proxies_filtered_group_id in: path description: '"The identifier for the filtered group of proxies' required: true schema: type: string - name: version in: query description: Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header. required: false schema: type: string responses: '200': description: Returns the created or updated filtered group of proxies 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/ProxiesFilteredGroup' '400': description: 'The provided identifier doesn''t match the identifier in the object. (code: `proxies.proxies_filtered_group_id_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.proxies_filtered_group_id_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'There is a version conflict. (code: `proxies.proxies_filtered_group_version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.proxies_filtered_group_version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - proxies requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxiesFilteredGroup' description: Data for the filtered group of proxies to update required: true delete: tags: - PlatformInfrastructure summary: Delete filtered group of proxies description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Deletes a filtered group of proxies by ID.' operationId: delete-proxies-filtered-group parameters: - name: proxies_filtered_group_id in: path description: '"The identifier for the filtered group of proxies' required: true schema: type: string - name: version in: query description: Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header. required: false schema: type: string responses: '200': description: The filtered group of proxies was successfully deleted content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: 'Unable to find the {proxies_filtered_group_id} specified filtered group of proxies. Edit your request, then try again. (code: `proxies.proxies_filtered_group_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.proxies_filtered_group_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '409': description: 'There is a version conflict. (code: `proxies.proxies_filtered_group_version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.proxies_filtered_group_version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - proxies /platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health: get: tags: - PlatformInfrastructure summary: Get health for a filtered group of proxies description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Get the health status of a filtered group of proxies.' operationId: get-proxies-filtered-group-health parameters: - name: proxies_filtered_group_id in: path description: '"The identifier for the filtered group of proxies' required: true schema: type: string - name: expect_status in: query description: The expected status required: false schema: type: string responses: '200': description: Returns health information on a filtered group of proxies content: application/json: schema: $ref: '#/components/schemas/ProxiesFilteredGroupHealth' '417': description: The health status is worse than the expected one. content: application/json: schema: $ref: '#/components/schemas/ProxiesFilteredGroupHealth' x-doc: tag: Platform - proxies /platform/infrastructure/proxies/health: get: tags: - PlatformInfrastructure summary: Get proxy health description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Get the health status of all proxies.' operationId: get-proxies-health parameters: - name: expect_status in: query description: The expected status required: false schema: type: string responses: '200': description: Returns health information on all the proxies content: application/json: schema: $ref: '#/components/schemas/ProxiesHealth' '417': description: The health status is worse than the expected one. content: application/json: schema: $ref: '#/components/schemas/ProxiesHealth' x-doc: tag: Platform - proxies /platform/infrastructure/proxies/settings: get: tags: - PlatformInfrastructure summary: Get proxies settings description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Retrieves the settings for all proxies.' operationId: get-proxies-settings responses: '200': description: Settings for all proxies. content: application/json: schema: $ref: '#/components/schemas/ProxiesSettings' x-doc: tag: Platform - proxies put: tags: - PlatformInfrastructure summary: Set proxy settings description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Overwrites the proxy settings. All unspecified fields are deleted.' operationId: set-proxies-settings parameters: - name: version in: query description: If specified, checks for conflicts against the version of the settings (returned in 'x-cloud-resource-version' of the GET request) required: false schema: type: string responses: '200': description: Returns the updated settings content: application/json: schema: $ref: '#/components/schemas/ProxiesSettings' '409': description: 'There is a version conflict. (code: `proxies.version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - proxies requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxiesSettings' description: The proxy settings to apply required: true patch: tags: - PlatformInfrastructure summary: Update proxy settings description: '> WARNING > This endpoint is deprecated and scheduled to be removed in the next major version. Applies the settings as a patch. Only the fields that are referenced in the update are changed.' operationId: update-proxies-settings parameters: - name: version in: query description: If specified, checks for conflicts against the version of the repository configuration (returned in 'x-cloud-resource-version' of the GET request) required: false schema: type: string responses: '200': description: Returns the updated settings content: application/json: schema: $ref: '#/components/schemas/ProxiesSettings' '409': description: 'There is a version conflict. (code: `proxies.version_conflict`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.version_conflict content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - proxies requestBody: content: application/json: schema: type: string description: A JSON to merge with the existing settings required: true /platform/infrastructure/proxies/{proxy_id}: get: tags: - PlatformInfrastructure summary: Get proxy description: Retrieves a single proxy by ID. operationId: get-proxy parameters: - name: proxy_id in: path description: The identifier for the proxy required: true schema: type: string responses: '200': description: The information for the proxy specified by {proxy_id}. content: application/json: schema: $ref: '#/components/schemas/ProxyInfo' '404': description: 'Unable to find the {proxy_id} specified proxy. Edit your request, then try again. (code: `proxies.proxy_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - proxies.proxy_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - proxies /platform/infrastructure/runners: get: tags: - PlatformInfrastructure summary: Get runners description: Retrieves an overview of all runners. operationId: get-runners parameters: - name: q in: query description: An optional query to filter runners by. Maps to an Elasticsearch query_string query. required: false schema: type: string responses: '200': description: An overview of all runners. content: application/json: schema: $ref: '#/components/schemas/RunnerOverview' x-doc: tag: Platform - Runners /platform/infrastructure/runners/_resync: post: tags: - PlatformInfrastructure summary: Resynchronize runners description: Asynchronously synchronizes all runner information in the search index. operationId: resync-runners 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: '202': description: The ids of documents, organized by model version, that will be synchronized. content: application/json: schema: $ref: '#/components/schemas/ModelVersionIndexSynchronizationResults' x-doc: tag: Platform - Runners /platform/infrastructure/runners/_search: post: tags: - PlatformInfrastructure summary: Search runners description: Retrieves runners that match a given query. operationId: search-runners responses: '200': description: An overview of runners that matched the given search query. content: application/json: schema: $ref: '#/components/schemas/RunnerOverview' '400': description: 'The search request failed. (code: `runners.search_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.search_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' description: The optional search request to execute. If not supplied then all runners are matched. /platform/infrastructure/runners/{runner_id}: get: tags: - PlatformInfrastructure summary: Get runner description: Retrieves a runner by id. operationId: get-runner parameters: - name: runner_id in: path description: The identifier for the runner required: true schema: type: string responses: '200': description: The information for the runner specified by {runner_id}. content: application/json: schema: $ref: '#/components/schemas/RunnerInfo' '404': description: 'Unable to find the {runner_id} specified runner. Edit your request, then try again. (code: `runners.runner_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.runner_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners delete: tags: - PlatformInfrastructure summary: Delete runner description: Delete a runner by id. operationId: delete-runner parameters: - name: runner_id in: path description: The identifier for the runner required: true schema: type: string responses: '200': description: The runner specified by {runner_id} was deleted. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: 'The runner specified by {runner_id} cannot be found. (code: `runners.runner_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.runner_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The runner specified by {runner_id} could not be deleted. (code: `runners.runner_deletion_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.runner_deletion_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners /platform/infrastructure/runners/{runner_id}/_resync: post: tags: - PlatformInfrastructure summary: Resynchronize runner description: Immediately resynchronizes the search index and cache for the selected runner. operationId: resync-runner parameters: - name: runner_id in: path description: The identifier for the runner required: true schema: type: string responses: '200': description: The runner resync operation executed successfully content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '500': description: 'The runner resync operation failed for runner {runner_id}. (code: `runners.resync_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.resync_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners /platform/infrastructure/runners/{runner_id}/logging_settings: get: tags: - PlatformInfrastructure summary: Get runner logging settings description: Get the logging settings for this runner instance. operationId: get-runner-logging-settings parameters: - name: runner_id in: path description: The identifier for the runner required: true schema: type: string responses: '200': description: The logging settings for the runner instance 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/LoggingSettings' '404': description: 'The logging settings for this runner were not found. (code: `runners.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners put: tags: - PlatformInfrastructure summary: Set runner logging settings description: Set the logging settings for this runner instance. operationId: set-runner-logging-settings parameters: - name: runner_id in: path description: The identifier for the runner required: true schema: type: string responses: '200': description: The updated logging settings for the runner instance 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/LoggingSettings' '404': description: 'The logging settings for this runner were not found. (code: `runners.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners requestBody: content: application/json: schema: $ref: '#/components/schemas/LoggingSettings' description: The new logging settings for the runner instance required: true delete: tags: - PlatformInfrastructure summary: Delete runner logging settings description: Reset the default logging settings for this runner instance. operationId: delete-runner-logging-settings parameters: - name: runner_id in: path description: The identifier for the runner required: true schema: type: string responses: '200': description: The updated logging settings for the runner instance 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/LoggingSettings' '404': description: 'The logging settings for this runner were not found. (code: `runners.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners patch: tags: - PlatformInfrastructure summary: Update runner logging settings description: All changes in the specified object are applied to the logging settings for this runner instance according to the JSON Merge Patch processing rules. Omitting existing fields causes the same values to be reapplied. Specifying a `null` value reverts the field to the default value, or removes the field when no default value exists. operationId: update-runner-logging-settings parameters: - name: runner_id in: path description: The identifier for the runner required: true schema: type: string responses: '200': description: The updated logging settings for the runner instance 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/LoggingSettings' '404': description: 'The logging settings for this runner were not found. (code: `runners.logging_settings.not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.logging_settings.not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'The update request is invalid. (code: `patch.request_malformed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - patch.request_malformed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners requestBody: content: application/json: schema: type: string description: The logging settings to update required: true /platform/infrastructure/runners/{runner_id}/roles: put: tags: - PlatformInfrastructure summary: Set runner roles description: Set runner roles. operationId: set-runner-roles parameters: - name: runner_id in: path description: The identifier for the runner required: true schema: type: string - name: bless in: query description: Assigns the runner to the roles. required: false schema: type: boolean responses: '200': description: The roles for the {runner_id} specified runner are assigned. content: application/json: schema: $ref: '#/components/schemas/RunnerRolesInfo' '404': description: 'Unable to find the {runner_id} specified runner. Edit your request, then try again. (code: `runners.runner_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.runner_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' '400': description: 'There was an error while assigning the roles for the {runner_id} specified runner. Try your request again. (code: `runners.runner_set_roles_failed`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - runners.runner_set_roles_failed content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - Runners requestBody: content: application/json: schema: $ref: '#/components/schemas/RunnerRolesInfo' description: The roles for the runner that you want to apply. required: true /platform/license: get: tags: - PlatformInfrastructure summary: Get license description: Retrieves the license. operationId: get-license responses: '200': description: The information for the license. content: application/json: schema: $ref: '#/components/schemas/LicenseObject' '404': description: 'The license cannot be found. (code: `license.license_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - license.license_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - License put: tags: - PlatformInfrastructure summary: Add or update license description: Adds a new or updates an existing license. operationId: set-license responses: '200': description: The license was updated. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '400': description: 'The license could not be updated. (code: `license.invalid_license`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - license.invalid_license content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - License requestBody: content: application/json: schema: $ref: '#/components/schemas/LicenseObject' description: The license to add or update. required: true delete: tags: - PlatformInfrastructure summary: Delete license description: Deletes the license. operationId: delete-license responses: '200': description: The license was deleted. content: application/json: schema: $ref: '#/components/schemas/EmptyResponse' '404': description: 'The license cannot be found. (code: `license.license_not_found`)' headers: x-cloud-error-codes: description: The error codes associated with the response schema: type: string enum: - license.license_not_found content: application/json: schema: $ref: '#/components/schemas/BasicFailedReply' x-doc: tag: Platform - License components: schemas: LicenseInfo: type: object required: - expiry_date_in_millis - issue_date_in_millis - issued_to - issuer - signature - start_date_in_millis - type - uid properties: version: type: integer format: int32 description: Version of the license uid: type: string description: Unique identifier of the license issuer: type: string description: Issuer of the license issued_to: type: string description: Entity the license was issued to issue_date_in_millis: type: integer format: int64 description: When the license was issued, in milliseconds since the Unix epoch type: type: string description: Type of the license subscription_type: type: string description: Type of the license subscription signature: type: string description: Digital signature start_date_in_millis: type: integer format: int64 description: Initial validity of the license, in milliseconds since the Unix epoch expiry_date_in_millis: type: integer format: int64 description: When the license expires, in milliseconds since the Unix epoch max_allocators: type: integer format: int32 description: Maximum number of allocators. Empty for version >= 3 max_ram_per_allocator_mb: type: integer format: int32 description: Maximum RAM per allocator in MB. Empty for version >= 3 max_instances: type: integer format: int32 description: Maximum number of instances. Only present for version 3 max_resource_units: type: integer format: int32 description: Maximum number of resource units, where each unit is 64GB. Only present for version > 3 operation_mode: type: string description: Operation mode cluster_licenses: type: array description: List of cluster licenses items: $ref: '#/components/schemas/ClusterLicenseInfo' description: Information about a license. 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 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. LoggingSettings: type: object required: - logging_levels properties: logging_levels: type: object description: Overridden logging levels. Keys are logging levels. Allowable values are OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL additionalProperties: type: string description: Information about logging settings. ProxyInfo: type: object required: - allocations - healthy - host_ip - metadata - proxy_id - public_hostname properties: proxy_id: type: string description: The proxy identifier runner_id: type: string description: Identifier of the runner for the proxy host_ip: type: string description: IP of the host the proxy runs on public_hostname: type: string description: Public hostname of the host the proxy runs on metadata: type: object description: Arbitrary metadata associated with the proxy properties: {} healthy: type: boolean description: Specifies if the proxy is healthy zone: type: string description: The zone. allocations: type: array description: Allocation information by type. items: $ref: '#/components/schemas/ProxyAllocationInfo' description: Information about a proxy. 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 CoordinatorCandidatesSummary: type: object required: - candidates properties: candidates: type: array description: Summarized information on each coordinator candidate items: $ref: '#/components/schemas/CoordinatorCandidateInfo' description: Summarized information about coordinator candidates. 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. CoordinatorSummary: type: object required: - attributes - client_port - election_port - leader_port - name - public_hostname properties: name: type: string description: Name of this coordinator public_hostname: type: string description: Public hostname of this coordinator leader_port: type: integer format: int32 description: Leader port of this coordinator election_port: type: integer format: int32 description: Election port of this coordinator client_port: type: integer format: int32 description: Client port of this coordinator attributes: type: object description: Attributes of this coordinator additionalProperties: type: string description: Summarized information about a coordinator. 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. MoveKibanaClusterConfiguration: type: object required: - cluster_ids properties: cluster_ids: type: array description: Identifiers for the Kibana clusters. items: type: string plan_override: description: Plan override to apply to the Kibana clusters being moved. $ref: '#/components/schemas/TransientKibanaPlanConfiguration' description: The configuration object for moving Kibana instances. AllocatorCapacityMemory: type: object required: - total - used properties: total: type: integer format: int32 description: Total memory in MB capacity installed on this allocator used: type: integer format: int32 description: Used memory in MB used by instances assigned to this allocator description: The available and used memory of the allocator. MoveEnterpriseSearchDetails: type: object required: - cluster_id properties: cluster_id: type: string description: Identifier for the Elastic Enterprise Search. calculated_plan: description: If only validating the move, then the plan configuration that would be applied to the cluster. $ref: '#/components/schemas/TransientEnterpriseSearchPlanConfiguration' errors: type: array description: A list of errors that occurred if the attempt to move the cluster failed. items: $ref: '#/components/schemas/BasicFailedReplyElement' description: Information about the Elastic Enterprise Search that you want to move. EmptyResponse: type: object AllocatedInstancePlansInfo: type: object required: - pending properties: pending: type: boolean description: Whether or not there is a pending plan. version: type: string description: The version of the current plan, falling back to that of the pending plan if it exists. zone_count: type: integer format: int32 description: The number of zones in the current plan, falling back to that of the pending plan if it exists. description: The plan information for the Elasticsearch cluster associated with the Kibana instance or APM Server. AdminconsolesOverview: type: object required: - adminconsoles properties: adminconsoles: type: array description: List of adminconsoles items: $ref: '#/components/schemas/AdminconsoleInfo' description: Information about all of the adminconsoles. AllocatorHealthChecks: type: object required: - has_instances - is_connected_to_zk - is_docker_healthy properties: is_docker_healthy: type: boolean description: Check performed by the allocator to figure out if docker is healthy is_connected_to_zk: type: boolean description: Whether the allocator is connected to zk or not has_instances: type: boolean description: Whether the allocator has allocated instances description: The checks performed to determine if an allocator is healthy or not. ConfigStoreOption: type: object required: - changed - name - value properties: name: type: string description: Name of this Config Store Option value: type: string description: Value of this Config Store Option changed: type: boolean description: Whether or not this Config Store Option has changed description: Information about the Config Store options. ContainerConfigHostConfig: type: object required: - binds - extra_hosts - port_bindings - privileged properties: extra_hosts: type: array description: Ports that are exposed by the container. items: type: string network_mode: type: string description: ' Sets the networking mode for the container.' cpu_period: type: integer format: int32 description: The length of a CPU period in microsecond restart_policy: description: Docker behavior to apply when a container exits $ref: '#/components/schemas/RestartPolicy' port_bindings: type: object description: Map of ports that should be exposed on the host. additionalProperties: type: array items: $ref: '#/components/schemas/PortBinding' binds: type: array description: Volume bindings for the container. items: type: string privileged: type: boolean description: List of environment variables on the form KEY=value description: ' Docker host config' MoveApmClusterConfiguration: type: object required: - cluster_ids properties: cluster_ids: type: array description: Identifiers for the Apm clusters. items: type: string plan_override: description: Plan override to apply to the Apm clusters being moved. $ref: '#/components/schemas/TransientApmPlanConfiguration' description: The configuration object for moving APM Servers. AllocatedInstanceStatus: type: object required: - cluster_id - cluster_type - instance_name - node_memory properties: cluster_type: type: string description: Type of instance that is running enum: - elasticsearch - kibana - apm - integrations_server - appsearch - enterprise_search cluster_id: type: string description: Identifier for the cluster this instance belongs cluster_name: type: string description: Name of cluster this instance belongs, if available instance_name: type: string description: Instance ID of the instance node_memory: type: integer format: int32 description: Memory assigned to this instance healthy: type: boolean description: Indicates whether the instance is healthy cluster_healthy: type: boolean description: Indicates whether the cluster the instance belongs to is healthy instance_configuration_id: type: string description: The instance configuration id of this instance moving: type: boolean description: Indicates whether the instance is vacating away from this allocator. Note that this is currently not populated when returned from the search endpoint. plans_info: description: The plans associated with the current instance. Note that this is currently not populated when returned from the search endpoint. $ref: '#/components/schemas/AllocatedInstancePlansInfo' deployment_id: type: string description: The id of the deployment this cluster belongs to. description: The status of the allocated Kibana instance or APM Server. CoordinatorsSummary: type: object required: - coordinators properties: coordinators: type: array description: Summarized information on each coordinator items: $ref: '#/components/schemas/CoordinatorSummary' description: Summarized information about coordinators. RoleAggregates: type: object required: - values properties: values: type: array description: The list items: $ref: '#/components/schemas/RoleAggregate' description: A list of Role aggregates ApiBaseUrlData: type: object required: - value properties: value: type: string description: The configured base Url description: Information about the API base Url ZkAcl: type: object required: - id - perms - scheme properties: perms: type: integer format: int32 description: ZK static permissions for admin/all/create/read/write/delete scheme: type: string description: Zookeeper ACL scheme id: type: string description: Identity within provided scheme description: Represents a Zookeeper ACL permission RunnerBuildInfo: type: object properties: commit_hash: type: string description: Git commit hash version: type: string description: Version of the runner artifact ProxyAllocationInfo: type: object required: - allocations_type - counts properties: allocations_type: type: string description: The type of proxy allocations enum: - elasticsearch - kibana - apm - integrations_server - appsearch - enterprise_search counts: description: Proxy allocation counts. $ref: '#/components/schemas/ProxyAllocationCounts' description: The single proxy allocation for a specified type, such as Elasticsearch, Kibana, or APM. RunnerInfo: type: object required: - connected - containers - healthy - host_ip - public_hostname - roles - runner_id properties: runner_id: type: string description: The runner identifier runner_name: type: string description: The runner name zone: type: string description: Identifier of the zone tags: type: object description: Meta data of the runner, like image ID or processor architecture additionalProperties: type: string features: type: object description: State of features of the runner additionalProperties: type: boolean build_info: description: Build Info of the container artifact $ref: '#/components/schemas/RunnerBuildInfo' host_ip: type: string description: Host IP for the runner public_hostname: type: string description: Public hostname for the runner containers: type: array description: Containers for the runner items: $ref: '#/components/schemas/RunnerContainerInfo' roles: type: array description: Roles for the runner items: $ref: '#/components/schemas/RunnerRoleInfo' connected: type: boolean description: Specifies if the runner is connected healthy: type: boolean description: Specifies if the runner is healthy health_checks: description: Checks used to determine if a runner is healthy or not $ref: '#/components/schemas/RunnerHealthChecks' region: type: string description: The region that this runner belongs to. Only populated in SaaS or federated ECE. description: Information about a specified runner. ConfigStoreOptionData: type: object required: - value properties: value: type: string description: Value of this Config Store Option description: The data for the Config Store options. ClusterLicenseInfo: type: object required: - license properties: license: type: object description: Object containing the cluster license data properties: {} description: Information about the Elasticsearch cluster license. MoveClustersDetails: type: object required: - apm_clusters - appsearch_clusters - elasticsearch_clusters - enterprise_search_clusters - kibana_clusters properties: elasticsearch_clusters: type: array description: Detailed information about the Elasticsearch clusters being moved. items: $ref: '#/components/schemas/MoveElasticsearchClusterDetails' kibana_clusters: type: array description: Detailed information about the Kibana clusters being moved. items: $ref: '#/components/schemas/MoveKibanaClusterDetails' apm_clusters: type: array description: Detailed information about the Apm clusters being moved. items: $ref: '#/components/schemas/MoveApmClusterDetails' appsearch_clusters: type: array description: Detailed information about the App Search clusters being moved. items: $ref: '#/components/schemas/MoveAppSearchDetails' enterprise_search_clusters: type: array description: Detailed information about the Elastic Enterprise Search clusters being moved. items: $ref: '#/components/schemas/MoveEnterpriseSearchDetails' description: Information about the Elasticsearch clusters, multiple Kibana instances, and multiple APM Servers that are moved off of the allocator. 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. 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. AllocatorZoneInfo: type: object required: - allocators - zone_id properties: zone_id: type: string description: Identifier of the zone allocators: type: array items: $ref: '#/components/schemas/AllocatorInfo' description: The allocators for the specified zone. 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. AllocatorOverview: type: object required: - zones properties: zones: type: array items: $ref: '#/components/schemas/AllocatorZoneInfo' description: The overview information for the installed allocators. RoleWithMeta: type: object required: - meta - value properties: value: description: The pending stages $ref: '#/components/schemas/Role' meta: description: The metadata $ref: '#/components/schemas/Metadata' description: Persisted role along with metadata CoordinatorCandidateInfo: type: object required: - acl - attributes - name - public_hostname - state properties: name: type: string description: Name of this coordinator candidate. public_hostname: type: string description: Public hostname of this coordinator candidate acl: description: Zookeeper ACL of nodes this coordinator candidate is allowed to read $ref: '#/components/schemas/ZkAcl' id: type: integer format: int32 description: Zookeeper server identifier corresponding to this coordinator candidate attributes: type: object description: Attributes of this coordinator candidate additionalProperties: type: string state: type: string description: State of the candidate enum: - accepted - pending description: Summarized information about a coordinator candidate. 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. ProxiesFilteredGroupHealth: type: object required: - group - observed_proxies_count - status properties: group: description: Settings of the filtered group $ref: '#/components/schemas/ProxiesFilteredGroup' observed_proxies_count: type: integer format: int32 description: The number of proxies that match all of the filters in the group status: type: string description: '"Health status for this filtered group. One of "Green", "Yellow" or "Red"' description: The health status of a filtered proxy group. AllocatorBuildInfo: type: object properties: commit_hash: type: string description: Git commit hash version: type: string description: Version of the artifact description: Information about the build that is running on the allocator. 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 LicenseObject: type: object required: - license properties: license: description: License data $ref: '#/components/schemas/LicenseInfo' usage_stats: description: Information about current usage. readOnly: true $ref: '#/components/schemas/UsageStats' description: The container for a license. RunnerRoleInfo: type: object required: - role_name properties: role_name: type: string description: Name of the role description: Information about a runner role. ContainersEntryOptionsACL: type: object required: - id - perms - scheme properties: id: type: string description: Identity within the provided scheme. perms: type: integer format: int32 description: Permissions scheme: type: string description: Auth scheme, in Elastic Cloud this is usually "digest" description: ZooKeeper ACL information. MoveEnterpriseSearchConfiguration: type: object required: - cluster_ids properties: cluster_ids: type: array description: Identifiers for the Elastic Enterprise Search clusters. items: type: string plan_override: description: Plan override to apply to the Elastic Enterprise Search instances being moved. $ref: '#/components/schemas/TransientEnterpriseSearchPlanConfiguration' description: The configuration object for moving Elastic Enterprise Search instances. MoveElasticsearchClusterConfiguration: type: object required: - cluster_ids properties: cluster_ids: type: array description: Identifiers for the Elasticsearch clusters. items: type: string plan_override: description: Plan override to apply to the Elasticsearch clusters being moved. $ref: '#/components/schemas/TransientElasticsearchPlanConfiguration' description: The configuration object for moving Elasticsearch clusters. ConstructorHealthStatus: type: object required: - connected - maintenance_mode properties: connected: type: boolean description: Whether the constructor is connected maintenance_mode: type: boolean description: Whether the constructor is in maintenance mode description: The health status of the constructor. RunnerHealthChecks: type: object required: - has_containers - is_connected_to_zk - is_docker_healthy properties: is_docker_healthy: type: boolean description: Check performed by the runner to figure out if docker is healthy is_connected_to_zk: type: boolean description: Whether the runner is connected to zk or not has_containers: type: boolean description: Whether the runner has containers that it manages description: The checks performed to determine if an runner is healthy or not. AutodetectStrategyConfig: type: object description: A strategy that lets constructor choose the most optimal way to execute the plan. ConstructorInfo: type: object required: - constructor_id - status properties: status: $ref: '#/components/schemas/ConstructorHealthStatus' constructor_id: type: string description: Identifier for this constructor description: Information about the constructor. 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 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. ProxiesFilteredGroup: type: object required: - expected_proxies_count - filters properties: id: type: string description: Identifier of the filtered group of proxies filters: type: array description: Filters to be matched items: $ref: '#/components/schemas/ProxiesFilter' expected_proxies_count: type: integer format: int32 description: Expected minimum number of proxies matching all filters in this group description: A set of proxy filters with an expected number of matching proxies. ProxiesSettings: type: object required: - expected_proxies_count - http_settings - signature_secret - signature_valid_for_millis properties: expected_proxies_count: type: integer format: int32 description: Expected number of proxies signature_secret: type: string description: Secret string for signature generation signature_valid_for_millis: type: integer format: int64 description: Signature validity in milliseconds http_settings: description: HTTP settings $ref: '#/components/schemas/ProxiesHttpSettings' description: '> WARNING > This object is deprecated and scheduled to be removed in the next major version.' MatchAllQuery: type: object description: A query that matches all documents. 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.' UsageStats: type: object required: - total_connected_memory_total properties: total_connected_memory_total: type: integer format: int32 description: The total amount of memory available to your system description: Information about the current usage. ContainersEntryOptions: type: object required: - acls - auths - enabled properties: enabled: type: boolean description: Whether this allocation is active and should be created. auths: type: array description: ZooKeeper Auths associated with this allocation items: $ref: '#/components/schemas/ContainersEntryOptionsAuth' acls: type: array description: ZooKeeper ACLs associated with this allocation items: $ref: '#/components/schemas/ContainersEntryOptionsACL' runners_secret: type: string description: Secret shared between the runners that have containers in this container set allocated. container_set_secret: type: string description: Secret shared between the containers that are part of this container set. enabled_by_named_feature_flag: type: string description: 'A named feature flag to check whether this container is enabled or not ' overrides: description: Allocation-specific overrides for the allocated containers $ref: '#/components/schemas/ContainersEntryOptionsOverrides' description: Options for a ContainersEntry belonging to a role 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. AllocatorCapacity: type: object required: - memory - storage properties: memory: $ref: '#/components/schemas/AllocatorCapacityMemory' storage: description: The storage capacity of the allocator. $ref: '#/components/schemas/AllocatorCapacityStorage' available_cpus: type: integer format: int32 description: Total number of CPUs available on this allocator additional_master_bonus: type: number format: float description: Additional bonus CPU shares available to Elasticsearch master instances description: The total and used capacity of the allocator. Role: type: object required: - auto_blessed - containers - id properties: id: type: string example: constructor description: The unique id of this role auto_blessed: type: boolean description: Whether runners are automatically allowed to be assigned the containers of this role. containers: type: array description: The containers that are part of this role items: $ref: '#/components/schemas/ContainersEntry' description: Describes whether certain runners are blessed to run a Role. 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. AllocatorInfo: type: object required: - allocator_id - capacity - external_links - features - host_ip - instances - metadata - public_hostname - settings - status - zone_id properties: status: $ref: '#/components/schemas/AllocatorHealthStatus' allocator_id: type: string description: Identifier for this allocator zone_id: type: string description: Identifier of the zone host_ip: type: string description: Host IP of this allocator public_hostname: type: string description: Public hostname of this allocator capacity: $ref: '#/components/schemas/AllocatorCapacity' settings: $ref: '#/components/schemas/AllocatorSettings' instances: type: array items: $ref: '#/components/schemas/AllocatedInstanceStatus' metadata: type: array description: Arbitrary metadata associated with this allocator items: $ref: '#/components/schemas/MetadataItem' build_info: description: Build Info of the artifact $ref: '#/components/schemas/AllocatorBuildInfo' features: type: array description: List of features associated with this allocator. Note this is only present for backwards compatibility purposes and is scheduled for removal in the next major version release. items: type: string external_links: type: array description: External resources related to this allocator. uniqueItems: true items: $ref: '#/components/schemas/ExternalHyperlink' region: type: string description: The region that this allocator belongs to. Only populated in SaaS or federated ECE. description: The overview information for the allocator. RoleAggregate: type: object required: - id - role properties: id: type: string example: constructor description: The unique id of this role role: description: The role data with metadata $ref: '#/components/schemas/RoleWithMeta' blessings: description: The blessings data associated with the role $ref: '#/components/schemas/BlessingsWithMeta' pending: description: The pending states data associated with the role $ref: '#/components/schemas/PendingStatesWithMeta' description: Describes whether certain runners are blessed to run a Role. ConstructorOverview: type: object required: - constructors properties: constructors: type: array items: $ref: '#/components/schemas/ConstructorInfo' description: The overview information for the installed constructors. ProxyAllocationCounts: type: object required: - allocations - connectors properties: allocations: type: integer format: int32 description: The allocations count. connectors: type: integer format: int32 description: The connector count. description: The number of proxy allocations. RestartPolicy: type: object required: - name properties: name: type: string description: Identifier for the policy. maximum_retry_count: type: integer format: int32 description: Maximum number of times to re-try before giving up description: A policy that is applied when a container unexpectedly exits 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. 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. MoveElasticsearchClusterDetails: type: object required: - cluster_id properties: cluster_id: type: string description: Identifier for the Elasticsearch cluster. calculated_plan: description: If only validating the move, then the plan configuration that would be applied to the cluster. $ref: '#/components/schemas/TransientElasticsearchPlanConfiguration' errors: type: array description: A list of errors that occurred if the attempt to move the cluster failed. items: $ref: '#/components/schemas/BasicFailedReplyElement' description: Information about the Elasticsearch cluster that you want to move. 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. ConfigStoreOptionList: type: object required: - values properties: values: type: array description: List of Config Store Options items: $ref: '#/components/schemas/ConfigStoreOption' description: A list of Config Store values. 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. ProxiesAllocationsInfo: type: object required: - allocations_type - max_allocations - proxies_at_max_allocations properties: allocations_type: type: string description: The type of proxy allocations (e.g. Elasticsearch, Kibana, APM) max_allocations: type: integer format: int32 description: The maximum number of allocations proxies_at_max_allocations: type: integer format: int32 description: The number of proxies that have the maximum number of allocations description: The allocation status for a specified type, such as Elasticsearch, Kibana, or APM. The status is part of the overall proxy health information. MoveKibanaClusterDetails: type: object required: - cluster_id properties: cluster_id: type: string description: Identifier for the Kibana cluster. calculated_plan: description: If only validating the move, then the plan configuration that would be applied to the cluster. $ref: '#/components/schemas/TransientKibanaPlanConfiguration' errors: type: array description: A list of errors that occurred if the attempt to move the cluster failed. items: $ref: '#/components/schemas/BasicFailedReplyElement' description: Information about the Kibana instance that you want to move. 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 BlessingsWithMeta: type: object required: - meta - value properties: value: description: The blessings $ref: '#/components/schemas/Blessings' meta: description: The metadata $ref: '#/components/schemas/Metadata' description: Persisted Blessings along with metadata 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. PendingStatesWithMeta: type: object required: - meta - value properties: value: description: The pending stages $ref: '#/components/schemas/PendingStates' meta: description: The metadata $ref: '#/components/schemas/Metadata' description: Persisted pending states for a role along with metadata PendingStates: type: object required: - runner_ids_to_pending_state properties: runner_ids_to_pending_state: type: object description: A mapping of Runner Ids to whether or not they are waiting to be blessed to run the associated role additionalProperties: $ref: '#/components/schemas/PendingState' description: Describes whether certain runners are waiting to be blessed. MetadataItems: type: object required: - items properties: items: type: array description: A collection of arbitrary metadata items associated with a resource. items: $ref: '#/components/schemas/MetadataItem' description: The container object for metadata items. AllocatorSettings: type: object properties: capacity: type: integer format: int32 description: A memory capacity (in MB) that overrides the capacity defined during installation - requires separate restart of Allocator services on each host to take full effect. description: The settings for the allocator. RunnerContainerInfo: type: object required: - container_name - container_set_name properties: container_name: type: string description: Name of this container container_set_name: type: string description: Name of the container set for the container description: Information about a container within a runner. MoveAppSearchDetails: type: object required: - cluster_id properties: cluster_id: type: string description: Identifier for the App Search. calculated_plan: description: If only validating the move, then the plan configuration that would be applied to the cluster. $ref: '#/components/schemas/TransientAppSearchPlanConfiguration' errors: type: array description: A list of errors that occurred if the attempt to move the cluster failed. items: $ref: '#/components/schemas/BasicFailedReplyElement' description: Information about the App Search that you want to move. AllocatorHealthStatus: type: object required: - connected - healthy - maintenance_mode properties: connected: type: boolean description: Whether the allocator is connected healthy: type: boolean description: Whether the allocator is healthy, meaning it is either connected or has no instances health_checks: description: Checks used to determine if an allocator is healthy or not $ref: '#/components/schemas/AllocatorHealthChecks' maintenance_mode: type: boolean description: Whether the allocator is in maintenance mode (meaning that new workload won't be assigned to it) maintenance_mode_timestamp: type: string format: date-time description: Timestamp when allocator last entered or exited maintenance mode description: The health status of the allocator. ContainersEntryOptionsContainerConfig: type: object required: - env properties: env: type: array example: DB=localhost:4567 description: List of environment variables on the form KEY=value items: type: string host_config: description: Docker host config $ref: '#/components/schemas/ContainerConfigHostConfig' description: Container config. Roughly corresponds to Docker container config MoveAppSearchConfiguration: type: object required: - cluster_ids properties: cluster_ids: type: array description: Identifiers for the App Searches. items: type: string plan_override: description: Plan override to apply to the App Searches being moved. $ref: '#/components/schemas/TransientAppSearchPlanConfiguration' description: The configuration object for moving App Searches. 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. PendingState: type: object required: - value properties: value: type: boolean description: Whether a runner is pending blessings or not description: Pending state RunnerRolesInfo: type: object required: - roles properties: roles: type: array description: List of roles items: $ref: '#/components/schemas/RunnerRoleInfo' description: A list of runner roles. MoveApmClusterDetails: type: object required: - cluster_id properties: cluster_id: type: string description: Identifier for the Apm cluster. calculated_plan: description: If only validating the move, then the plan configuration that would be applied to the cluster. $ref: '#/components/schemas/TransientApmPlanConfiguration' errors: type: array description: A list of errors that occurred if the attempt to move the cluster failed. items: $ref: '#/components/schemas/BasicFailedReplyElement' description: Information about the APM Server that you want to move. 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. Metadata: type: object required: - created_time - modified_time - version properties: created_time: type: string format: date-time description: Creation time modified_time: type: string format: date-time description: Modification time version: type: string description: Version description: Metadata of an entity ContainersEntry: type: object required: - container_set_name - kind - name - options properties: name: type: string description: Name of the association container_set_name: type: string description: The container set name (id) kind: type: string description: The kind of container set, should be one of 'docker', 'elasticsearch', 'kibana', or 'apm' options: description: The container options $ref: '#/components/schemas/ContainersEntryOptions' description: Represents the association between a Role and a Container Set 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' MoveClustersCommandResponse: type: object required: - failures - moves properties: failures: description: Detailed information about the clusters that failed to move. $ref: '#/components/schemas/MoveClustersDetails' moves: description: Detailed information about the clusters being moved off the allocator. $ref: '#/components/schemas/MoveClustersDetails' description: Information about the move operations for the Elasticsearch clusters, multiple Kibana instances, and multiple APM Servers, prior to the move. 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. 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. 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. 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. 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. MoveClustersRequest: type: object properties: elasticsearch_clusters: type: array description: Optional list of Elasticsearch clusters to move off the allocator. items: $ref: '#/components/schemas/MoveElasticsearchClusterConfiguration' kibana_clusters: type: array description: Optional list of Kibana clusters to move off the allocator. items: $ref: '#/components/schemas/MoveKibanaClusterConfiguration' apm_clusters: type: array description: Optional list of Apm clusters to move off the allocator. items: $ref: '#/components/schemas/MoveApmClusterConfiguration' appsearch_clusters: type: array description: Optional list of App Search clusters to move off the allocator. items: $ref: '#/components/schemas/MoveAppSearchConfiguration' enterprise_search_clusters: type: array description: Optional list of Elastic Enterprise Search clusters to move off the allocator. items: $ref: '#/components/schemas/MoveEnterpriseSearchConfiguration' description: The request for moving Elasticsearch clusters off an allocator. AdminconsoleInfo: type: object required: - adminconsole_id properties: adminconsole_id: type: string description: Identifier for this adminconsole description: Information for the adminconsole. RoleAggregateCreateData: type: object required: - role properties: role: description: The role data $ref: '#/components/schemas/Role' blessings: description: The blessings data associated with the role $ref: '#/components/schemas/Blessings' description: Creation data for a role ModelVersionIndexSynchronizationResults: type: object required: - results properties: results: type: object description: The results of synchronizing indices organized by model version additionalProperties: $ref: '#/components/schemas/IndexSynchronizationResults' description: Results from synchronizing indices by model version RunnerOverview: type: object required: - runners properties: runners: type: array description: List of runners items: $ref: '#/components/schemas/RunnerInfo' description: Information about all of the runners. 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`. ContainersEntryOptionsAuth: type: object required: - auth - scheme properties: scheme: type: string example: digest description: Scheme identifier, usually "digest" auth: type: string description: Plain-text auth. For the "digest" scheme description: ZooKeeper Authentication information. 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. PortBinding: type: object required: - host_port properties: host_port: type: string description: Port as observed by the host. host_ip: type: string example: 0.0.0.0 description: IP to bind to on the host. I.e {@code 0.0.0.0} description: Value used to bind to a port on the host. AllocatorCapacityStorage: type: object required: - total properties: total: type: integer format: int64 description: Total storage in MiB capacity installed on this allocator description: The storage capacity of the allocator. ProxyOverview: type: object required: - proxies - proxies_count - settings properties: proxies_count: type: integer format: int32 description: Number of proxies settings: description: Settings $ref: '#/components/schemas/ProxiesSettings' proxies: type: array description: Proxies items: $ref: '#/components/schemas/ProxyInfo' description: Information about all of the proxies. ContainersEntryOptionsOverrides: type: object properties: container_config: description: Overrides for the container allocation. $ref: '#/components/schemas/ContainersEntryOptionsContainerConfig' description: Overrides for the container allocation. ProxiesFilter: type: object required: - key - value properties: key: type: string description: Key of the proxy metadata item to be matched value: type: string description: Value of the proxy metadata item to be matched description: Selects proxies by matching a proxy metadata item. MatchNoneQuery: type: object description: A query that doesn't match any documents. ProxiesHealth: type: object required: - allocations - expected_proxies_count - filtered_groups - observed_proxies_count - status properties: observed_proxies_count: type: integer format: int32 description: Total number of proxies expected_proxies_count: type: integer format: int32 description: Expected minimum number of proxies allocations: type: array description: Allocations for proxies items: $ref: '#/components/schemas/ProxiesAllocationsInfo' filtered_groups: type: array description: Filtered groups of proxies with associated status items: $ref: '#/components/schemas/ProxiesFilteredGroupHealth' status: type: string description: '"Health status for all proxies. One of "Green", "Yellow" or "Red"' Blessing: type: object required: - value properties: value: type: boolean description: Whether something is blessed or not description: Whether something is blessed or not 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. ProxiesSSOSettings: type: object required: - cookie_name - default_redirect_path - dont_log_requests - maintenance_bypass_cookie_name - max_age - sso_secret properties: max_age: type: integer format: int64 description: Maximum age of single-sign-on token in milliseconds sso_secret: type: string description: Secret string for single-sign-on cookie_name: type: string description: Name of the HTTP cookie used for single-sign-on dont_log_requests: type: boolean description: If true, don't log requests default_redirect_path: type: string description: Default path where users are redirected after a successful single-sign-on maintenance_bypass_cookie_name: type: string description: Name of the cookie that bypasses maintenance description: '> WARNING > This object is deprecated and scheduled to be removed in the next major version.' 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. Blessings: type: object required: - runner_ids_to_blessing properties: runner_ids_to_blessing: type: object description: A mapping of Runner Ids to whether or not they are blessed to run the associated role additionalProperties: $ref: '#/components/schemas/Blessing' description: Describes whether certain runners are blessed to run a Role. ProxiesHttpSettings: type: object required: - cookie_secret - dashboards_base_url - disconnected_cutoff - minimum_proxy_services - sso_settings - user_cookie_key properties: disconnected_cutoff: type: integer format: int64 description: Cutoff interval after disconnection in milliseconds minimum_proxy_services: type: integer format: int32 description: Minimum number of proxy instances sso_settings: description: Settings related to single-sign-on $ref: '#/components/schemas/ProxiesSSOSettings' dashboards_base_url: type: string description: Base URL for the dashboard cookie_secret: type: string description: Secret string for the HTTP cookie user_cookie_key: type: string description: User key for the HTTP cookie description: '> WARNING > This object is deprecated and scheduled to be removed in the next major version.' MetadataItemValue: type: object required: - value properties: value: type: string description: The metadata value description: The value of the metadata item, which is primarily used to add a single item when the key is provided in the URL. securitySchemes: apiKey: type: apiKey name: Authorization in: header basicAuth: type: http scheme: basic x-elastic: curl: auth: '-H "Authorization: ApiKey $ECE_API_KEY"'