Delete devices and things

Task description

The Device Provisioning API offers an easy way for registering and deleting your physical devices.

How to execute

De-provision devices

The API documentation for de-provisioning devices and things is provided at

https://apidocs.bosch-iot-suite.com/index.html?urls.primaryName=Bosch IoT Suite - Device Provisioning#/deprovisioning

In order to delete an entity you will need write permission for the thing.
At this point, we assume that the entities have been created via Device provisioning API. Thus, the authentication and authorization for deleting such an entity should happen for the same scope.

  • Authorize with your Suite OAuth token
    See Device provisioning API > Authorize.

  • Click Try it out.

  • Set the service-instance-id

  • Set the device-id,
    this is the same as the ID you have set at the time of provisioning it.
    Pattern: your.namespace:your-device-name

  • Additionally you will need to decide whether or not to keep other entries associated with it:

    • the device credentials at Bosch IoT Hub - keepCredentials - false
      (or true if you want to hinder, that a new device with the same ID will ever re-register successfully)

    • the policy at Bosch IoT Things - keepPolicy - false
      (or true if you have a policy that is used by several other things)

  • Click Execute to submit the request.

Upon success, you get the status code 200, with a response body similar to the following snippet:

{
"device": "Device deleted successfully",
"credentials": "Credentials deleted successfully",
"thing": "Thing deleted successfully",
"policy": "Policy deleted successfully"
}

Delete the device credentials separately

In case you have decided to keep the credentials, but want to delete them afterwards, use Bosch IoT Hub API, and authenticate with your Suite OAuth token.

DELETE /credentials/{tenant-id}

Delete the policy separately

In case you have decided to keep the policy, but want to delete them afterwards, use Bosch IoT Things API, and authenticate with your Suite OAuth token.

DELETE /policies/{policyId}

Connection deletion

Before deleting a connection, please make sure that no other devices rely on this connection.
The easiest way is to delete the connection metrics, and watch at a later point in time if the connection is obsolete and can be deleted.

The Bosch IoT Hub to Thing connection is stored at the Things service.

Use the Bosch IoT Things API, and authenticate with a token.

Deleting a connection is also supported at the Things dashboard.

  • Use images/confluence/download/thumbnails/894252708/suite-list-subscription-icon.png Service Subscriptions page as an entry point.

  • Click the Go to Dashboard link from your package subscription.

  • Open the Connections/Integrations tab.

  • The automatically created connection is named "Devices via Bosch IoT Hub".

  • Click Edit

  • Click Delete

  • Finally, confirm if you really don't need it any longer.

Further notes

  • Deleting a namespace - will automatically delete ALL things and policies which have been registered with that namespace.

  • Deleting a Things service instance - will automatically delete ALL things, policies, namespaces and connections implicitly.

  • Deleting a Hub instance - will automatically delete ALL devices, credentials and the tenant.

  • Deleting a Suite authentication client - will only delete the respective OAuth2 client and the application will no longer be able to use this client for authorization.