Miscellaneous

See why customers choose Pleasant Password Server with a KeePass client

POST    /api/v5/rest/passwordstrength

This endpoint is used to test a string complexity for use as a password.

Example Request

http://localhost:10000/api/v5/rest/passwordstrength
{
	"Password": "Test"
}

Example Result

HTTP 200
{
    "NumericalStrength": 6,
    "DescriptiveStrength": "weak"
}

GET    /api/v5/rest/CanUserAddEntry/{folderId:guid}

This endpoint is used to ask if the current user can add a entry.

Example Request

http://localhost:10000/api/v5/rest/CanUserAddEntry/c04f874b-90f7-4b33-97d0-a92e011fb712

Example Result

HTTP 200
true

GET    /api/v5/rest/CanUserAddFolder/{folderId:guid}

This endpoint is used to ask if the current user can add a subfolder.

Example Request

http://localhost:10000/api/v5/rest/CanUserAddFolder/c04f874b-90f7-4b33-97d0-a92e011fb712

Example Result

HTTP 200
true

POST    /api/v5/rest/IsCommentRequired/{objectId:guid}

This endpoint is used to ask if the current user is required to add a comment when performing an action against a specific object. The objectId can be for a entry or folder.

Example Request

http://localhost:10000/api/v5/rest/IsCommentRequired/c04f874b-90f7-4b33-97d0-a92e011fb712
{
	"ActionName": "ModifyEntries"
}

Example Result

HTTP 200
false 

GET    /api/v5/rest/IsOfflineAvailable

This endpoint is used to ask if a user has access to an entries that they are permitted to cache for offline access.

Example Request

http://localhost:10000/api/v5/rest/IsOfflineAvailable

Example Result

HTTP 200
true

GET    /api/v5/rest/GetServerInfo

This endpoint is used to get information about the server.

Example Request

http://localhost:10000/api/v5/rest/GetServerInfo

Example Result

HTTP 200
{
    "ServerVersion": "0.0.0.0",
    "NetVersion": "4.0.30319.42000",
    "OsVersion": "Microsoft Windows NT 10.0.17134.0",
    "PortSettings": "10001",
    "DnsInformation": "\r\nAdapter: Intel(R) Ethernet Connection (5) I219-LM\r\n    Suffix: \r\n    Enabled: False\r\n    Dynamically Configured: True\r\n    IpAddresses: \r\n      192.168.1.19\r\n      8.8.8.8\r\n      10.0.20.11\r\n\r\nAdapter: Software Loopback Interface 1\r\n    Suffix: \r\n    Enabled: False\r\n    Dynamically Configured: True\r\n    IpAddresses: \r\n      fec0:0:0:ffff::1%1\r\n      fec0:0:0:ffff::2%1\r\n      fec0:0:0:ffff::3%1\r\n",
    "Ping": null
}

GET    /api/v5/rest/configuration/{client:string}

This endpoint is used to get information the client configuration.

Example Request

http://localhost:10000/api/v5/rest/configuration/KeePass

Example Result

