Method: nodes.devices.list

  • Lists devices under a specific node or customer within the Spectrum Access System.

  • Uses a GET request to retrieve the list of devices, allowing filtering and pagination.

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

  • Provides details like serial number and display name for each device listed.

  • Returns a comprehensive list of devices based on the specified criteria in the request.

Lists devices under a node or customer.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the parent resource.

Query parameters

Parameters
pageSize

integer

The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].
pageToken

string

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

string

The filter expression. The filter should have one of the following formats: "sn=123454" or "displayName=MyDevice". sn corresponds to serial number of the device. The filter is case insensitive.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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