Method: nodes.deployments.list

  • This document details the process for listing deployments within the Spectrum Access System (SAS), including how to structure the HTTP request and utilize path and query parameters.

  • The request requires specific path and query parameters to define the parent resource and refine the search for deployments, such as pagination and filtering.

  • Successful execution of the request will return a list of deployments within the specified parameters, contained within a ListDeploymentsResponse object.

  • Authorization for this operation necessitates the "https://www.googleapis.com/auth/sasportal" OAuth scope.

Lists deployments.

HTTP request

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