Info
KeePass Hub
M. Programmatic Access
RESTful API
RESTful API v5
Service Models v5
User Favourites
Offline Package
Miscellaneous
User Access
Folders
Entries
Attachments
Sitemap
Info  >  KeePass Hub  >  M. Programmatic Access  >  RESTful API  >  RESTful API v5  >  Entries Page last modified May 02 2022, 14:40

Entries

Download Pleasant Password Server

GET    /api/v5/rest/entries/{entryId:guid}

This endpoint is used to retrieve a single entry from the system.

Example Request

http://localhost:10000/api/v5/rest/Entries/13caaa57-2186-467e-b107-bc29f8c3533e

Example Result

HTTP 200
{
    "CustomUserFields": {},
    "CustomApplicationFields": {},
    "Tags": [],
    "HasModifyEntriesAccess": true,
    "HasViewEntryContentsAccess": true,
    "CommentPrompts": {
        "AskForCommentOnViewPassword": false,
        "AskForCommentOnViewOffline": false,
        "AskForCommentOnModifyEntries": false,
        "AskForCommentOnMoveEntries": false,
        "AskForCommentOnMoveFolders": false,
        "AskForCommentOnModifyFolders": false
    },
    "Id": "13caaa57-2186-467e-b107-bc29f8c3533e",
    "Name": "My Entry Name",
    "Username": "MyUsername",
    "Password": "MyPassword01",
    "Url": "",
    "Notes": "",
    "GroupId": "c04f874b-90f7-4b33-97d0-a92e011fb712",
    "Created": "2018-08-08T09:15:17-06:00",
    "Modified": "2018-08-08T13:03:37-06:00",
    "Expires": null
}

POST    /api/v5/rest/entries

This endpoint is used to add a new entry to the system.

Example Request

http://localhost:10000/api/v5/rest/Entries
{
    "CustomUserFields": {},
    "CustomApplicationFields": {},
    "Tags": [],
    "Name": "New Entry Name",
    "Username": "MyUserName",
    "Password": "MyPassword01",
    "Url": "",
    "Notes": "",
    "GroupId": "c04f874b-90f7-4b33-97d0-a92e011fb712",
    "Expires": null
}

Example Response

HTTP 200
"c733539f-c585-4fcf-8bb6-3c202bb2396b"

PATCH    /api/v5/rest/entries/{entryId:guid}

This endpoint is used for making partial updates to a single entry.

Example Request

http://localhost:10000/api/v5/rest/entries/13caaa57-2186-467e-b107-bc29f8c3533e
{
	"Name": "Updated Name"
}

Example Result

HTTP 204

PUT    /api/v5/rest/entries/{entryId:guid}

This endpoint is used for making full update to a single entry.

Example Request

http://localhost:10000/api/v5/rest/entries/13caaa57-2186-467e-b107-bc29f8c3533e
{
	"Item":
	{
	    "CustomUserFields": {},
	    "CustomApplicationFields": {},
	    "Tags": [],
	    "Id": "13caaa57-2186-467e-b107-bc29f8c3533e",
	    "Name": "Full Update",
	    "Username": "ABCDEF",
	    "Password": null,
	    "Url": "",
	    "Notes": "",
	    "GroupId": "c04f874b-90f7-4b33-97d0-a92e011fb712",
	    "Expires": null
	},
	"Comment": "Usage Comment"
}

Example Result

HTTP 204

DELETE    /api/v5/rest/entries/{entryId:guid}

This endpoint is used for both archiving and deletion of an entry. This option is set in the Action property of the request body: "Archive" or "Delete".

Example Archive Request

http://localhost:10000/api/v5/rest/Entries/c733539f-c585-4fcf-8bb6-3c202bb2396b
{
	"Action": "Archive",
	"Comment": "Usage Comment"
}

Example Archive Result

HTTP 204

Example Delete Request

http://localhost:10000/api/v5/rest/Entries/c733539f-c585-4fcf-8bb6-3c202bb2396b
{
	"Action": "Delete",
	"Comment": "Usage Comment"
}

