Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> Deployment> Deleting All Deployments
View PDF

Deleting All Deployments

Function

This API is used to delete collection of Deployment.

URI

DELETE /apis/apps/v1/namespaces/{namespace}/deployments (for clusters of v1.9 and later)

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments (for clusters of v1.15 and earlier)

Table 1 describes the parameters of this API.

Table 1 Parameter description

Parameter

Mandatory

Description

namespace

Yes

Object name and auth scope, such as for teams and projects.

pretty

No

If 'true', then the output is pretty printed.

fieldSelector

No

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

No

If true, partially initialized resources are included in the response.

labelSelector

No

A selector to restrict the list of returned objects by their labels. Defaults to everything.

resourceVersion

No

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it is 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

No

Timeout for the list/watch call.

watch

No

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Request

Request parameters:

For the description about request parameters, see Table 2.

Example request:

  • Deleting only the Deployment (the ReplicaSet and pod are not deleted): 
    {
    "Kind": "DeleteOptions",
    "apiVersion": "v1",
    "propagationPolicy": "Orphan"
}
  • Deleting the pod, ReplicaSet and then the Deployment: 
    {
    "kind": "DeleteOptions",
    "apiVersion": "v1",
    "propagationPolicy": "Foreground"
}
  • Deleting the Deployment, ReplicaSet and then the pod: 
    {
    "kind": "DeleteOptions",
    "apiVersion": "v1",
    "propagationPolicy": "Background"
}

Response

Response parameters:

For the description about response parameters, see Table 2.

Example response:

{
    "kind": "DeploymentList",
    "apiVersion": "apps/v1beta1",
    "metadata": {
        "selfLink": "/apis/apps/v1beta1/namespaces/ns-12130306-s/deployments",
        "resourceVersion": "418745"
    },
    "items": null
}

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

Delete a Deployment resource object successfully.

For the description about error status codes, see Status Code.

Parent topic: Deployment