Path parameters

• deployment_id string Required

  Identifier for the Deployment

• resource_kind string Required

  The kind of resource

  Values are elasticsearch, 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

• restore_snapshot boolean

  Whether or not to restore a snapshot for those resources that allow it.

  Default value is false.

Responses

• 200 application/json

  Standard Deployment Resource Crud Response

  Hide response attributes Show response attributes object

  • id string Required

    The id of the deployment

  • kind string Required

    The kind of the stateless resource

  • ref_id string Required

    The reference id of the resource

• 400 application/json
  • The Resource does not have a pending plan. (code: deployments.resource_does_not_have_a_pending_plan)
  • The resource is not shut down. (code: deployments.resource_not_shutdown)
  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Values are deployments.resource_does_not_have_a_pending_plan or deployments.resource_not_shutdown.

  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)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.deployment_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