delete

Owned by Aaron Allsbrook
Last updated: Oct 16, 2023 by Jeff Slavin (Unlicensed)
1 min read

Deletes a device registry configuration.

Note: This is an admin API.

The URL, systemKey, and token this endpoint requires are obtained differently than others. To get those, do the following:

  1. Click the Select project drop-down at the top of the IoT Core UI.

  2. Click the Edit icon (pencil) next to the desired project.

  3. Go to the SERVICE ACCOUNTS tab.

  4. If a service account already exists, select it and choose DOWNLOAD CREDENTIALS. If a service account does not exist, create it and select DOWNLOAD CREDENTIALS.

  5. A JSON file will be downloaded to your local machine. Open the file with an editor. Use the file’s systemKey, token, and URL as needed below.

HTTP request

DELETE {url}/api/v/4/webhook/execute/{systemKey}/cloudiot

Query parameters

Parameters

Parameters

name

string

The device registry’s name. For example, projects/example-project/locations/us-central1/registries/my-registry.

Header parameters

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

Code

Meaning

204

Success

Response body

If successful, the response body will be empty.

Example curl

curl 'https://iot.clearblade.com/api/v/4/webhook/execute/aae9b9b30c8aa4e49081c7eeb9bb07/cloudiot?name=projects/iot-core-test-363819/locations/us-central1/registries/two' -X DELETE -H 'ClearBlade-UserToken: {token}'


Using the instructions at the start of this document, replace the following: https://iot.clearblade.com with your URL. aae9b9b30c8aa4e49081c7eeb9bb07 with your systemKey. {token} with your token.


This command deletes a registry with registryId “two.” Replace the name with your registry’s name.