Method: customers.nodes.deployments.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*/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.
[[["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\u003eThis page details how to list deployments using the \u003ccode\u003eListDeployments\u003c/code\u003e method, including specifics on the HTTP request structure, path & query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe API request requires a parent resource name as a path parameter and allows filtering & pagination through query parameters.\u003c/p\u003e\n"],["\u003cp\u003eAn empty request body is necessary, and a successful response returns a \u003ccode\u003eListDeploymentsResponse\u003c/code\u003e object containing the deployment data.\u003c/p\u003e\n"],["\u003cp\u003eTo use this API, you need authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details the process of listing deployments via an HTTP GET request to `https://sasportal.googleapis.com/v1alpha1/{parent}/deployments`. The `parent` path parameter is required, specifying a resource (e.g., \"nodes/1\"). Optional query parameters include `pageSize` (maximum deployments), `pageToken` (pagination), and `filter` (direct children). The request body must be empty. A successful request returns a `ListDeploymentsResponse`. The `https://www.googleapis.com/auth/sasportal` OAuth scope is required.\n"],null,["- [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\nHTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/{parent=customers/*/nodes/*}/deployments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent resource name, for example, \"nodes/1\", customer/1/nodes/2. |\n\nQuery 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\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains an instance of [ListDeploymentsResponse](/spectrum-access-system/reference/rest/v1alpha1/ListDeploymentsResponse).\n\nAuthorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]