API
These documents were last reviewed for sysPass 3.0.0 and may not describe the current release.
Warning: Only 2.0. Work in progress
The sysPass API uses JSON-RPC v2 for messages sharing between the client an server.
The API access URL is “https://server/sysPass/api.php”.
Methods
getAccountSearch
Performs an accounts searching
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| text | Text to search for |
| count | Number of results to display |
| categoryId | Category Id for filtering |
| customerId | Customer Id for filtering |
getAccountData
Gets an account’s details
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| id | Account Id |
| userPass | User’s password that belongs the token |
getAccountPassword
Gets an account’s password
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| id | Account Id |
| tokenPass | API token password |
| details | Get details in the response |
addAccount
Adds a new account
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| tokenPass | API token password |
| name | Account name |
| categoryId | Category Id |
| customerId | Customer Id |
| pass | Password |
| login | Access user |
| url | Access URL or IP |
| notes | Notes for the account |
deleteAccount
Deletes an account
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| id | Account Id |
getCategories
Performs a categories searching
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| name | Name to search for |
| count | Number of results to display |
addCategory
Adds a new category
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| name | Category name |
| description | Description |
deleteCategory
Deletes a category
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| id | Category Id |
getCustomers
Performs a customers searching
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| name | Name to search for |
| count | Number of results to display |
addCustomer
Adds a new customer
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| name | Customer name |
| description | Description |
deleteCustomer
Deletes a customer
| Parameter | Description |
|---|---|
| authToken | User’s API token |
| id | Customer Id |
backup
Performs an application backup
| Parameter | Description |
|---|---|
| authToken | User’s API token |