patch: projects.locations.registries.devices

Updates a device.

You can find the URL, SystemKey, and token required in the call by clicking API Keys (key icon) at the top-right of the Registry Details page. Use the Registry Keys section.

HTTP request

PATCH {URL}/api/v/4/webhook/execute/{SystemKey}/cloudiot_devices

Query parameters

Parameters
`name`	`string` The device’s name. For example, `projects/p0/locations/us-central1/registries/registry0/devices/device0` or `projects/p0/locations/us-central1/registries/registry0/devices/{numId}`. The device’s name can be set to the deviceId or numId (i.e., without the project, location, and registry info. prepended).
`updateMask`	`string (FieldMask format)` Only updates the `device` fields indicated by this mask. The field mask must not be empty, contain immutable fields, or be only set by the server. Mutable top-level fields: `credentials`, `blocked`, `logLevel`, and `metadata` A comma-separated list of fully qualified field names.

Parameters

name

string

The device’s name. For example, projects/p0/locations/us-central1/registries/registry0/devices/device0

projects/p0/locations/us-central1/registries/registry0/devices/{numId}.

The device’s name can be set to the deviceId or numId (i.e., without the project, location, and registry info. prepended).

updateMask

string (FieldMask format)

Only updates the device fields indicated by this mask. The field mask must not be empty, contain immutable fields, or be only set by the server. Mutable top-level fields: credentials, blocked, logLevel, and metadata

A comma-separated list of fully qualified field names.

Header parameters

Parameters
`ClearBlade-UserToken`	See the note at the start of this document on where to find the token.

Request body

The request body contains a device instance.

Response status codes

Code	Meaning
200	Success

Response body

If successful, the response body contains a device instance.