Method: projects.deployments.get

  • Retrieves a specific Google Workspace Add-on deployment using its resource name.

  • Requires the cloud-platform OAuth scope for authorization and the gsuiteaddons.deployments.get IAM permission on the deployment.

  • The request should be a GET request to the specified URL with the deployment name as a path parameter and an empty request body.

  • A successful response returns a Deployment object containing information about the requested deployment.

Gets the deployment with the specified name.

HTTP request

GET 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 get.

Example: projects/my_project/deployments/my_deployment.

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

  • gsuiteaddons.deployments.get

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authorization guide.