Deleting a Deployment

Function

This API is used to delete a Deployment resource object.

URI

DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name}

DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}

Table 1 describes the parameters of this API.

**Table 1** Parameter description
Parameters	Mandatory	Description
name	Yes	name of the Deployment
namespace	Yes	object name and auth scope, such as for teams and projects
pretty	No	If 'true', then the output is pretty printed.
gracePeriodSeconds	No	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
orphanDependents	No	Deprecated: please use the PropagationPolicy. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
propagationPolicy	No	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy.

Request

Request parameters:

For the description about request parameters, see Table 2

Example request:

{
    "Kind": "DeleteOptions",
    "apiVersion": "v1",
    "propagationPolicy": "Background"
}

Response

Response parameters:

For the description about response parameters, see Table 4.

Example response:

{
    "kind": "Status",
    "apiVersion": "v1",
    "metadata": {},
    "status": "Success",
    "details": {
        "name": "deploy-12130306",
        "group": "extensions",
        "kind": "deployments",
        "uid": "27072a31-dfb3-11e7-9c19-fa163e2d897b"
    },
    "code": 200
}

Status Code

Table 2 describes the status code of this API.

**Table 2** Status code
Status Code	Description
200	Delete a Deployments resource object successfully.

For the description about status codes, see Status Codes.

Parent topic: Deployment

Cloud Container Engine

API Reference