Path parameters

• deployment_id string Required

  Identifier for the Deployment

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

  The request was valid and the resources of the deployment were restored.

  Hide response attribute Show response attribute object

  • id string Required

    The id of the deployment

• 400 application/json

  There are Elasticsearch resources in the deployment which are not shut down.

  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

• 401 application/json

  You are not authorized to perform this action.

  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