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 to 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:
1
$ keeper shell
2
_ __
3
| |/ /___ ___ _ __ ___ _ _
4
| ' </ -_) -_) '_ \/ -_) '_|
5
|_|\_\___\___| .__/\___|_|
6
|_|
7
8
password manager & digital vault
9
10
Enter password for [email protected]
11
Password:
12
Logging in...
13
Syncing...
14
Decrypted [318] record(s)
15
16
My Vault> export --format json my_export_file.json
17
Processing... please wait.
18
318 records exported
Copied!

Creating a Custom .JSON file for Import Into Keeper

When creating a custom JSON import file, Keeper supports an array of "records", "folders" and "shared_folders". Several examples are included below that you can import into your vault for testing purposes.
Example JSON file: Records, Folders and Shared Folders
This file demonstrates several JSON import features including:
    Array of records
    Each record can have custom fields, notes and be added to folders
    Folders can be created as regular (private) or shared folders
    Records can also contain TOTP seeds (advanced feature, see Facebook entry)
1
{
2
"records": [
3
{
4
"title": "Dev Server 1",
5
"login": "root",
6
"password": "123123123",
7
"login_url": "https://myserver.com",
8
"notes": "These are some notes.",
9
"custom_fields": {
10
"Security Group": "Private"
11
},
12
"folders": [
13
{
14
"folder": "Private Folder 1"
15
}
16
]
17
},
18
{
19
"title": "Prod Server 1",
20
"login": "root",
21
"password": "kj949234723jhfs4jf7h",
22
"login_url": "https://myprodserver.com",
23
"notes": "These are some notes.",
24
"custom_fields": {
25
"Security Group": "Public",
26
"IP Address": "12.45.67.8"
27
},
28
"folders": [
29
{
30
"folder": "Private Folder 2"
31
},
32
{
33
"shared_folder": "My Shared Folder 1",
34
"can_edit": true,
35
"can_share": true
36
}
37
]
38
},
39
{
40
"title":"Google",
41
"login": "testing",
42
"password": "1234567890",
43
"login_url": "https://google.com",
44
"notes": "These are some notes.",
45
"custom_fields": {
46
"Favorite Food":"Cheetos"
47
},
48
"folders": [
49
{
50
"folder": "My Websites\\Online"
51
}
52
]
53
},
54
{
55
"title":"Facebook",
56
"login": "[email protected]",
57
"password": "123123123123",
58
"login_url": "https://facebook.com",
59
"notes": "This is our corporate shared record.",
60
"custom_fields": {
61
"Facebook Application ID":"ABC12345",
62
"TFC:Keeper":"otpauth://totp/Amazon:[email protected]?secret=JBSWY3DPEHPK3PXP&issuer=Amazon&algorithm=SHA1&digits=6&period=30"
63
},
64
"folders": [
65
{
66
"folder": "Social Media"
67
},
68
{
69
"shared_folder": "Shared Social",
70
"can_edit": false,
71
"can_share": false
72
}
73
]
74
}
75
]
76
}
77
Copied!
Example JSON file: Shared Folders and Permissions - No Records
The below JSON file demonstrates the ability to create a shared folder structure (without records) that has permissions configured.
Note: Example references to "UID", "Team UID", etc are placeholders that are specific to your vault.
1
{
2
"shared_folders": [
3
{
4
"path": "My Shared Folder 1",
5
"manage_users": true,
6
"manage_records": true,
7
"can_edit": true,
8
"can_share": true,
9
"permissions": [
10
{
11
"uid": "kVM96KGEoGxhskZoSTd_jw",
12
"manage_users": true,
13
"manage_records": true
14
},
15
{
16
"name": "[email protected]",
17
"manage_users": true,
18
"manage_records": true
19
}
20
]
21
},
22
{
23
"path": "Customer1\\My Shared Folder 2",
24
"manage_users": false,
25
"manage_records": false,
26
"can_edit": false,
27
"can_share": false,
28
"permissions": [
29
{
30
"uid": "<TEAM UID HERE>",
31
"manage_users": false,
32
"manage_records": false
33
},
34
{
35
"name": "<receipient email here>",
36
"manage_users": true,
37
"manage_records": true
38
}
39
]
40
},
41
{
42
"path": "Customer2\\My Shared Folder 3",
43
"manage_users": true,
44
"manage_records": true,
45
"can_edit": true,
46
"can_share": true,
47
"permissions": [
48
{
49
"uid": "<TEAM UID HERE>",
50
"manage_users": true,
51
"manage_records": true
52
},
53
{
54
"name": "[email protected]",
55
"manage_users": true,
56
"manage_records": true
57
}
58
]
59
}
60
]
61
}
Copied!
Example JSON File: Both Private Records/Folders and Shared Records/Folders
The below example JSON file combines several features - Shared Folders, Private Folders, Records and TOTP seeds.
Note: Example references to "UID", "Team UID", etc are placeholders that are specific to your vault.
1
{
2
"shared_folders": [
3
{
4
"path": "My Customer 1",
5
"manage_users": true,
6
"manage_records": true,
7
"can_edit": true,
8
"can_share": true,
9
"permissions": [
10
{
11
"uid": "kVM96KGEoGxhskZoSTd_jw",
12
"manage_users": true,
13
"manage_records": true
14
},
15
{
16
"name": "[email protected]",
17
"manage_users": true,
18
"manage_records": true
19
}
20
]
21
},
22
{
23
"path": "Testing\\My Customer 2",
24
"manage_users": true,
25
"manage_records": true,
26
"can_edit": true,
27
"can_share": true,
28
"permissions": [
29
{
30
"uid": "ih1CggiQ-3ENXcn4G0sl-g",
31
"manage_users": true,
32
"manage_records": true
33
},
34
{
35
"name": "[email protected]",
36
"manage_users": true,
37
"manage_records": true
38
}
39
]
40
}
41
],
42
"records": [
43
{
44
"title": "Bank Account 1",
45
"login": "customer1234",
46
"password": "4813fJDHF4239fdk",
47
"login_url": "https://chase.com",
48
"notes": "These are some notes.",
49
"custom_fields": {
50
"Account Number": "123-456-789"
51
},
52
"folders": [
53
{
54
"folder": "Optional Private Folder 1"
55
}
56
]
57
},
58
{
59
"title": "Bank Account 2",
60
"login": "mybankusername",
61
"password": "w4k4k193f$^&@#*%2",
62
"login_url": "https://amex.com",
63
"notes": "Some great information here.",
64
"custom_fields": {
65
"Security Group": "Public",
66
"IP Address": "12.45.67.8",
67
"TFC:Keeper":"otpauth://totp/Amazon:[email protected]?secret=JBSWY3DPEHPK3PXP&issuer=Amazon&algorithm=SHA1&digits=6&period=30"
68
},
69
"folders": [
70
{
71
"folder": "Optional Private Folder 1"
72
},
73
{
74
"shared_folder": "My Customer 1",
75
"can_edit": true,
76
"can_share": true
77
}
78
]
79
}
80
]
81
}
Copied!
Last modified 7mo ago