Method: projects.deployments.uninstall
Stay organized with collections
Save and categorize content based on your preferences.
Uninstalls a test deployment from the user’s account. For more information, see Test your add-on.
HTTP request
POST https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*}:uninstall
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The full resource name of the deployment to install. Example: projects/my_project/deployments/my_deployment.
Authorization requires the following IAM permission on the specified resource name:
gsuiteaddons.deployments.execute
|
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\u003eUninstalls a specified test deployment from a user's account.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and returns an empty JSON object upon successful completion.\u003c/p\u003e\n"],["\u003cp\u003eUses the \u003ccode\u003ePOST\u003c/code\u003e method with the URL \u003ccode\u003ehttps://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*}:uninstall\u003c/code\u003e, where \u003ccode\u003e{name}\u003c/code\u003e represents the deployment's full resource name.\u003c/p\u003e\n"],["\u003cp\u003eNeeds the \u003ccode\u003egsuiteaddons.deployments.execute\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This document outlines how to uninstall a test deployment from a user's account via an HTTP POST request. The request is sent to a specific URL, incorporating a required path parameter, `name`, which identifies the deployment. The request body must be empty. Successful uninstallation results in an empty JSON response. Authorization requires the `gsuiteaddons.deployments.execute` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope. The provided URL uses gRPC Transcoding syntax.\n"],null,["# Method: projects.deployments.uninstall\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUninstalls a test deployment from the user's account. For more information, see [Test your add-on](https://developers.google.com/workspace/add-ons/guides/alternate-runtimes#test_your_add-on).\n\n### HTTP request\n\n`POST https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*}:uninstall`\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 install. 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.execute` |\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)."]]
