It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Start maintenance mode (all instances)edit
Starts maintenance mode of all instances belonging to a Deployment Resource.
Requestedit
POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource. |
|
|
Y |
The kind of resource (one of elasticsearch, kibana or apm). |
Responsesedit
-
202
-
(
DeploymentResourceCommandResponse
) The start maintenance command was issued successfully. -
403
-
(
BasicFailedReply
) The start maintenance mode command was prohibited for the given Resource. (code:deployments.instance_update_prohibited_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.instance_update_prohibited_error
]) - The error codes associated with the response
-
-
404
-
(
BasicFailedReply
) * The Deployment specified by {deployment_id} cannot be found. (code:deployments.deployment_not_found
) * The Resource specified by {ref_id} cannot be found. (code:deployments.deployment_resource_not_found
) * One or more instances of the given resource type are missing. (code:deployments.instances_missing_on_update_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
,deployments.deployment_resource_not_found
,deployments.instances_missing_on_update_error
]) - The error codes associated with the response
-
-
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
-
500
-
(
BasicFailedReply
) A Resource that was previously stored no longer exists. (code:deployments.deployment_resource_no_longer_exists
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_resource_no_longer_exists
]) - The error codes associated with the response
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/maintenance-mode/_start \ -H "Authorization: ApiKey $ECE_API_KEY"