API v2: Remote Applications¶
Fudo Enterprise enables direct connection over the RDP protocol to a remote application using Remote Applications feature.
Data Structures¶
| Attribute | Type | Required | Description |
|---|---|---|---|
id |
string | Read-only unique object Identifier | |
name |
string | yes | Unique, case insensitive application name |
password_changer_id |
string | yes | Password changer unique identifier assigned to remote app |
path |
string | yes | Path to application executable file |
arguments |
string | Definitions of which object and what property of object to use | |
variables |
object-array | ||
created_at |
datetime | Read-only | |
modified_at |
datetime | Read-only | |
removed |
boolean | Read-only |
Retrieve Available Attributes of the RemoteApplicationsModel¶
Request
| Method | GET |
| Path | /api/v2/objspec/remote_app |
To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.
Get Remote Applications Definitions List¶
Request
| Method | GET |
| Path | /api/v2/remote_app |
Example Request
GET /api/v2/remote_app`
"result": "success",
"remote_app": [
{
"id": "1936547839769313283",
"name": "RemoteApp1",
"path": "/foldername/application1_executable_file",
"created_at": "2022-12-13 02:53:32.427697-08",
"modified_at": "2022-12-13 02:53:32.427697-08"
},
{
"id": "1936547839769313284",
"name": "RemoteApp2",
"path": "/foldername/application2_executable_file",
"created_at": "2022-12-13 02:53:44.722701-08",
"modified_at": "2022-12-13 02:53:44.722701-08" }]
Get Remote Applications Definitions List by ID¶
Request
| Method | GET |
| Path | /api/v2/remote_app/<id> |
Example Request
GET /api/v2/remote_app/<id>`
{
"remote_app": {
"id": "1936547839769313283",
"name": "RemoteApp1",
"path": "/foldername/application1_executable_file",
"created_at": "2022-12-13 02:53:32.427697-08",
"modified_at": "2022-12-13 02:53:32.427697-08"
},
"result": "success"
}
Defining Remote Applications Definition¶
Request
| Method | POST |
| Path | /api/v2/remote_app |
| Headers | Content-Type: Application/json |
| Body | RemoteApplicationsModel |
Example Request
POST /api/v2/remote_app`
curl -s -k -X POST \
-H 'Authorization: sgfeea6jsaz4mum9su8w6' \
-H 'Content-Type: application/json' \
'https://10.0.214.98/api/v2/remote_app' \
-d'{"name":"Putty","password_changer_id":"9115285645797883914","path":"C:\\Windows\\System32\\putty.exe"}'
Response
{
"remote_app": {
"id": "9115285645797883916",
"name": "Putty",
"path": "C:\\Windows\\System32\\putty.exe",
"arguments": null,
"variables": null,
"password_changer_id": "9115285645797883916"
},
"result": "success"
}
Modify Remote Applications Definition¶
Request
| Method | PATCH |
| Path | /api/v2/remote_app/<id> |
| Headers | Content-Type: Application/json |
| Body | RemoteApplicationsModel |
Example Request
PATCH /api/v2/remote_app/<id>`
curl -s -k -X PATCH -H 'Authorization:sgfeea6jsaz4mum9su8w61877n1g06sk' https://10.31.87.227/api/v2/remote_app/9115285645797883916 -H 'Content-Type: application/json' -d'{"name":"Putty","path":"C:\\Windows\\System32\\putty_ext.exe"}'
Response
{
"remote_app": {
"id": null,
"name": "Putty",
"path": "C:\\Windows\\System32\\putty_ext.exe",
"arguments": null,
"variables": null,
"password_changer_id": null
},
"result": "success"
}