Method: projects.deployments.delete
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-22 UTC.
[null,null,["Last updated 2025-04-22 UTC."],[[["\u003cp\u003eThis document details how to delete a Google Workspace Add-on deployment using the \u003ccode\u003eDELETE\u003c/code\u003e HTTP request method.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the deployment's name as a path parameter and optionally an etag as a query parameter for concurrency control.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful deletion results in an empty JSON response body, indicating the deployment has been removed.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation necessitates the \u003ccode\u003ecloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003egsuiteaddons.deployments.delete\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty when sending the delete request.\u003c/p\u003e\n"]]],["This document details the process of deleting a deployment using an HTTP DELETE request. The request URL, employing gRPC Transcoding syntax, requires a `name` path parameter, specifying the deployment's full resource name. Optionally, the `etag` query parameter can be used for conditional deletion. The request body must be empty. Successful deletion returns an empty JSON object. This action requires the `gsuiteaddons.deployments.delete` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope.\n"],null,["# Method: projects.deployments.delete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDeletes the deployment with the given name.\n\n### HTTP request\n\n`DELETE https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The full resource name of the deployment to delete. Example: `projects/my_project/deployments/my_deployment`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `gsuiteaddons.deployments.delete` |\n\n### Query parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------|\n| `etag` | `string` The etag of the deployment to delete. If this is provided, it must match the server's etag. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
