Delete Deployment

DELETE /deployments/{deployment_id}

Auth

Deletes a Deployment and all its resources.

Path parameters

deployment_id string required: Identifier for the Deployment

Responses

The request was valid and the deployment was deleted.

application/json

id string required: The id of the deployment
name string required: The name of the deployment
orphaned object: Details about orphaned resources.

The Deployment resources have not been shutdown yet.

application/json

You are not authorized to perform this action.

application/json

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X DELETE "${API_URL}/deployments/${DEPLOYMENT_ID}" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "id": "string",
  "name": "string",
  "orphaned": {
    "elasticsearch": [
      {
        "id": "string",
        "dependents": [
          {
            "id": "string",
            "kind": "string"
          }
        ]
      }
    ],
    "kibana": [
      "string"
    ],
    "apm": [
      "string"
    ],
    "appsearch": [
      "string"
    ],
    "enterprise_search": [
      "string"
    ],
    "integrations_server": [
      "string"
    ]
  }
}

Generated from the API spec

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

Generated from the API spec

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

Generated from the API spec

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

Generated from the API spec

Path parameters

Responses

Response headers