Import Text File (.json)

Import Keeper JSON structured file format

Keeper supports importing a structured JSON file. You may use this, for example, if you have backed up a Keeper file from a different vault or if you are building a file from another data source. This is an advanced feature, typically used by Keeper Enterprise administrators or more technical customers.

The JSON file can be created in several ways:

  • Exporting .JSON file from the Keeper Vault

  • Exporting .JSON from Keeper Commander SDK

  • Creating your own custom file

Creating .JSON file from a Keeper Vault

To create a .JSON file from your existing Keeper vault, click on your email > Settings > Export:

Open your Keeper Settings

Export JSON

Click on Export Now and type in your Master Password (if requested) to export your records in JSON format.

Creating a JSON file from Keeper Commander

Keeper Commander is a developer / Admin tool that has many capabilities for managing your vault and Enterprise account.

Visit the Keeper Commander SDK repository here: https://github.com/Keeper-Security/commander

The command to export a vault in JSON format is demonstrated below:

$ keeper shell
_ __
| |/ /___ ___ _ __ ___ _ _
| ' </ -_) -_) '_ \/ -_) '_|
|_|\_\___\___| .__/\___|_|
|_|
password manager & digital vault
Enter password for demo@company.com
Password:
Logging in...
Syncing...
Decrypted [318] record(s)
My Vault> export --format json my_export_file.json
Processing... please wait.
318 records exported

Creating a custom .JSON file

Here's a few example JSON files for reference (you can also just export from your Keeper Vault and see the structure that way):

Example JSON file: Records and Folders (no sharing)

{
"records": [
{
"title": "Dev Server 1",
"login": "root",
"password": "123123123",
"login_url": "https://myserver.com",
"notes": "These are some notes.",
"custom_fields": {
"Security Group": "Private"
},
"folders": [
{
"folder": "Private Folder 1"
}
]
},
{
"title": "Prod Server 1",
"login": "root",
"password": "kj949234723jhfs4jf7h",
"login_url": "https://myprodserver.com",
"notes": "These are some notes.",
"custom_fields": {
"Security Group": "Public",
"IP Address": "12.45.67.8"
},
"folders": [
{
"folder": "Private Folder 2"
},
{
"shared_folder": "My Shared Folder 1",
"can_edit": true,
"can_share": true
}
]
}
]
}

Example JSON file: Shared Folders and Permissions

Note: Example references to "UID", "Team UID", etc are placeholders that are specific to your vault.

{
"shared_folders": [
{
"path": "My Shared Folder 1",
"manage_users": true,
"manage_records": true,
"can_edit": true,
"can_share": true,
"permissions": [
{
"uid": "kVM96KGEoGxhskZoSTd_jw",
"manage_users": true,
"manage_records": true
},
{
"name": "myusername@company.com",
"manage_users": true,
"manage_records": true
}
]
},
{
"path": "Customer1\\My Shared Folder 2",
"manage_users": false,
"manage_records": false,
"can_edit": false,
"can_share": false,
"permissions": [
{
"uid": "<TEAM UID HERE>",
"manage_users": false,
"manage_records": false
},
{
"name": "<receipient email here>",
"manage_users": true,
"manage_records": true
}
]
},
{
"path": "Customer2\\My Shared Folder 3",
"manage_users": true,
"manage_records": true,
"can_edit": true,
"can_share": true,
"permissions": [
{
"uid": "<TEAM UID HERE>",
"manage_users": true,
"manage_records": true
},
{
"name": "myusername@company.com",
"manage_users": true,
"manage_records": true
}
]
}
]
}

Example JSON File: Both Private Records/Folders and Shared Records/Folders

Note: Example references to "UID", "Team UID", etc are placeholders that are specific to your vault.

{
"shared_folders": [
{
"path": "My Customer 1",
"manage_users": true,
"manage_records": true,
"can_edit": true,
"can_share": true,
"permissions": [
{
"uid": "kVM96KGEoGxhskZoSTd_jw",
"manage_users": true,
"manage_records": true
},
{
"name": "user@mycompany.com",
"manage_users": true,
"manage_records": true
}
]
},
{
"path": "Testing\\My Customer 2",
"manage_users": true,
"manage_records": true,
"can_edit": true,
"can_share": true,
"permissions": [
{
"uid": "ih1CggiQ-3ENXcn4G0sl-g",
"manage_users": true,
"manage_records": true
},
{
"name": "user@mycompany.com",
"manage_users": true,
"manage_records": true
}
]
}
],
"records": [
{
"title": "Bank Account 1",
"login": "customer1234",
"password": "4813fJDHF4239fdk",
"login_url": "https://chase.com",
"notes": "These are some notes.",
"custom_fields": {
"Account Number": "123-456-789"
},
"folders": [
{
"folder": "Optional Private Folder 1"
}
]
},
{
"title": "Bank Account 2",
"login": "mybankusername",
"password": "w4k4k193f$^&@#*%2",
"login_url": "https://amex.com",
"notes": "Some great information here.",
"custom_fields": {
"Security Group": "Public",
"IP Address": "12.45.67.8"
},
"folders": [
{
"folder": "Optional Private Folder 1"
},
{
"shared_folder": "My Customer 1",
"can_edit": true,
"can_share": true
}
]
}
]
}