Start maintenance modeedit
Starts maintenance mode of instances belonging to a Deployment Resource.
Requestedit
POST /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
Comma-delimited list of instance identifiers of the Resource |
|
|
Y |
User-specified RefId for the Resource |
|
|
Y |
The kind of resource (one of elasticsearch, kibana or apm) |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error |
Responsesedit
-
202 -
(
DeploymentResourceCommandResponse) The stop maintenance command was issued successfully -
403 -
(
BasicFailedReply) The start maintenance mode command was prohibited for the given Resource. -
404 -
(
BasicFailedReply) The Resource specified by {ref_id} cannot be found -
422 -
(
BasicFailedReply) The command sent to a Resource found the Resource in an illegal state, the error message gives more details -
449 -
(
BasicFailedReply) elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start \
-H "Authorization: ApiKey $ECE_API_KEY"