Docs »

Automations »

Commands »

storage.delete

The storage.delete: command removes a value from long-term storage.



start:
  storage.set:
    inputs:
      key: some.arbitrary.identifier
      value: This is the saved value.
  storage.delete:
    inputs:
      key: some.arbitrary.identifier
  storage.get:
    output: result
    inputs:
      key: some.arbitrary.identifier
    on_error:
      set:
        result@json: null
  return:
    output@key: result


Result:


output: (null)

Syntax

inputs:

Key Req’d  
key: The storage key to delete. This is an arbitrary identifier.

output:

The optional placeholder to store the result.

on_simulate:

The commands to run during simulation instead of deleting the storage key.

If omitted, the storage key is deleted during simulation.

on_success:

The commands to run on success.

The optional output: placeholder is set true if successful and false otherwise.

on_error:

The commands to run on failure. If omitted, the automation exits in the error state.

The output: placeholder receives a dictionary with these keys:

Key  
error The error message.