Protocol
The server offers a RESTful HTTP interface secured by HTTPS.Authentication
- Client aquires client certificate from certificate store
- Client initiates secured HTTPS connection to localhost port 12984
- Server authenticates client by client certificate. If the client certificate is not in the allowed list, server prompts user to allow or deny the client
- If user denies the client, the server aborts the connection
- If user allows the client, the client certificate is added to the allowed list and the connection is authenticated
- Client sends requests
RESTful API
The server expects and returns data formatted with JSON.
Get
Returns entry identified by uuid
Uri: /entry/{uuid}
Method: GET
Returns the entry object.
Update
Updates existing entry identified by uuid
Uri: /entry/{uuid}
Method: PUT
Returns the updated entry object.
Delete
Deletes entry identified by uuid
Uri: /entry/{uuid}
Method: DELETE
If the delete is successful, you get the following return.
Description | Type |
---|---|
If the delete succeeded | Boolean |
Create
Creates new entry.
Uri: /entry
Method: POST
Parameters:
Name | Description | Type | Required |
---|---|---|---|
GroupName | Group name. If not set use root group | String | No |
Entry | Name/Value pairs of new entry | Entry | Yes |
Returns the newly created entry object.
List
List entries
Uri: /entry/list
Method: POST
Parameters:
Name | Description | Type | Required |
---|---|---|---|
query | search query | Query Object | Yes |
Returns array of matching entries.
Types
Entry Object
Name | Description | Type |
---|---|---|
Uuid | unique id of entry | Uuid encoded as hex string |
UserName | UserName | String |
Password | Password | String |
Title | Title | String |
Notes | Notes | String |
URL | Url | String |
And any other variable fields of the entry.
Query Object
Name | Description | Type | Required |
---|---|---|---|
ComparisonMode | Number | No | |
ExcludeExpired | Boolean | No | |
RegularExpression | Boolean | No | |
SearchInGroupNames | Boolean | No | |
SearchInNotes | Boolean | No | |
SearchInOther | Boolean | No | |
SearchInPasswords | Boolean | No | |
SearchInTags | Boolean | No | |
SearchInTitles | Boolean | No | |
SearchInUrls | Boolean | No | |
SearchInUserNames | Boolean | No | |
SearchInUuids | Boolean | No | |
SearchString | String | Yes (for Search only) |