Method: customers.nodes.deployments.list

  • This page details how to list deployments using the ListDeployments method, including specifics on the HTTP request structure, path & query parameters.

  • The API request requires a parent resource name as a path parameter and allows filtering & pagination through query parameters.

  • An empty request body is necessary, and a successful response returns a ListDeploymentsResponse object containing the deployment data.

  • To use this API, you need authorization with the https://www.googleapis.com/auth/sasportal OAuth scope.

Lists deployments.

HTTP request

GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*/nodes/*}/deployments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name, for example, "nodes/1", customer/1/nodes/2.

Query parameters

Parameters
pageSize

integer

The maximum number of deployments to return in the response.
pageToken

string

A pagination token returned from a previous call to deployments.list that indicates where this listing should continue from.
filter

string

The filter expression. The filter should have the following format: "DIRECT_CHILDREN" or format: "direct_children". The filter is case insensitive. If empty, then no deployments are filtered.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/sasportal