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

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

Upgrades a running cluster.

Path parameters

  • deployment_id string Required

    Identifier for the Deployment.

  • stateless_resource_kind string Required

    The kind of stateless resource

    Values are kibana, apm, appsearch, enterprise_search, or integrations_server.

  • ref_id string Required

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

Query parameters

  • validate_only boolean

    When true, returns the update version without performing the upgrade

    Default value is false.

Responses

  • 202

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

    Hide response attributes Show response attributes object
  • 404
    • 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)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are deployments.deployment_not_found or deployments.deployment_resource_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
POST /deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_upgrade 
curl \
 -X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{stateless_resource_kind}/{ref_id}/_upgrade
Response examples (202) 
{
  "resource_id": "string",
  "stack_version": "string"
}
Response examples (404) 
# Headers
x-cloud-error-codes: deployments.deployment_not_found

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