Example Delete Result

HTTP 204

GET    /api/v5/rest/entries/{entryId:guid}/password

This endpoint is used to retrieve the password for an entry. If a comment is required, this method will throw: you will need to POST to the same route documented below.

Example Request

http://localhost:10000/api/v5/rest/Entries/13caaa57-2186-467e-b107-bc29f8c3533e/Password

Example Result

HTTP 200
"112233"

POST    /api/v5/rest/entries/{entryId:guid}/password

This endpoint is used to retrieve the password for an entry. This endpoint is used when a comment is required.

Example Request

http://localhost:10000/api/v5/rest/Entries/13caaa57-2186-467e-b107-bc29f8c3533e/Password
{
	"Comment": "Usage Comment"
}

Example Result

HTTP 200
"112233"

GET        <url>/api/v5/rest/entries/{entryId:guid}/attachments

This endpoint is used to get all attachments associated to an entry.

Example Request

http://localhost:10000/api/v5/rest/Entries/13caaa57-2186-467e-b107-bc29f8c3533e/Attachments

Example Response

HTTP 200
[
    {
        "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
        "AttachmentId": "ac4c94d8-bec2-4afb-8bfd-a93600fb6e49",
        "FileName": "Warn.PNG",
        "FileData": "UllYNg==",
        "FileSize": 4
    }
]

PUT        <url>/api/v5/rest/entries/{entryId:guid}/attachments

This endpoint is used to update an entries attachment collection. This will handle additions, substractions, and modifications to attachments.

Example Request

http://localhost:10000/api/v5/rest/Entries/13caaa57-2186-467e-b107-bc29f8c3533e/Attachments
[
	 {
        "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
        "AttachmentId": "3BF23EF5-1888-40C2-B727-EEFC522CFD74",
        "FileName": "updates9.txt",
        "FileData": "UllYNg==",
        "FileSize": 4
    },
	{
        "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
        "AttachmentId": "00000000-0000-0000-0000-000000000000",
        "FileName": "added2.txt",
        "FileData": "UllYNg==",
        "FileSize": 4
    }
]

Example Response

HTTP 204

POST        <url>/api/v5/rest/entries/{entryId:guid}/attachments

This endpoint is used to add a new attachment to an entry.

Example Request

http://localhost:10000/api/v5/rest/Entries/13caaa57-2186-467e-b107-bc29f8c3533e/Attachments
{
    "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
    "FileName": "added4.txt",
    "FileData": "UGFzc01h"
}

Example Response

HTTP 200
"4cfbb5f9-f03e-4672-b55d-a93601069567"

GET   <url>/api/v5/rest/entries/{entryId:guid}/attachments/{attachmentId:guid}

This endpoint is used to get a single attachment from an entry.

Example Request

http://localhost:10000/api/v5/rest/Entries/13caaa57-2186-467e-b107-bc29f8c3533e/Attachments/ee20446c-3f5e-419b-9d8c-a93600fe401f

Example Response

HTTP 200
{
    "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
    "AttachmentId": "ee20446c-3f5e-419b-9d8c-a93600fe401f",
    "FileName": "updates.txt",
    "FileData": "UllYNg==",
    "FileSize": 4
}

PUT   <url>/api/v5/rest/entries/{entryId:guid}/attachments/{attachmentId:guid}

This endpoint is used to update a single attachment to an entry.

Example Request

http://localhost:10000/api/v5/rest/Entries/13caaa57-2186-467e-b107-bc29f8c3533e/Attachments/ee20446c-3f5e-419b-9d8c-a93600fe401f

{
    "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
    "AttachmentId": "ee20446c-3f5e-419b-9d8c-a93600fe401f",
    "FileName": "updates2.txt",
    "FileData": "UGFzc01h",
}

Example Response

HTTP 204

**The routes containing "entries" or "folders" can be substituted with "credential" and "credentialgroup" respectively. this is to allow reverse compability of the API for existing clients.