Upgrade Kibana, APM, Integrations Server, AppSearch, Enterprise Search inside Deployment

edit

Upgrade Kibana, APM, Integrations Server, AppSearch, Enterprise Search inside Deployment

edit

Upgrades a running cluster.

Request

edit

POST /api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_upgrade

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).
`stateless_resource_kind`	`string`; allowed values: [`kibana`, `apm`, `appsearch`, `enterprise_search`, `integrations_server`]	Y	The kind of stateless resource

Query parameters

edit

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

Responses

edit

202

(DeploymentResourceUpgradeResponse)

The upgrade command was issued successfully. Use the "GET" command on the /{deployment_id} resource to monitor progress

404

(BasicFailedReply)

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)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_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

Request example

edit

curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_upgrade \
-H "Authorization: ApiKey $ECE_API_KEY"

« Shutdown Deployment Stateless Resource Deployment - Diagnostics »