Start all instances

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start

Starts all instances belonging to a Deployment 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).

Responses

202

The start 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

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
- 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

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

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start

curl \
 -X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/_start

Response examples (202)

{
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Response examples (403)

# Headers
x-cloud-error-codes: deployments.instance_update_prohibited_error

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

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_not_found

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

Response examples (500)

# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists

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