Method: projects.locations.deployments.delete

Deletes a Deployment.

HTTP request

DELETE https://config.googleapis.com/v1/{name=projects/*/locations/*/deployments/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the Deployment in the format: 'projects/{projectId}/locations/{location}/deployments/{deployment}'. It takes the form projects/{project}/locations/{location}/deployments/{deployment}.

Authorization requires the following IAM permission on the specified resource name:

  • config.deployments.delete

Query parameters

Parameters
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
force

boolean

Optional. If set to true, any revisions for this deployment will also be deleted. (Otherwise, the request will only work if the deployment has no revisions.)
deletePolicy

enum (DeletePolicy)

Optional. Policy on how resources actuated by the deployment should be deleted. If unspecified, the default behavior is to delete the underlying resources.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • config.googleapis.com/config.deployments.delete

For more information, see the IAM documentation.

DeletePolicy

Policy on how resources actuated by the deployment should be deleted.

Enums
DELETE_POLICY_UNSPECIFIED Unspecified policy, resources will be deleted.
DELETE Deletes resources actuated by the deployment.
ABANDON Abandons resources and only deletes the deployment and its metadata.