Method: customers.nodes.nodes.list

  • Lists available nodes within the Spectrum Access System, allowing retrieval of node information.

  • Requires authorization with the https://www.googleapis.com/auth/sasportal scope for access.

  • Uses a GET request with path and query parameters to specify the parent node, filtering, and pagination.

  • Returns a ListNodesResponse object containing the requested node data upon successful execution.

  • Accepts an empty request body, meaning no additional data needs to be sent with the request.

Lists nodes.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

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

string

A pagination token returned from a previous call to nodes.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 nodes are filtered.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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