Purging Entities

When entities are deleted, The Things Stack retains some IDs by default to prevent another user re-registering the ID and obtaining historical data.

It is also possible for administrators to purge IDs so that they may be reused. This reference contains information about how to do this, and the implications of purging IDs.

What Happens to Purged Entities?

Only administrators may purge entities. Purging an entity has the following effects:

  • Permanently deletes the entity
  • Permanently deletes collaborator rights related to the entity (does not apply to users as they do not have collaborators)
  • Permanently deletes API keys related to the entity (does not apply to OAuth clients as they do not have API keys)
  • Does not delete stored data in routing clusters (only in the Identity Server)
  • Does not delete stored events (hence these can be recovered by re-registering the ID)
  • Does not delete information stored in Packet Broker (applies to gateways)
  • Does not delete stored data in the storage integration (applies to applications)
  • Does not delete stored data in external integrations (applies to applications)
  • Releases the ID of the entity for re-use, which may give other users access to historical data if they register an entity with the same ID
Warning:
Purging entites deletes them permanently and is irreversible!

How to Purge Entities

Go to the General Settings tab of the entity and click Delete.

If you are an administrator, you will be presented with the option to purge the entity. Check the Also release entity IDs box to also purge the entity.

To view soft-deleted users:

ttn-lw-cli user list --deleted --all

To purge an application:

ttn-lw-cli applications purge --application-id <application-id>

To purge a client:

ttn-lw-cli clients purge --client-id <client-id>

To purge a gateway:

# By EUI
ttn-lw-cli gateways purge --gateway-eui <gateway-eui>
# Or by ID
ttn-lw-cli gateways purge --gateway-id <gateway-id>

To purge an organization:

ttn-lw-cli organizations purge --organization-id <organization-id>

To purge a user:

ttn-lw-cli users purge --user-id <user-id>
← Packet Forwarders Rate Limiting →