Method: customers.devices.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/devices
The URL uses gRPC Transcoding
syntax.
Path parameters
Parameters |
parent
|
string
Required. The name of the parent resource.
|
Query parameters
Parameters |
pageSize
|
number
The maximum number of devices to return in the response.
|
pageToken
|
string
A pagination token returned from a previous call to devices.list that indicates where this listing should continue from.
|
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/userinfo.email
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eLists devices under a node or customer.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to retrieve device information.\u003c/p\u003e\n"],["\u003cp\u003eRequires specifying the parent resource (node or customer) in the path.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details the process for listing devices using a `GET` request to the specified URL: `https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/devices`. The `parent` path parameter is required. Optional query parameters include `pageSize` to limit results and `pageToken` for pagination. The request body must be empty. A successful response returns a `ListDevicesResponse` instance. This operation requires `https://www.googleapis.com/auth/userinfo.email` authorization scope.\n"],null,["# Method: customers.devices.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nLists [devices](/spectrum-access-system/reference/rest/customers.devices#Device) under a [node](/spectrum-access-system/reference/rest/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/customers#Customer).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*}/devices`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------|\n| `parent` | `string` Required. The name of the parent resource. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `number` The maximum number of devices to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to devices.list that indicates where this listing should continue from. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListDevicesResponse](/spectrum-access-system/reference/rest/ListDevicesResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/userinfo.email`"]]