Clusters - Elasticsearch - Commands

Resynchronize clusters

Asynchronously resynchronizes the search index for all Elasticsearch clusters.

Request

POST /api/v1/clusters/elasticsearch/_resync

Query parameters

NameTypeRequiredDescription

skip_matching_version

boolean; default: true

N

When true, skips the document indexing when the version matches the in-memory copy.

Responses

202
(ModelVersionIndexSynchronizationResults) The ids of documents, organized by model version, that will be synchronized.
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/_resync \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Search clusters

Retrieves the information for all of the Elasticsearch clusters that match the specified query.

Request

POST /api/v1/clusters/elasticsearch/_search

Request body

(SearchRequest) (Optional) The search request to execute. NOTE: When not specified, all of the clusters are matched.

Responses

200
(ElasticsearchClustersInfo) A list of Elasticsearch clusters that matched the given search query.
400
(BasicFailedReply) The search request failed.

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/_search \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "from" : 0,
   "query" : {
      "bool" : {
         "filter" : [
            null
         ],
         "minimum_should_match" : 0,
         "must" : [
            null
         ],
         "must_not" : [
            null
         ],
         "should" : [
            null
         ]
      },
      "exists" : {
         "field" : "string"
      },
      "match" : {
         "some_property" : {
            "analyzer" : "string",
            "minimum_should_match" : 0,
            "operator" : "string",
            "query" : "string"
         }
      },
      "match_all" : {},
      "match_none" : {},
      "nested" : {
         "path" : "string",
         "query" : null,
         "score_mode" : "string"
      },
      "prefix" : {
         "some_property" : {
            "boost" : 0.1,
            "value" : "string"
         }
      },
      "query_string" : {
         "allow_leading_wildcard" : true,
         "analyzer" : "string",
         "default_field" : "string",
         "default_operator" : "string",
         "query" : "string"
      },
      "range" : {
         "some_property" : {
            "boost" : 0.1,
            "format" : "string",
            "gt" : {},
            "gte" : {},
            "lt" : {},
            "lte" : {},
            "time_zone" : "string"
         }
      },
      "term" : {
         "some_property" : {
            "value" : {}
         }
      }
   },
   "size" : 0,
   "sort" : [
      {}
   ]
}
'

Restart cluster

Restarts the Elasticsearch cluster. When you restart an active cluster, the existing plan is used and a cluster_reboot is applied. A cluster_reboot issues an Elasticsearch restart command, then waits for the command to complete. When you restart an inactive cluster, the most recent successful plan is applied.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/_restart

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

NameTypeRequiredDescription

cancel_pending

boolean; default: false

N

When true, cancels the pending plans, then restarts the cluster.

group_attribute

string; default: "__zone__"

N

Specifies the properties that divide the instances into groups. To restart all of the instances, use '__all__'. To restart the instances by logical zone, use '__zone__'. To restart one instance at a time, use '__name__', or use a comma-separated list of instance attributes.

restore_snapshot

boolean; default: true

N

When true and restoring from a shutdown, restores the cluster from the last available snapshot.

shard_init_wait_time

integer; default: 600

N

The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)

skip_snapshot

boolean; default: true

N

When true, does not capture a snapshot before restarting the cluster.

Responses

202
(ClusterCommandResponse) The stop command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
400

(BasicFailedReply) The cluster specified by {cluster_id} is unable to restart. (code: clusters.restart.failed)

Headers

x-cloud-error-codes (string; allowed values: [clusters.restart.failed])
The error codes associated with the response
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
The error codes associated with the response
412

(BasicFailedReply) The command sent to a cluster found the cluster in an illegal state, the error message gives more details. (code: clusters.cluster_plan_state_error)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_plan_state_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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_restart \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Resynchronize cluster

Immediately resynchronizes the search index and cache for the selected Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/_resync

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Responses

200
(EmptyResponse) The cluster resync operation executed successfully
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) The cluster resync operation failed for cluster {cluster_id}. (code: clusters.resync_failed)

Headers

x-cloud-error-codes (string; allowed values: [clusters.resync_failed])
The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_resync \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Shut down cluster

Shuts down the active Elasticsearch cluster and removes all of the cluster nodes. The cluster plan is retained. WARNING: To avoid data loss, save the data outside of the cluster before you shut the cluster down.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/_shutdown

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

NameTypeRequiredDescription

hide

boolean; default: false

N

Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed.

skip_snapshot

boolean; default: false

N

When true, skips the snapshot when the cluster is shut down.

Responses

202
(ClusterCommandResponse) The shutdown command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_shutdown \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Take snapshot

To create a snapshot of the specified Elasticsearch cluster, uses the configured snapshot repository.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/_snapshot

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Request body

