API v2: Downloads

The Fudo Enterprise allows for tracking the conversion progress of session recordings and files transferred during SFTP sessions, previously selected for download.

Note

The Files section is designated for managing the downloads of large files that originate from recorded sessions via the SFTP protocol. If the selected file exceeds the 50 MB threshold, it undergoes an encoding process and subsequently appears in the Files tab, ready for download. Files smaller than 50 MB are directly downloaded through the browser without encoding.


Data Structures

SessionFileModel
Attribute Type Required Description
id string   Unique and read-only object Identifier
session_id string   Read-only. ID of the session to download.
encode_on string   Read-only. Node on which file was encoded.
handle number   Read-only.
delta number   Read-only.
from_server boolean   Read-only.
error string   Read-only. Error when file is not ready for download.
size number   Read-only. Size of downloaded session file in bytes.
session_user string   Read-only. Expensive. Session user name.
session_user_id string   Read-only. Expensive. Session user id.
session_server string   Read-only. Expensive. Session server name.
session_server_id string   Read-only. Expensive. Session server id.
session_started string   Read-only. Expensive. Timestamp. Time when session started.
is_converted boolean   Read-only. Expensive. Encoding is complete and file is ready to download.
progress number   Read-only. Expensive. Progress of session conversion in percentage.
encode_on_name string   Read-only. Expensive. Node name on which session was encoded.

Request for retrieving available attributes of the SessionFileModel

Method 
GET
Path 
/api/v2/objspec/session_file
SessionMovieModel
Attribute Type Required Description
id string   Unique and read-only object Identifier
session_id string   Read-only. ID of the session to download.
encode_on string   Read-only. Node on which session was encoded.
video_resolution string {auto, hd480, hd720, hd1080}   Read-only.
video_format string {divx5, fbsdir, flv, mjpeg, mpeg2, pcap, text, webm, xvid}   Read-only.
size number   Read-only. Size of downloaded session file in bytes.
session_user string   Read-only. Expensive. Session user name.
session_user_id string   Read-only. Expensive. Session user id.
session_server string   Read-only. Expensive. Session server name.
session_server_id string   Read-only. Expensive. Session server id.
session_started string   Read-only. Expensive. Timestamp. Time when session started.
is_converted boolean   Read-only. Expensive. Encoding is complete and file is ready to download.
progress number   Read-only. Expensive. Progress of session conversion in percentage.
encode_on_name string   Read-only. Expensive. Node name on which session was encoded.
created_at string   Read-only. Timestamp of creation.
modified_at string   Read-only. Timestamp of modification.
removed boolean   Read-only.

Request for Retrieving Available Attributes of the SessionMovieModel

Method 
GET
Path 
/api/v2/objspec/session_movie

Note

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.

The next chapter describes procedures for creating separate requests.


Retrieving Session Files List

Request

Method 
GET
Path 
/api/v2/session_file

Example Request

Sending GET https://10.0.0.0/api/v2/session_file

curl -s -k -X GET -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/session_file'

Response

{
    "result": "success",
    "session_file": [
        {
            "id": "1",
            "session_id": "5620492334958379016",
            "encode_on": "82984746",
            "handle": 1,
            "from_server": true,
            "size": 56622199,
            "session_user": "User_1",
            "session_user_id": "5620492334958379010",
            "session_server": "SSH_FTP",
            "session_server_id": "5620492334958379018",
            "session_started": "2024-06-25 02:43:38.152033-07",
            "is_converted": true,
            "progress": 100
        }
    ]
}

Retrieving Session Recordings List

Request

Method 
GET
Path 
/api/v2/session_movie

Example Request

Sending GET https://10.0.0.0/api/v2/session_movie

curl -s -k -X GET -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/session_movie'

Response

{
    "result": "success",
    "session_movie": [
        {
            "id": "5620492334958379009",
            "session_id": "5620492334958379015",
            "encode_on": "82984746",
            "video_resolution": "auto",
            "video_format": "fbsdir",
            "size": 2399446,
            "session_user": "User_1",
            "session_user_id": "5620492334958379010",
            "session_server": "SSH_FTP",
            "session_server_id": "5620492334958379018",
            "session_started": "2024-06-25 02:25:26.670768-07",
            "is_converted": true,
            "progress": 100,
            "created_at": "2024-06-25 02:41:07.835711-07",
            "modified_at": "2024-06-25 02:41:08.047049-07"
        },
        {
            "id": "5620492334958379010",
            "session_id": "5620492334958379017",
            "encode_on": "82984746",
            "video_resolution": "auto",
            "video_format": "divx5",
            "size": 3108346,
            "session_user": "User_1",
            "session_user_id": "5620492334958379010",
            "session_server": "RDP_SERVER",
            "session_server_id": "5620492334958379011",
            "session_started": "2024-06-25 03:03:46.780874-07",
            "is_converted": true,
            "progress": 100,
            "created_at": "2024-06-25 03:04:10.370597-07",
            "modified_at": "2024-06-25 03:04:17.472475-07"
        }
    ]
}

Downloading Session Files

Request

Method 
GET
Path 
/api/v2/download/session_file/<id>

Example Request

Sending GET https://10.0.0.0/api/v2/download/session_file/1

curl -s -k -X GET -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/download/session_file/1'

Response

File download is starting.

Downloading Session Recordings

Request

Method 
GET
Path 
/api/v2/download/session_movie/<id>

Example Request

Sending GET https://10.0.0.0/api/v2/download/session_movie/1

curl -s -k -X GET -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' 'https://10.0.214.98/api/v2/download/session_movie/1'

Response

Session recording download is starting.

Deleting Session File

Request

Method 
DELETE
Path 
/api/v2/session_file/<id>

Example Request

Sending DELETE https://10.0.0.0/api/v2/session_file/1

curl -s -k -X DELETE -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' https://10.0.214.98/api/v2/session_file/1

Response

{
    "result": "success"
}

Deleting Session Recording

Request

Method 
DELETE
Path 
/api/v2/session_movie/<id>

Example Request

Sending DELETE https://10.0.0.0/api/v2/session_movie/1

curl -s -k -X DELETE -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' https://10.0.214.98/api/v2/session_movie/1

Response

{
    "result": "success"
}