Clusters - Kibana - Commands | Elastic Cloud Enterprise Reference [2.5]

» » »

« Clusters - Kibana - CRUD - Configuration Clusters - Kibana - Proxy »

Clusters - Kibana - Commands

Resynchronize clusters

DEPRECATED (Scheduled to be removed in the next major version): Asynchronously resynchronizes the search index for all Kibana instances.

Request

POST /api/v1/clusters/kibana/_resync

Query parameters

Name	Type	Required	Description
`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 https://{{hostname}}/api/v1/clusters/kibana/_resync \
-H "Authorization: ApiKey $ECE_API_KEY"

Search clusters

DEPRECATED (Scheduled to be removed in the next major version): Retrieves the information for all of the Kibana instances that match the specified query.

Request

POST /api/v1/clusters/kibana/_search

Request body

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

Responses

200: (KibanaClustersInfo) A list of Kibana 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 https://{{hostname}}/api/v1/clusters/kibana/_search \
-H "Authorization: ApiKey $ECE_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

DEPRECATED (Scheduled to be removed in the next major version): Restarts the Kibana instance. When you restart an active instance, the existing plan is used and a cluster_reboot is applied. A cluster_reboot issues a Kibana restart command, then waits for the command to complete. When you restart an inactive instance, the most recent successful plan is applied.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.

Query parameters

Name	Type	Required	Description
`cancel_pending`	`boolean`; default: `false`	N	When `true`, cancels the pending plans, then restarts the cluster.

Responses

202

(ClusterCommandResponse) The stop 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

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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/_restart \
-H "Authorization: ApiKey $ECE_API_KEY"

Resynchronize cluster

DEPRECATED (Scheduled to be removed in the next major version): Immediately resynchronizes the search index and cache for the selected Kibana instance.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana instance 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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/_resync \
-H "Authorization: ApiKey $ECE_API_KEY"

Shut down cluster

DEPRECATED (Scheduled to be removed in the next major version): Shuts down the active Kibana instance and removes all of the instance nodes. The instance definition is retained. WARNING: To avoid data loss, save the snapshot repository before you shut down the instance.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.

Query parameters

Name	Type	Required	Description
`hide`	`boolean`; default: `false`	N	Hides the clusters during shutdown. NOTE: By default, hidden clusters are not listed.

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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/_shutdown \
-H "Authorization: ApiKey $ECE_API_KEY"

Upgrade cluster

DEPRECATED (Scheduled to be removed in the next major version): Upgrades an active Kibana instance.

Request

POST /api/v1/clusters/kibana/{cluster_id}/_upgrade

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.

Query parameters

Name	Type	Required	Description
`validate_only`	`boolean`; default: `false`	N	When `true`, returns the update version without performing the upgrade

Responses

202

(ClusterUpgradeInfo) The upgrade 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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/_upgrade \
-H "Authorization: ApiKey $ECE_API_KEY"

Move instances (advanced)

DEPRECATED (Scheduled to be removed in the next major version): Moves one or more Kibana instances. The custom configuration settings are posted in the body.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.

Query parameters

Name	Type	Required	Description
`force_update`	`boolean`; default: `false`	N	When `true`, cancels and overwrites the pending plans, or treats the instance as an error.
`validate_only`	`boolean`; default: `false`	N	When `true`, validates the move request, then returns the calculated plan without applying the plan.

Request body

(TransientKibanaPlanConfiguration) (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) * 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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/_move \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "move_allocators" : [
         {
            "allocator_down" : true,
            "from" : "string",
            "to" : [
               "string"
            ]
         }
      ],
      "move_instances" : [
         {
            "from" : "string",
            "instance_down" : true,
            "to" : [
               "string"
            ]
         }
      ],
      "preferred_allocators" : [
         "string"
      ],
      "reallocate_instances" : true,
      "timeout" : 0
   },
   "strategy" : {
      "autodetect" : {},
      "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

DEPRECATED (Scheduled to be removed in the next major version): Starts all of the Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment 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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/_start \
-H "Authorization: ApiKey $ECE_API_KEY"

Stop all instances

DEPRECATED (Scheduled to be removed in the next major version): Stops all of the Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment 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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/_stop \
-H "Authorization: ApiKey $ECE_API_KEY"

Start maintenance mode all instances

DEPRECATED (Scheduled to be removed in the next major version): Starts maintenance mode on all of the Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment 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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/maintenance-mode/_start \
-H "Authorization: ApiKey $ECE_API_KEY"

Stop maintenance mode all instances

DEPRECATED (Scheduled to be removed in the next major version): Stops maintenance mode on all of the Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment 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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/maintenance-mode/_stop \
-H "Authorization: ApiKey $ECE_API_KEY"

Move instances

DEPRECATED (Scheduled to be removed in the next major version): Moves one or more Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.

Query parameters

Name	Type	Required	Description
`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.
`validate_only`	`boolean`; default: `false`	N	When `true`, validates the move request, then returns the calculated plan without applying the plan.

Request body

(TransientKibanaPlanConfiguration) 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

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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/{instance_ids}/_move \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "plan_configuration" : {
      "calm_wait_time" : 0,
      "cluster_reboot" : "string",
      "extended_maintenance" : true,
      "move_allocators" : [
         {
            "allocator_down" : true,
            "from" : "string",
            "to" : [
               "string"
            ]
         }
      ],
      "move_instances" : [
         {
            "from" : "string",
            "instance_down" : true,
            "to" : [
               "string"
            ]
         }
      ],
      "preferred_allocators" : [
         "string"
      ],
      "reallocate_instances" : true,
      "timeout" : 0
   },
   "strategy" : {
      "autodetect" : {},
      "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

DEPRECATED (Scheduled to be removed in the next major version): Starts the specified Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.

Query parameters

Name	Type	Required	Description
`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

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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/{instance_ids}/_start \
-H "Authorization: ApiKey $ECE_API_KEY"

Stop instances

DEPRECATED (Scheduled to be removed in the next major version): Stops the specified Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.

Query parameters

Name	Type	Required	Description
`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

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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/{instance_ids}/_stop \
-H "Authorization: ApiKey $ECE_API_KEY"

Start maintenance mode

DEPRECATED (Scheduled to be removed in the next major version): Starts maintenance mode on the specified Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.

Query parameters

Name	Type	Required	Description
`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

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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/{instance_ids}/maintenance-mode/_start \
-H "Authorization: ApiKey $ECE_API_KEY"

Stop maintenance mode

DEPRECATED (Scheduled to be removed in the next major version): Stops maintenance mode on the specified Kibana instances.

Request

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

Path parameters

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.

Query parameters

Name	Type	Required	Description
`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

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 https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/{instance_ids}/maintenance-mode/_stop \
-H "Authorization: ApiKey $ECE_API_KEY"

« Clusters - Kibana - CRUD - Configuration Clusters - Kibana - Proxy »