Purging Data

Edit online

To purge data from the webMethods API Gateway database, you must have the Manage purge and restore runtime event functional privilege in webMethods API Gateway.

Purging is the process of systematically deleting unwanted data from the database. You can purge data based on the type of data or the age of the data in the webMethods API Gateway database.

To purge data

  1. Expand the menu options icon menu_options, in the title bar, and select Administration.
  2. Select Manage Data.
  3. Click Archive and purge.
  4. Select the event types for which the data has to be purged.
    For the list of events that you can archive or purge, see List of Indexes that can be archived or purged.
  5. Select Purge.
    Note: You can select both Archive and Purge checkboxes to simultaneously archive outdated transactional data and purge the external Elasticsearch logs.
  6. Select one of the following options to purge (delete) the required data.
    • Select Range. Select a period during which you want the data to be purged.
      • To purge selected types of data from a particular date till the current date, select the required date in the From date field.
      • To purge selected types of data from the beginning (events start date) till a particular date, select the required date in the To date field.

      If you select both From date and To date, all the data in the selected range is archived.

    • Select Older than. Type a number and a time period. For example, if you type 1Y, data older than 1 year is selected for purging. If you select 1M, data older than one month is selected for purging.
  7. Click Submit.

    The purge operation is triggered and a job is created in the job table. You can monitor the status of the purge operation, in the job table.