Stop maintenance mode

Auth

Stops maintenance mode of instances belonging to a Resource.

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 string[] required

A comma-separated list of instance identifiers.

Query parameters

ignore_missing boolean · default: false

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

Responses

The stop maintenance mode command was issued successfully.

application/json
warnings object[]

List of warnings generated from validating command

code string required

A structured code representing the error type that occurred

message string

A human readable message describing the warning that occurred

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

application/json
errors object[] required

A list of errors that occurred in the failing request

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

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

  • 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)
application/json
errors object[] required

A list of errors that occurred in the failing request

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

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

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

application/json
errors object[] required

A list of errors that occurred in the failing request

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

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response