Path parameters

• deployment_id string Required

  Identifier for the Deployment

Query parameters

• hide boolean

  Whether or not to hide the deployment and its resources.Only applicable for Platform administrators.

• skip_snapshot boolean

  Whether or not to skip snapshots before shutting down the resources

  Default value is false.

Responses

• 200

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

  Hide response attributes Show response attributes object

  A response returned from the Deployment shutdown endpoint

  • id string Required

    The id of the deployment

  • name string Required

    The name of the deployment

  • orphaned object

    List of resources that have been shut down

    Hide orphaned attributes Show orphaned attributes object

    • elasticsearch array[object] Required

      List of orphaned Elasticsearch resources

      Hide elasticsearch attributes Show elasticsearch attributes object

      Details about an orphaned Elasticsearch resources.

      • id string Required

        The id of the orphaned resource

      • dependents array[object] Required

        List of orphaned dependent resources

        Hide dependents attributes Show dependents attributes object

        Details about an orphaned Elasticsearch-dependent resources.

        • id string Required

          The id of the orphaned resource

        • kind string Required

          The kind of resource

    • kibana array[string] Required

      List of orphaned Kibana resource ids

    • apm array[string] Required

      List of orphaned APM resource ids

    • appsearch array[string] Required

      List of orphaned AppSearch resource ids

    • enterprise_search array[string] Required

      List of orphaned Enterprise Search resource ids

    • integrations_server array[string] Required

      List of orphaned Integrations Server resource ids

• 400

  Parameter is restricted and can only be set by a Platform administrator. (code: deployments.restricted_parameter)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.restricted_parameter.

  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

  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

  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