Skip to main content
POST
/
deployments
/
{deployment_id}
/
{resource_kind}
/
{ref_id}
/
instances
/
{instance_ids}
/
maintenance-mode
/
_start
Start maintenance mode
curl --request POST \
  --url https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start \
  --header 'Authorization: <api-key>'
{
  "warnings": [
    {
      "code": "<string>",
      "message": "<string>"
    },
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
deployment_id
string
required

(Required) Identifier for the Deployment.

Example:

"<string>"

​
resource_kind
string
required

(Required) The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).

Example:

"<string>"

​
ref_id
string
required

(Required) User-specified RefId for the Resource (or '_main' if there is only one).

Example:

"<string>"

​
instance_ids
string
required

(Required) A comma-separated list of instance identifiers.

Example:

"<string>,<string>"

Query Parameters

​
ignore_missing
string

If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error.

Example:

"false"

Response

The start maintenance command was issued successfully.

​
warnings
object[]
Example:
[
  { "code": "<string>", "message": "<string>" },
  { "code": "<string>", "message": "<string>" }
]
⌘I