API v2: Session SCP File 🆕¶

Data Structures¶

`ScpFileModel`¶
Attribute	Type	Description
`id`	string	Read-only. Unique identifier.
`session_id`	string	Read-only. Identifier of the session to which the file transfer belongs.
`filename`	string	Read-only. Name of the file.
`file_size`	number	Read-only. Size of the file, in bytes.
`file_origin`	string	Read-only. Origin of the file. Can be either `client` or `server`.
`current_node`	string	Read-only. Indicates if the file is available on the current node.
`created_at`	datetime	Read-only. Timestamp of file registration.

Retrieve Available Attributes of the ScpFileModel¶

Request

Method	`GET`
Path	`/api/v2/objspec/scp_file`

GET /api/v2/objspec/scp_file

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/scp_file'

Get SCP File Transfer List for a Session¶

Request

Method	`GET`
Path	`/api/v2/session/<session_id>/scp_file`

GET /api/v2/session/<session_id>/scp_file

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/session/8673932882315575319/scp_file'

Response

{
    "scp_file": [
        {
            "id": "0",
            "session_id": "8673932882315575319",
            "filename": "export_import_configuration.txt",
            "file_size": 307175,
            "file_origin": "client",
            "current_node": true,
            "created_at": "2025-07-19 09:26:33.605208-07"
        }
    ],
    "result": "success"
}

Download SCP File Content by Session and File ID¶

Request

Method	`GET`
Path	`/api/v2/session/<session_id>/scp_file/<id>`

GET /api/v2/session/<session_id>/scp_file/<id>

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/session/8673932882315575319/scp_file/0'

Response

SCP file content.

Note

The endpoint returns raw file content. The response body contains the plain contents of the file identified by file <id>.