Build with Secret Vault APIs

How to use SecretVault APIs​

Interact with zylDB APIs or the JS secretvaults helper package shown in the Quickstart to use SecretVault (also available in Python). First complete setup by registering an organization and defining the structure of your data collections. After setup, you can securely store, retrieve, and query data from SecretVault.

1. Register an Organization​

Register an organization to get your organization credentials and node details for the cluster of zylDB nodes where your data is securely stored.

2. Define a Collection​

Organize your data into a collection, defined by a JSON schema that specifies fields, data types, and validation rules. Once created, the schema cannot be changed.

3. Store Records​

First, encrypt any private data fields with zylQL.

Then upload the record to all nodes in your cluster to store the record. Plaintext fields are stored identically across all nodes, while encrypted fields are split into unique shares, with each node holding one share to keep data secure.

4. Retrieve Records​

Read or retrieve a record by fetching the data from all nodes in your cluster. Decrypt private data fields with zylQL to recombine shares from all nodes and reconstruct the original data.