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 array[string] Required

  A comma-separated list of instance identifiers.

Query parameters

• ignore_missing boolean

  If true and the instance does not exist then quietly proceed to the next instance, otherwise treated as an error.

  Default value is false.

Responses

• 202 application/json

  The stop command was issued successfully.

  Hide response attribute Show response attribute object

  • warnings array[object]

    List of warnings generated from validating command

    Hide warnings attributes Show warnings attributes object

    • code string Required

      A structured code representing the error type that occurred

    • message string

      A human readable message describing the warning that occurred

• 403 application/json

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

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.instance_update_prohibited_error.

  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

• 404 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)
  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, or deployments.instances_missing_on_update_error.

  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

• 500 application/json

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

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.deployment_resource_no_longer_exists.

  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