Delete JSON icon

Delete JSON

Delete JSON data from the JSON Vault

Delete JSON

AI-generated

Overview

This node deletes JSON data stored in a global JSON Vault within the workflow's static data. It is useful for managing and cleaning up stored JSON data by removing specific keys, including nested keys using dot notation. For example, it can delete user data or configuration entries stored under certain keys in the vault.

Use Case Examples

  1. Deleting a user profile stored under the key 'users.admin'.
  2. Removing a configuration setting stored under 'settings.theme'.

Properties

Name Meaning
Key The key in the JSON Vault to delete. Supports nested paths with dots (e.g., 'users.admin').
Error if Not Exists Whether to throw an error if the specified key does not exist in the vault.

Output

JSON

  • success - Indicates if the deletion was successful (true or false).
  • key - The key that was requested to be deleted.
  • action - The action performed, always 'deleted'.
  • existed - Boolean indicating if the key existed before deletion.
  • deletedValue - The value that was deleted if the key existed.
  • vaultSize - The number of keys remaining in the JSON Vault after deletion.
  • error - Error message if the deletion failed (only present if success is false).

Dependencies

  • Requires access to a global JSON Vault stored in the workflow's static data.

Troubleshooting

  • If the key format is invalid, the node throws an error indicating allowed characters (letters, numbers, dots, hyphens, and underscores).
  • If 'Error if Not Exists' is true and the key does not exist, the node throws an error specifying the missing key.
  • If the key is empty, the node throws an error stating the key is required.
  • Ensure the JSON Vault does not exceed size limits; otherwise, validation errors may occur.

Discussion