(ClusterSnapshotRequest) Overrides default settings for the snapshot

Responses

202
(ClusterSnapshotResponse) The create command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
401

(BasicFailedReply) The supplied credentials for the snapshot repository are invalid. (code: clusters.snapshot.invalid_credentials)

Headers

x-cloud-error-codes (string; allowed values: [clusters.snapshot.invalid_credentials])
The error codes associated with the response
404

(BasicFailedReply) * The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found) * The snapshot repository was not found. (code: clusters.snapshot.repository_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found, clusters.snapshot.repository_not_found])
The error codes associated with the response
409

(BasicFailedReply) The cluster name specified is already in use. (code: clusters.snapshot.name_conflict)

Headers

x-cloud-error-codes (string; allowed values: [clusters.snapshot.name_conflict])
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) * The snapshot request failed. (code: clusters.snapshot.failed) * The snapshot request failed. (code: clusters.snapshot.repository_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.snapshot.failed, clusters.snapshot.repository_not_found])
The error codes associated with the response

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_snapshot \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "name" : "string",
   "password" : "string",
   "repository_name" : "string",
   "username" : "string"
}
'

Move instances (advanced)

Moves one or more instances in the Elasticsearch cluster. The custom configuration settings are posted in the body.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/_move

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parameters

NameTypeRequiredDescription

force_update

boolean; default: false

N

When true, cancels and overwrites the pending plans, or treats the instance as an error.

instances_down

boolean; default: false

N

When true, the instances specified by instance_ids permanently shut down for data migration logic.

move_only

boolean; default: false

N

When true, moves the instances and ignores the changes for the cluster state.

validate_only

boolean; default: false

N

When true, validates the move request, then returns the calculated plan without applying the plan.

Request body

(TransientElasticsearchPlanConfiguration) (required) Overrides defaults for the move, including setting the configuration of instances specified in the path

Responses

202
(ClusterCommandResponse) The move command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
400

(BasicFailedReply) * 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 (string; allowed values: [clusters.cluster_invalid_plan, clusters.plan_feature_not_implemented])
The error codes associated with the response
403

(BasicFailedReply) The move command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/_move \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "cluster_settings_json" : {},
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "max_snapshot_age" : 0,
      "max_snapshot_attempts" : 0,
      "move_allocators" : [
         {
            "allocator_down" : true,
            "from" : "string",
            "to" : [
               "string"
            ]
         }
      ],
      "move_instances" : [
         {
            "from" : "string",
            "instance_down" : true,
            "to" : [
               "string"
            ]
         }
      ],
      "move_only" : true,
      "override_failsafe" : true,
      "preferred_allocators" : [
         "string"
      ],
      "reallocate_instances" : true,
      "skip_data_migration" : true,
      "skip_post_upgrade_steps" : true,
      "skip_snapshot" : true,
      "skip_snapshot_post_major_upgrade" : true,
      "skip_upgrade_checker" : true,
      "timeout" : 0
   },
   "restore_snapshot" : {
      "repository_config" : {
         "raw_settings" : {}
      },
      "repository_name" : "string",
      "restore_payload" : {
         "indices" : [
            "string"
         ],
         "raw_settings" : {}
      },
      "snapshot_name" : "string",
      "source_cluster_id" : "string",
      "strategy" : "string"
   },
   "strategy" : {
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}
'

Start all instances

Starts all of the instances in the Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/_start

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Responses

202
(ClusterCommandResponse) The start command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403

(BasicFailedReply) The start command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/_start \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Stop all instances

Stops all of the instances in the Elasticsearch cluster..

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/_stop

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Responses

202
(ClusterCommandResponse) The stop command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403

(BasicFailedReply) The stop command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/_stop \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Start maintenance mode all instances

Starts maintenance mode on all of the instances in the Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_start

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Responses

202
(ClusterCommandResponse) The start maintenance mode command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403

(BasicFailedReply) The start maintenance mode command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_start \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Stop maintenance mode all instances

Stops maintenance mode on all of the instances in the Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_stop

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

Responses

202
(ClusterCommandResponse) The stop maintenance mode command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403

(BasicFailedReply) The stop maintenance mode command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/maintenance-mode/_stop \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Move instances

Moves one or more instances in the Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_move

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

instance_ids

array[string]

Y

A comma-separated list of instance identifiers.

Query parameters

NameTypeRequiredDescription

force_update

boolean; default: false

N

When true, cancels and overwrites the pending plans, or treats the instance as an error.

ignore_missing

boolean; default: false

N

When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

instances_down

boolean; default: false

N

When true, the instances specified by instance_ids permanently shut down for data migration logic.

move_only

boolean; default: false

N

When true, moves the specified instances and ignores the changes for the cluster state.

validate_only

boolean; default: false

N

