FoksApi Overview

The primary focus is to provide programmatic access to the key/value store functionality implemented by FOKS. Currently, the foks command line interface is being used with the thought of migrating to a REST Api as some future date.

To follow the examples below, you'll a working version of FOKS and PowerShell installed. The script has been develop and tested on Linux in an OS neutral manner so should be working on all OSes.

FoksApi Operations

 KeyPaths       - Generate a list of current key/value pairs
 FindPaths      - List keys matching search expression
 Create         - Create a key/value pair
 Get            - Copy the value of a key/value pair to the clipboard
 Update         - Update a key/value pair with a new value
 Remove         - Remove a key/value pair
 Lock           - Require a passphrase to unlock FOKS
 Usage          - Display Server Usage Info
 passPhrase     - Set, Change, or Unlock the passphrase
 SetRandomValue - Random 20 char passphrase created in the clipboard
 Usage          - Display Server Usage Inf