Offline Package

A new endpoint was added to the V5 API to facilitate the easy and performent way of getting all information from Pleasant Password server, for clients like KeePass, to enter offline mode

The package contains all folders, entries, and attachments.

HTTP POST is used to allow the request body to contain a usage comment that may be required by the servers administrator

POST     <url>/api/v5/rest/OfflinePackage

Example Request

http://localhost:10000/api/v5/rest/OfflinePackage
{
	"Comment": "Hello World"
}

Example Response

HTTP 200
{
    "Root": {
        "CustomUserFields": {},
        "CustomApplicationFields": {},
        "Children": [],
        "Credentials": [
            {
                "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": "ABC",
                "Username": "ABC",
                "Password": "112233",
                "Url": "",
                "Notes": "",
                "GroupId": "c04f874b-90f7-4b33-97d0-a92e011fb712",
                "Created": "2018-08-08T09:15:17-06:00",
                "Modified": "2018-08-08T09:25:45-06:00",
                "Expires": null
            }
        ],
        "Tags": [],
        "HasModifyEntriesAccess": true,
        "HasViewEntryContentsAccess": true,
        "CommentPrompts": {
            "AskForCommentOnViewPassword": false,
            "AskForCommentOnViewOffline": false,
            "AskForCommentOnModifyEntries": false,
            "AskForCommentOnMoveEntries": false,
            "AskForCommentOnMoveFolders": false,
            "AskForCommentOnModifyFolders": false
        },
        "Id": "c04f874b-90f7-4b33-97d0-a92e011fb712",
        "Name": "Root",
        "ParentId": "00000000-0000-0000-0000-000000000000",
        "Notes": null,
        "Created": "2018-07-31T11:27:32-06:00",
        "Modified": "2018-07-31T11:27:32-06:00",
        "Expires": null
    },
    "Attachments": [
        {
            "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
            "AttachmentId": "496ea02f-f5f7-4565-985c-a9360103c2de",
            "FileName": "updates9.txt",
            "FileData": "UGFzc01h",
            "FileSize": 6
        },
        {
            "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
            "AttachmentId": "5a3c2053-4a93-4b64-97d1-a9360103c2de",
            "FileName": "added2.txt",
            "FileData": "UGFzc01h",
            "FileSize": 6
        },
        {
            "CredentialObjectId": "13caaa57-2186-467e-b107-bc29f8c3533e",
            "AttachmentId": "4cfbb5f9-f03e-4672-b55d-a93601069567",
            "FileName": "added4.txt",
            "FileData": "UGFzc01h",
            "FileSize": 6
        }
    ],
    "Expiry": "9999-12-31T23:59:59.9999999+00:00"
}

Obsolete

  • POST     <url>/api/v5/rest/CredentialGroupOffline
    This offline package has been deprecated and will return throw NotSupportedException when called. Please use the new offline package endpoint documented above: POST <url>/api/v5/rest/OfflinePackage
Tag page
You must login to post a comment.