PasswordToolbox

GET /api/v1/generatePassword

Generate a random password

Information

Generates a random password which adheres to the supplied constraints. For passwords up to 50 characters the phonetic equivalent is included in the response.

Response Formats	JSON
Authentication	No

Parameters

Name	Requirement	Description	Example Values
length	Mandatory	The length of the password to generate in characters.	20
upper	Mandatory	true to include upper case letters (A-Z) in the generated password, or false to exclude upper case letters.	true/false
lower	Mandatory	true to include lower case letters (a-z) in the generated password, or false to exclude lower case letters.	true/false
number	Mandatory	true to include numbers (1-9) in the generated password, or false to exclude numbers.	true/false
punctuation	Mandatory	true to include punctuation characters (!"$%) in the generated password, or false to exclude punctuation characters.	true/false

Example Request

curl -k 'https://www.passwordtoolbox.com/api/v1/generatePassword?length=16&upper=true&lower=true&number=true&punctuation=true'

Example Response

{"password":"hiu-zT-~t0i#%bES", "phonetic":["hotel","india","uniform","-","zulu","TANGO","-","~","tango","zero","india","#","%","bravo","ECHO","SIERRA"]}

GET /api/v1/generatePhonetic

Convert any phrase to phonetics

Information

Converts any phrase up to 50 characters to phonetics.

Response Formats	JSON
Authentication	No

Parameters

Name	Requirement	Description	Example Values
phrase	Mandatory	The phrase to convert to phonetics.	hiu-zT-~t0i#%bES

Example Request

curl -k 'https://www.passwordtoolbox.com/api/v1/generatePhonetic?phrase=hiu-zT-~t0i#%bES'

Example Response

{"phrase":"hiu-zT-~t0i#%bES", "phonetic":["hotel","india","uniform","-","zulu","TANGO","-","~","tango","zero","india","#","%","bravo","ECHO","SIERRA"]}

GET /api/v1/version

Gets the application version

Information

Gets the current version information.

Response Formats	JSON
Authentication	No

Example Request

curl -k 'https://www.passwordtoolbox.com/api/v1/version'

Example Response

{"buildTimestamp":"2014-12-09 22:49","version":"2.2.12"}

GET /api/v1/secure/entries

Gets an array of entries

Information

Gets all entities.

Response Formats	JSON
Authentication	Yes

Example Request

curl -k --user name:password 'https://www.passwordtoolbox.com/api/v1/secure/entries'

Example Response

{ [ ... ] }

GET /api/v1/secure/entries/{id}

Get a single entry

Information

Gets an individual entity.

Response Formats	JSON
Authentication	Yes

Example Request

curl -k --user name:password 'https://www.passwordtoolbox.com/api/v1/secure/entries/e39e22ae-2363-4fa9-9904-28f4de31a377'

Example Response

{ id: "e39e22ae-2363-4fa9-9904-28f4de31a377" ... }

PUT /api/v1/secure/entries/{id}

Create or update a single entry

Information

Creates or updates an individual entity.

Response Formats	JSON
Authentication	Yes

Example Request

curl -X PUT -k --user name:password -d '{ id: "e39e22ae-2363-4fa9-9904-28f4de31a377" ... }' 'https://www.passwordtoolbox.com/api/v1/secure/entries/e39e22ae-2363-4fa9-9904-28f4de31a377'

Example Response

{ id: "e39e22ae-2363-4fa9-9904-28f4de31a377" ... }

DELETE /api/v1/secure/entries/{id}

Delete a single entry

Information

Deletes an individual entity.

Response Formats	JSON
Authentication	Yes

Example Request

curl -X DELETE -k --user name:password 'https://www.passwordtoolbox.com/api/v1/secure/entries/e39e22ae-2363-4fa9-9904-28f4de31a377'

Example Response

{ id: "e39e22ae-2363-4fa9-9904-28f4de31a377" ... }

GET /api/v1/secure/document

Gets the user's document

Information

Get the current document in its entirety.

Response Formats	JSON
Authentication	Yes

Example Request

curl -k --user name:password 'https://www.passwordtoolbox.com/api/v1/secure/document'

Example Response

{ "entries": [ ... ] }

PUT /api/v1/secure/document

Updates the user's document

Information

Updates the entire document.

Response Formats	JSON
Authentication	Yes

Example Request

curl -X PUT -k --user name:password -d '{ "entries": [ ... ] }'  'https://www.passwordtoolbox.com/api/v1/secure/document'

Example Response

{"success": true}

API

Tools

Information

Parameters

Example Request

Example Response

Information

Parameters

Example Request

Example Response

Information

Example Request

Example Response

Entries

Information

Example Request

Example Response

Information

Example Request

Example Response

Information

Example Request

Example Response

Information

Example Request

Example Response

Document

Information

Example Request

Example Response

Information

Example Request

Example Response