v3.23.1

Getting Started Devices Gateways Integrations Reference
Get The Things Stack

Reference

    Overview
  • Adaptive Data Rate
  • API
  • Application Packages
  • Billing with Stripe
  • Command-Line Interface
  • Components
  • Configuration
  • Data Formats
  • Data Retention and Privacy
  • Email Templates
  • Federated Authentication
  • Frequency Plans
  • FUOTA
  • Gateway RTT
  • Glossary
  • ID and EUI Constraints
  • Last Activity
  • LoRa Basics Station Implementation Guide
  • LoRaWAN Backend Interfaces Interoperability
  • LoRaWAN Specification and Regional Parameters
  • Networking
  • Packet Broker Routing
  • Packet Forwarders
  • Purging Entities
  • Rate Limiting
  • Resource Limiting
  • Root Certificates
  • Telemetry
  • Tenant Management
  • Web UI Branding

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

Purging entities using the Console or the CLI is usually most convenient, so those methods are explained in this section. However, it is also possible to purge entities using the API.

  • Console
  • CLI

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 →

On this page

  • What Happens to Purged Entities?
  • How to Purge Entities

The Things Stack

Getting Started

Devices

Gateways

Integrations

Reference

Contributing

GitHub

Forum

About Us

The Things Network

The Things Industries

About this page

Last changed by Nejra Selimović on 11 Feb 2022.
doc: Add missing API entries for purging entities, cross-link sections (#773)

Edit on Github