Method: customers.deployments.list

  • Lists available deployments, providing details about their configuration and status within the system.

  • Users can filter deployments, specify the maximum number of results returned, and utilize pagination for navigating larger datasets.

  • The API endpoint employs gRPC Transcoding and requires authorization with the https://www.googleapis.com/auth/sasportal scope for access.

  • Both path and query parameters are used to define the request, allowing for flexible retrieval of deployment information.

Lists deployments.

HTTP request

GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/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