Welcome to the StoredSafe API Documentation

The StoredSafe API is a way for you to automate your interaction with the StoredSafe system. With the API, you can create your own scripts or applications with most of the functionality you can find inside StoredSafe.

The StoredSafe API is RESTlike and HTTP-based. Basically, this means that the communication is made through normal HTTP requests.

Contents:

• Introduction
  • Welcome to the StoredSafe API
  • Open Source and StoredSafe
  • Authentication
  • Server Address
  • Providing Parameters
  • HTTP Status Code Definitions
  • JSON Responses
  • The Internet is unreliable
  • Limitations
  • REST Requests
• Resource: Authentication
  • Method: Login to StoredSafe
  • Method: Log out from StoredSafe
  • Method: Check if the session is alive
• Resource: Vaults
  • Method: Create a Vault
  • Method: Edit a Vault
  • Method: Delete a Vault
  • Method: List available Vaults
  • Method: List objects in a Vault
  • Method: Add member to a Vault
  • Method: Edit member in a Vault
  • Method: Remove a member from a Vault
  • Method: List members in Vault
• Resource: Objects
  • Method: Create Objects
  • Method: Edit Object
  • Method: Delete Object
  • Method: Retrieve Object
  • Method: Search for Objects
• Resource: Files
  • Method: Identify Templates
  • Method: Upload Files
  • Method: Download Files
• Resource: Templates
  • Method: Retreive a Template
  • Method: List all Templates
• Resource: Users
  • Method: Create User
  • Method: Edit User
  • Method: Delete User
  • Method: List users
• Resource: Transparent Encryption
  • Method: Create Key
  • Method: Read Key
  • Method: List Keys
  • Method: Delete Key
  • Method: Encrypt Data
  • Method: Decrypt Data
  • Method: Rotate Key
  • Method: Rewrap Data
  • Method: Generate Data Key
  • Method: Export Key
  • Method: Backup Key
  • Method: Restore Key
• Resource: Miscellaneous functions
  • Method: Obtain capabilities and permission bits
  • Method: Obtain all password policies
  • Method: Obtain StoredSafe version
  • Method: Password generator
  • User Capabilities and Vault Permission Bits
• Migrating between API versions
  • From 2.0.5 to 2.1.0