Skip to main content

List Vaults

Lists all available vaults

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

if ContinueOnError property is true, no error is caught when the project is executed even if Catch node is used.

Output​

  • Vaults - Array of available vaults

The output of this node will be a JSON object that contains all available vaults.

How It Works​

The List Vaults node retrieves all vaults accessible to the user:

  1. API Call: Makes GET request to /v1/vaults.list endpoint
  2. Data Processing: Extracts vault name and ID from each vault in the response
  3. Output: Returns array of vaults with name and vault_id properties
  4. Filtering: Only returns vaults the user has permissions to access

Requirements​

  • User Authentication: User must be authenticated with Robomotion
  • Vault Access: Returns only vaults the user has access to

Error Handling​

Error CodeDescriptionSolution
Core.Vault.ListVaults.ErrOnCreateConfiguration parsing failedCheck node configuration
Core.Vault.ListVaults.ErrOnMessageMessage parsing or API call failedVerify API connectivity
Core.Vault.ListVaults.ErrOutputMarshalFailed to serialize outputCheck output variable configuration

Usage Examples​

Example 1: List All Accessible Vaults​

// List all vaults
// After execution:
// msg.vaults = [{name: "Production", vault_id: "xxx"}, {name: "Development", vault_id: "yyy"}]

Example 2: Find Vault by Name​

// Find specific vault by name
// After List Vaults execution:
msg.prodVault = msg.vaults.find(v => v.name === "Production");
msg.prodVaultId = msg.prodVault.vault_id;
// Use vault_id with other vault nodes

Example 3: Check Vault Exists​

// Verify vault exists before using it
const vaultExists = msg.allVaults.some(v => v.name === "Test Vault");
if (!vaultExists) {
  throw new Error("Test Vault not found");
}

Usage Notes​

  • Returns only vaults the user has permissions to access
  • Empty result means no accessible vaults or authentication issue
  • Vault IDs are GUIDs that can be used with other vault nodes
  • Result includes vault names and IDs only, not vault contents

Tips​

  • Use at the start of flows to dynamically select vaults
  • Combine with conditional logic for multi-environment flows
  • Cache results to reduce API calls
  • Validate vault availability before processing
  • Use for vault discovery and administration tasks
  • List Items - List items in a specific vault
  • Get Item - Retrieve items from vaults in the list
  • Add Item - Add items to vaults in the list