HTTP 200
{
    "Name": "Demo.config.xml",
    "ConfigXml": "<Configuration xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\r\n  <Meta>\r\n    <TemplateGroupId />\r\n    <PreferUserConfiguration>true</PreferUserConfiguration>\r\n    <OmitItemsWithDefaultValues>true</OmitItemsWithDefaultValues>\r\n  </Meta>\r\n  <Application>\r\n    <TemplateGroupId />\r\n    <LastUsedFile>\r\n      <Path>Pleasant Password Server</Path>\r\n      <CredProtMode>Obf</CredProtMode>\r\n      <CredSaveMode>NoSave</CredSaveMode>\r\n    </LastUsedFile>\r\n    <MostRecentlyUsed>\r\n      <MaxItemCount>12</MaxItemCount>\r\n      <Items />\r\n    </MostRecentlyUsed>\r\n    <WorkingDirectories />\r\n    <Start>\r\n      <CheckForUpdate>false</CheckForUpdate>\r\n    </Start>\r\n    <FileOpening />\r\n    <FileClosing />\r\n    <TriggerSystem>\r\n      <Triggers />\r\n    </TriggerSystem>\r\n  </Application>\r\n  <Logging />\r\n  <MainWindow>\r\n    <SplitterHorizontalFrac>0.8233555</SplitterHorizontalFrac>\r\n    <CloseButtonMinimizesWindow>true</CloseButtonMinimizesWindow>\r\n    <MinimizeToTray>true</MinimizeToTray>\r\n    <ToolBar />\r\n    <EntryView />\r\n    <EntryListColumnDisplayOrder>0 1 2 3 4</EntryListColumnDisplayOrder>\r\n  </MainWindow>\r\n  <UI>\r\n    <TrayIcon />\r\n    <Hiding />\r\n    <StandardFont>\r\n      <Family>Microsoft Sans Serif</Family>\r\n      <Size>8.25</Size>\r\n      <GraphicsUnit>Point</GraphicsUnit>\r\n      <Style>Regular</Style>\r\n      <OverrideUIDefault>false</OverrideUIDefault>\r\n    </StandardFont>\r\n    <PasswordFont>\r\n      <Family>Courier New</Family>\r\n      <Size>8.25</Size>\r\n      <GraphicsUnit>Point</GraphicsUnit>\r\n      <Style>Regular</Style>\r\n      <OverrideUIDefault>false</OverrideUIDefault>\r\n    </PasswordFont>\r\n    <BannerStyle>WinVistaBlack</BannerStyle>\r\n    <DataEditorFont>\r\n      <Family>Microsoft Sans Serif</Family>\r\n      <Size>8.25</Size>\r\n      <GraphicsUnit>Point</GraphicsUnit>\r\n      <Style>Regular</Style>\r\n      <OverrideUIDefault>false</OverrideUIDefault>\r\n    </DataEditorFont>\r\n    <UIFlags>0</UIFlags>\r\n    <KeyCreationFlags>0</KeyCreationFlags>\r\n    <KeyPromptFlags>0</KeyPromptFlags>\r\n  </UI>\r\n  <Security>\r\n    <WorkspaceLocking>\r\n      <LockOnSuspend>true</LockOnSuspend>\r\n      <LockAfterTime>900</LockAfterTime>\r\n      <LockAfterGlobalTime>240</LockAfterGlobalTime>\r\n    </WorkspaceLocking>\r\n    <Policy />\r\n    <MasterPassword>\r\n      <MinimumLength>0</MinimumLength>\r\n      <MinimumQuality>0</MinimumQuality>\r\n    </MasterPassword>\r\n  </Security>\r\n  <Native />\r\n  <PasswordGenerator>\r\n    <AutoGeneratedPasswordsProfile>\r\n      <GeneratorType>CharSet</GeneratorType>\r\n      <Length>20</Length>\r\n      <CharSetRanges>ULD_______</CharSetRanges>\r\n    </AutoGeneratedPasswordsProfile>\r\n    <LastUsedProfile>\r\n      <Name>(Derive from previous password)</Name>\r\n      <GeneratorType>CharSet</GeneratorType>\r\n      <Length>20</Length>\r\n      <CharSetRanges>ULD_______</CharSetRanges>\r\n    </LastUsedProfile>\r\n    <UserProfiles />\r\n  </PasswordGenerator>\r\n  <Defaults>\r\n    <OptionsTabIndex>0</OptionsTabIndex>\r\n    <SearchParameters>\r\n      <ComparisonMode>InvariantCultureIgnoreCase</ComparisonMode>\r\n    </SearchParameters>\r\n    <KeySources />\r\n  </Defaults>\r\n  <Integration>\r\n    <HotKeyGlobalAutoType>393281</HotKeyGlobalAutoType>\r\n    <HotKeySelectedAutoType>0</HotKeySelectedAutoType>\r\n    <HotKeyShowWindow>393291</HotKeyShowWindow>\r\n    <HotKeyEntryMenu>0</HotKeyEntryMenu>\r\n    <UrlSchemeOverrides>\r\n      <BuiltInOverridesEnabled>1</BuiltInOverridesEnabled>\r\n      <CustomOverrides />\r\n    </UrlSchemeOverrides>\r\n    <ProxyType>System</ProxyType>\r\n  </Integration>\r\n</Configuration>"
}

Deprecated

• GET    /api/v5/rest/GetDaysTillOfflineExpiry