Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Documentation under development

Reference URL: https://cloud.google.com/iot/docs/reference/cloudiot/rest/v1/projects.locations.registries/get

Gets a device registry configuration.

HTTP request

GET https://cloudiot.googleapis.com/v1/{name=projects/*/locations/*/registries/*}

The URL uses gRPC Transcoding syntax.

...

Gets a device registry configuration.

Info

Note: This is a regional API.

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

GET {URL}/api/v/4/webhook/execute/{SystemKey}/cloudiot

Query parameters

Parameters

name

string

The device registry’s name

of the device registry

. For example, projects/example-project/locations/us-central1/registries/my-registry

.

Authorization requires the following Google IAM permission on the specified resource name:

cloudiot.registries.get



or

my-registry

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 must be empty.

Response status codes

Code

Meaning

200

Success

Response body

If successful, the response body contains an a DeviceRegistry instance of DeviceRegistry.

Authorization Scopes

Requires one of the following OAuth scopes:


Example curl

curl 'https://

...

us-central1.

...

clearblade.com/

...

api/v/4/webhook/execute/aae9b9b30c8aa4e49081c7eeb9bb07/cloudiot?name=test-reg' -H 'ClearBlade-UserToken: {Token}'

OR

curl 'https://

...

us-central1.

...

clearblade.com/

...

For more information, see the Authentication Overviewapi/v/4/webhook/execute/aae9b9b30c8aa4e49081c7eeb9bb07/cloudiot?name=test-reg' -X GET -H 'ClearBlade-UserToken: {Token}'

Using the instructions at the start of this document, replace the following: https://us-central1.clearblade.com with your URL. aae9b9b30c8aa4e49081c7eeb9bb07 with your SystemKey. {Token} with your token.