Method: projects.deployments.list

  • Lists all deployments within a specified Google Workspace Add-ons project.

  • Allows for pagination to retrieve large sets of deployments.

  • Requires gsuiteaddons.deployments.list IAM permission and https://www.googleapis.com/auth/cloud-platform OAuth scope for authorization.

  • Returns a list of deployments along with a token for accessing subsequent pages, if available.

Lists all deployments in a particular project.

HTTP request

GET https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

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

  • gsuiteaddons.deployments.list

Query parameters

Parameters
pageSize

integer

The maximum number of deployments to return. The service might return fewer than this value. If unspecified, at most 1,000 deployments are returned. The maximum possible value is 1,000; values above 1,000 are changed to 1,000.
pageToken

string

A page token, received from a previous deployments.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to deployments.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message to list deployments.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "deployments": [
    {
      object (Deployment)
    }
  ],
  "nextPageToken": string
}
Fields
deployments[]

object (Deployment)

The list of deployments for the given project.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authorization guide.