Method: projects.deployments.delete

  • This document details how to delete a Google Workspace Add-on deployment using the DELETE HTTP request method.

  • The request requires specifying the deployment's name as a path parameter and optionally an etag as a query parameter for concurrency control.

  • Successful deletion results in an empty JSON response body, indicating the deployment has been removed.

  • Authorization for this operation necessitates the cloud-platform OAuth scope and the gsuiteaddons.deployments.delete IAM permission.

  • The request body should be empty when sending the delete request.

Deletes the deployment with the given name.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The full resource name of the deployment to delete.

Example: projects/my_project/deployments/my_deployment.

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

  • gsuiteaddons.deployments.delete

Query parameters

Parameters
etag

string

The etag of the deployment to delete. If this is provided, it must match the server's etag.

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authorization guide.