Method: nodes.nodes.deployments.list

AI-generated Key Takeaways

• This documentation outlines how to list deployments within the Spectrum Access System (SAS) using a GET request to a specific endpoint.

• The request requires specifying the parent node in the URL path and can optionally include query parameters for filtering, pagination, and page size.

• A successful response will return a list of deployments adhering to the specified criteria within a ListDeploymentsResponse object.

• Proper authorization with the 'https://www.googleapis.com/auth/sasportal' scope is necessary to access this functionality.

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization Scopes

Lists deployments.

HTTP request

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