Start maintenance mode

Base URL: https://api.elastic-cloud.com/api/v1

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/maintenance-mode/_start

No auth

Starts maintenance mode of instances belonging to a Deployment Resource.

Path parameters

deployment_id string required: Identifier for the Deployment.
resource_kind string required: The kind of resource (one of elasticsearch, kibana, apm, or integrations_server).
ref_id string required: User-specified RefId for the Resource (or '_main' if there is only one).
instance_ids string[] required: A comma-separated list of instance identifiers.

Query parameters

ignore_missing boolean · default: false: If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error.

Responses

The start maintenance command was issued successfully.

application/json

warnings object[]: List of warnings generated from validating command

The start maintenance mode command was prohibited for the given Resource. (code: deployments.instance_update_prohibited_error)

application/json

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)

application/json

A Resource that was previously stored no longer exists. (code: deployments.deployment_resource_no_longer_exists)

application/json

Base URL: https://api.elastic-cloud.com/api/v1

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "https://api.elastic-cloud.com/api/v1/deployments/${DEPLOYMENT_ID}/${RESOURCE_KIND}/${REF_ID}/instances/${INSTANCE_IDS}/maintenance-mode/_start"

Generated from the API spec

Response

{
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec