Method: deployments.devices.patch

  • Updates an existing device within a deployment using an HTTP PATCH request.

  • The request must target a specific device using its resource path in the URL.

  • You can specify fields to update with the updateMask query parameter using FieldMask format.

  • The request body should contain the updated device details in the Device object format, and the response will return the updated device if successful.

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

Updates a device.

HTTP request

PATCH https://sasportal.googleapis.com/v1alpha1/{device.name=deployments/*/devices/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
device.name

string

Output only. The resource path name.

Query parameters

Parameters
updateMask

string (FieldMask format)

Fields to be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

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/sasportal