Method: projects.deployments.getInstallStatus
Stay organized with collections
Save and categorize content based on your preferences.
Gets the install status of a test deployment.
HTTP request
GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*/installStatus}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The full resource name of the deployment. Example: projects/my_project/deployments/my_deployment/installStatus.
Authorization requires the following IAM permission on the specified resource name:
gsuiteaddons.deployments.installStatus
|
Request body
The request body must be empty.
Response body
Install status of a test deployment.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"name": string,
"installed": boolean
} |
| Fields |
name |
string
The canonical full resource name of the deployment install status. Example: projects/123/deployments/my_deployment/installStatus.
|
installed |
boolean
True if the deployment is installed for the user.
|
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\u003eRetrieves the installation status of a specific Google Workspace Add-on deployment.\u003c/p\u003e\n"],["\u003cp\u003eRequires the deployment's full resource name as a path parameter and an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response indicating whether the deployment is installed for the user along with the deployment's full resource name.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e scope for access.\u003c/p\u003e\n"]]],["This document details retrieving the installation status of a test deployment. A `GET` request to a specific URL using gRPC Transcoding syntax is made, including a `name` path parameter identifying the deployment. The request body is empty. The response contains a JSON object with the deployment's resource `name` and a boolean `installed` status. Authorization requires an IAM permission (`gsuiteaddons.deployments.installStatus`) and the OAuth scope (`https://www.googleapis.com/auth/cloud-platform`).\n"],null,["# Method: projects.deployments.getInstallStatus\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 - [JSON representation](#body.InstallStatus.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets the install status of a test deployment.\n\n### HTTP request\n\n`GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/deployments/*/installStatus}`\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. Example: `projects/my_project/deployments/my_deployment/installStatus`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `gsuiteaddons.deployments.installStatus` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nInstall status of a test deployment.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------|\n| ``` { \"name\": string, \"installed\": boolean } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The canonical full resource name of the deployment install status. Example: `projects/123/deployments/my_deployment/installStatus`. |\n| `installed` | `boolean` True if the deployment is installed for the user. |\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)."]]
