API v2: Managing Password Changers and Remote Apps in Accounts ๐ยถ
Account Scriptโrelated endpoints allow you to manage Password Changers and Remote Apps within the Accounts configuration.
Note
If you want to learn how to obtain the IDs of Password Changers and Remote Apps, see the following sections: API v2: Remote Applications, API v2: Password Changers.
Data Structuresยถ
Attribute |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Account Password Changer ID. Read-only, protected, unique object identifier. |
|
|
string |
yes |
Account ID. Immutable. Requires rights to perform operations on the |
|
string |
Password changer ID. Immutable. |
|
|
string |
Remote application ID. Read-only. Expensive to use. |
|
|
string |
yes |
Case insensitive password changer name. Read-only. Expensive to use. |
|
string { |
Type of password changer / verifier. Can be assigned only to accounts of type |
|
|
string |
if |
Transport layer for password changer. Read-only. Expensive to use. |
|
string { |
if |
Path to the executable file of the remote app. Read-only. Expensive to use. |
|
string |
if |
Arguments passed to the remote application as binary data. Read-only. Expensive to use. |
|
number |
if |
Order of execution for password changers. Value range from |
|
number |
Value range from |
|
|
datetime |
Read-only. Timestamp of creation. |
|
|
datetime |
Read-only. Timestamp of modification. |
|
|
boolean |
Read-only. |
Retrieve Available Attributes of the AccountScriptModelยถ
Request
Method |
|
Path |
|
To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.
Get Password Changers and Remote Apps Assigned to Accountsยถ
Request
Method |
|
Path |
|
GET /api/v2/account_script
Example Request
curl -s -k -X GET \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' \
'https://10.0.214.98/api/v2/account_script'
Response
{
"account_script": [
{
"account_id": "5683542729741565961",
"created_at": "2025-06-06 01:00:34.800512-07",
"id": "5683542729741565967",
"modified_at": "2025-06-06 01:00:34.800512-07",
"password_changer_id": "5683542729741565961",
"password_changer_name": "powershell",
"password_changer_type": "remoteapp",
"remote_app_id": "5683542729741565961",
"remote_app_path": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"
},
{
"account_id": "5683542729741565959",
"created_at": "2025-06-06 00:57:09.61763-07",
"id": "5683542729741565965",
"modified_at": "2025-06-06 00:57:09.61763-07",
"password_changer_id": "5683542729741565963",
"password_changer_name": "putty-defined-variables",
"password_changer_type": "remoteapp",
"remote_app_arguments": "-l %%login%% -pw %%password%% -P %%port%% %%host%%",
"remote_app_id": "5683542729741565963",
"remote_app_path": "C:\\Windows\\System32\\putty.exe"
},
{
"account_id": "5683542729741565959",
"created_at": "2025-06-06 00:57:09.628782-07",
"id": "5683542729741565966",
"modified_at": "2025-06-06 00:57:09.628782-07",
"password_changer_id": "5683542729741565964",
"password_changer_name": "tightvnc",
"password_changer_type": "remoteapp",
"remote_app_id": "5683542729741565964",
"remote_app_path": "C:\\Program Files\\TightVNC\\tvnviewer.exe"
}
],
"result": "success"
}
Get Password Changer or Remote App Assigned to an Account by Assignment IDยถ
Request
Method |
|
Path |
|
GET /api/v2/account_script/<id>
Example Request
curl -s -k -X GET \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' \
'https://10.0.214.98/api/v2/account_script/5683542729741565967'
Response
{
"account_script": {
"id": "5683542729741565967",
"account_id": "5683542729741565961",
"password_changer_id": "5683542729741565961",
"remote_app_id": "5683542729741565961",
"password_changer_type": "remoteapp",
"password_changer_name": "powershell",
"remote_app_path": "C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe",
"variables": [ ],
"created_at": "2025-06-06 01:00:34.800512-07",
"modified_at": "2025-06-06 01:00:34.800512-07"
},
"result": "success"
}
Assign Password Changer or Remote App to an Accountยถ
Request
Method |
|
Path |
|
Headers |
|
Body |
|
POST /api/v2/account_script
Example Request
curl -s -k -X POST \
-H 'Authorization:sgfeea6jsaz4mum9su8w61877n1g06sk' \
-H 'Content-Type: application/json' \
https://10.31.96.188/api/v2/account_script \
-d'{"account_id": "5683542729741565961","remote_app_id": "5683542729741565957"}'
Response
{
"account_script": {
"id": "5683542729741565970"
},
"result": "success"
}
Modify Password Changer or Remote App Assignment for an Accountยถ
Request
Method |
|
Path |
|
Headers |
|
Body |
|
PATCH /api/v2/account_script/<id>
Example Request
curl -s -k -X PATCH \
-H 'Authorization:sgfeea6jsaz4mum9su8w61877n1g06sk' \
-H 'Content-Type: application/json' \
https://10.31.96.188/api/v2/account_script/5683542729741565969 \
-d'{"account_id": "5683542729741565961","remote_app_id": "5683542729741565957"}'
Response
{
"result": "success"
}
Delete Password Changer or Remote App Assignment from an Accountยถ
Request
Method |
|
Path |
|
DELETE /api/v2/account_script/<id>
Example Request
curl -s -k -X DELETE \
-H 'Authorization:sgfeea6jsaz4mum9su8w61877n1g06sk' \
https://10.31.96.188/api/v2/account_script/5683542729741565970
Response
{
"result": "success"
}