When true, validates the move request, then returns the calculated plan without applying the plan.

Request body

(TransientElasticsearchPlanConfiguration) Overrides defaults for the move, including setting the configuration of instances specified in the path

Responses

202
(ClusterCommandResponse) The move command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
400

(BasicFailedReply) * 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 (string; allowed values: [clusters.cluster_invalid_plan, clusters.plan_feature_not_implemented])
The error codes associated with the response
403

(BasicFailedReply) The move command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) * The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found) * One or more of the instances specified at {instance_ids} could not be found. (code: clusters.instances_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found, clusters.instances_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_move \
-H "Authorization: ApiKey $CLOUD_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "cluster_settings_json" : {},
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "max_snapshot_age" : 0,
      "max_snapshot_attempts" : 0,
      "move_allocators" : [
         {
            "allocator_down" : true,
            "from" : "string",
            "to" : [
               "string"
            ]
         }
      ],
      "move_instances" : [
         {
            "from" : "string",
            "instance_down" : true,
            "to" : [
               "string"
            ]
         }
      ],
      "move_only" : true,
      "override_failsafe" : true,
      "preferred_allocators" : [
         "string"
      ],
      "reallocate_instances" : true,
      "skip_data_migration" : true,
      "skip_post_upgrade_steps" : true,
      "skip_snapshot" : true,
      "skip_snapshot_post_major_upgrade" : true,
      "skip_upgrade_checker" : true,
      "timeout" : 0
   },
   "restore_snapshot" : {
      "repository_config" : {
         "raw_settings" : {}
      },
      "repository_name" : "string",
      "restore_payload" : {
         "indices" : [
            "string"
         ],
         "raw_settings" : {}
      },
      "snapshot_name" : "string",
      "source_cluster_id" : "string",
      "strategy" : "string"
   },
   "strategy" : {
      "grow_and_shrink" : {},
      "rolling" : {
         "allow_inline_resize" : true,
         "group_by" : "string",
         "shard_init_wait_time" : 0,
         "skip_synced_flush" : true
      },
      "rolling_grow_and_shrink" : {}
   }
}
'

Start instances

Starts the instances in the Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_start

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

instance_ids

array[string]

Y

A comma-separated list of instance identifiers.

Query parameters

NameTypeRequiredDescription

ignore_missing

boolean; default: false

N

When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

Responses

202
(ClusterCommandResponse) The start command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403

(BasicFailedReply) The start command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) * The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found) * One or more of the instances specified at {instance_ids} could not be found. (code: clusters.instances_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found, clusters.instances_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_start \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Stop instances

Stops the instances in the Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_stop

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

instance_ids

array[string]

Y

A comma-separated list of instance identifiers.

Query parameters

NameTypeRequiredDescription

ignore_missing

boolean; default: false

N

When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

Responses

202
(ClusterCommandResponse) The stop command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403

(BasicFailedReply) The stop command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) * The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found) * One or more of the instances specified at {instance_ids} could not be found. (code: clusters.instances_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found, clusters.instances_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_stop \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Start maintenance mode

Starts maintenance mode on the specified instances in the Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/maintenance-mode/_start

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

instance_ids

array[string]

Y

A comma-separated list of instance identifiers.

Query parameters

NameTypeRequiredDescription

ignore_missing

boolean; default: false

N

When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

Responses

202
(ClusterCommandResponse) The start maintenance mode command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403

(BasicFailedReply) The start maintenance mode command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) * The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found) * One or more of the instances specified at {instance_ids} could not be found. (code: clusters.instances_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found, clusters.instances_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/maintenance-mode/_start \
-H "Authorization: ApiKey $CLOUD_API_KEY"

Stop maintenance mode

Stops maintenance mode on the specified instances in the Elasticsearch cluster.

Request

POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/maintenance-mode/_stop

Path parameters

NameTypeRequiredDescription

cluster_id

string

Y

The Elasticsearch cluster identifier.

instance_ids

array[string]

Y

A comma-separated list of instance identifiers.

Query parameters

NameTypeRequiredDescription

ignore_missing

boolean; default: false

N

When true and the instance does not exist, proceeds to the next instance, or treats the instance as an error.

Responses

202
(ClusterCommandResponse) The stop maintenance mode command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
403

(BasicFailedReply) The stop maintenance mode command was prohibited for the given cluster. (code: clusters.command_prohibited)

Headers

x-cloud-error-codes (string; allowed values: [clusters.command_prohibited])
The error codes associated with the response
404

(BasicFailedReply) * The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found) * One or more of the instances specified at {instance_ids} could not be found. (code: clusters.instances_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found, clusters.instances_not_found])
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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/maintenance-mode/_stop \
-H "Authorization: ApiKey $CLOUD_API_KEY"