Page Summary
-
This document explains how to update a device using the Spectrum Access System API with an HTTP PATCH request.
-
It details the required HTTP request structure, including path and query parameters, request body format, and expected response.
-
Authentication is necessary using the
https://www.googleapis.com/auth/userinfo.emailOAuth scope for successful device updates. -
The request body and successful response body both contain an instance of the
Deviceobject as defined in the provided link.
Updates a device.
HTTP request
PATCH https://sasportal.googleapis.com/v1alpha1/{device.name=nodes/*/devices/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
device.name |
Output only. The resource path name. |
Query parameters
| Parameters | |
|---|---|
updateMask |
Fields to be updated. A comma-separated list of fully qualified names of fields. Example: |
Request body
The request body contains an instance of Device.
Response body
If successful, the response body contains an instance of Device.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/userinfo.email