Skip to main content
Function formatters produce an output value without requiring an input attribute. You can use a function formatter on its own or as the start of a more complex expression, with additional formatters piped in after it. For example, [vault(local/MyItem)] resolves the vault item in the local vault on its own, but you can also chain formatters after it, as shown below: [vault(local/MyItem) | equals(bar)]

vault(VaultId/ItemName[, ifnotexist])

Returns the value of the vault item in the Global Settings Vault that matches the provided identifier. By default, if no matching vault item exists, an error is generated.
  • VaultId: The ID of the vault provider. Use local for the local vault or env for the Environment Variable provider. If vaultid is not specified, Sync will default to the local vault.
  • ItemName: The name of the vault item to retrieve.
  • ifnotexist: An optional default value to return when no vault item with the specified itemname exists. Supplying this parameter prevents an error from being generated.
Use caution when you reference encrypted vault items in scripting contexts to ensure that sensitive values are not included in logs.