Method: nodes.nodes.deployments.list
Stay organized with collections
Save and categorize content based on your preferences.
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
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.
[null,null,["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eThis documentation outlines how to list deployments within the Spectrum Access System (SAS) using a GET request to a specific endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the parent node in the URL path and can optionally include query parameters for filtering, pagination, and page size.\u003c/p\u003e\n"],["\u003cp\u003eA successful response will return a list of deployments adhering to the specified criteria within a ListDeploymentsResponse object.\u003c/p\u003e\n"],["\u003cp\u003eProper authorization with the 'https://www.googleapis.com/auth/sasportal' scope is necessary to access this functionality.\u003c/p\u003e\n"]]],["This document outlines the process for listing deployments via an HTTP GET request to `https://sasportal.googleapis.com/v1alpha1/{parent}/deployments`. The `parent` path parameter is required, specifying a resource path. Optional query parameters include `pageSize`, `pageToken` for pagination, and `filter` for filtering by direct children. The request body must be empty. A successful response will return a `ListDeploymentsResponse`. This request requires the `https://www.googleapis.com/auth/sasportal` OAuth scope.\n"],null,["# Method: nodes.nodes.deployments.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 [deployments](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*/nodes/*}/deployments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of deployments to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to [deployments.list](/spectrum-access-system/reference/rest/v1alpha1/nodes.deployments/list#spectrum.sas.portal.v1alpha1.DeviceManager.ListDeployments) that indicates where this listing should continue from. |\n| `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. |\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 [ListDeploymentsResponse](/spectrum-access-system/reference/rest/v1alpha1/ListDeploymentsResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]