Download OpenAPI specification:Download
TaskForce API is based on HTTP GET requests and JSON-encoded responses.
It finds drives plugged into Source ports (i. e. the ports that are currently switched to Source mode) that are not busy by other running tasks. It automatically powers up all non-powered Source devices.
The request returns the number of available scannedSourcePorts
and that of totalSourcePorts
. If scannedSourcePorts
equals to totalSourcePorts
, it means TaskForce powered up and checked all currently available Source ports for devices.
{- "scannedSourcePorts": 9,
- "totalSourcePorts": 13,
- "foundSourceDevices": [
- "SATA4 SanDisk SDSSDA120G 171108456213",
- "SATA2 Samsung SSD 840 PRO Series S1AXNSAF106001H",
- "SATA5 ST500LM012 HN-M500MBB S2RWJ9CD415935",
- "SAS1 DG0146BARTP HPD0 D0A2P9602JFL0923",
- "USB4 WDC WD10JMVW-11AJGS4 WD-WXA1AA6PTY1K"
]
}
Launches imaging from a source drive plugged into the specified Source port into a the specified network target folder. By default, target image is a compressed E01 but the file format can be changed in the parameters.
Two mandatory parameters: source
and targetFolder
. Other parameters have default values, which can be adjusted.
Examples:
http://TASKFORCE_IP/api/start-image?source=SATA4&targetFolder=//Server/Share
http://TASKFORCE_IP/api/start-image?source=SATA4 SDSSDA120G Z32081RL&targetFolder=//10.0.0.14/Share
source required | string Source identifier. It can be specified in two ways: 1) Source port; 2) Source port, drive model and serial Examples:
Acceptable port names are SATA1, SATA2, SATA3, SATA4, SATA5, SATA6, SAS1, SAS2, SAS3, SAS4, SAS5, SAS6, USB1, USB2, USB3, USB4, IDE1, EXT1 |
targetFolder required | string Network folder path where target image is created. Supports Linux and Windows formats of path separators (slashes, backslashes). Examples:
|
targetFile | string Target image file name without extension. If you don`t specify this parameter, target file name will be genereted from source disk model and serial. |
settings | string Name of the customized imaging settings. Customized settings can be created and renamed on the imaging start page (after you select the source and the target(s) in UI). Default value: |
targetType | boolean Type of target image file. In can be either e01 or raw. Default value: |
saveReport | boolean Save report in the target folder alongside with created image file. Default value: |
targetFolderLogin | string Username or login. Used when Empty by default. |
targetFolderPwd | string Password. Used when Empty by default. |
targetFolderDomain | string Network domain. Used when Empty by default. |
e01Case | string Case ID written to E01 image file metadata. Empty by default. |
e01Evid | string Evidence number written to E01 image file metadata. Empty by default. |
e01Desc | string Description written to E01 image file metadata. Empty by default. |
e01Inv | string Examiner/investigator name written to E01 image file metadata. Empty by default. |
e01Comp | boolean Indicates whether E01 target image is compressed. Default value: |
e01Segment | number Specify segment size for E01 file in GB. Minimal segment size is 1GB. Default value: 0 (It means TaskForce will create one E01 file) |
image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R
Launches logical imaging from a source drive plugged into the specified Source port into a the specified network target folder. By default, target image is a compressed L01 but the file format can be changed in the parameters.
Two mandatory parameters: source
and targetFolder
. Other parameters have default values, which can be adjusted.
Examples:
http://TASKFORCE_IP/api/start-logical?source=SATA4&targetFolder=//Server/Share
http://TASKFORCE_IP/api/start-logical?source=SATA4 SDSSDA120G Z32081RL&targetFolder=//10.0.0.14/Share
source required | string Source identifier. It can be specified in two ways: 1) Source port; 2) Source port, drive model and serial Examples:
Acceptable port names are SATA1, SATA2, SATA3, SATA4, SATA5, SATA6, SAS1, SAS2, SAS3, SAS4, SAS5, SAS6, USB1, USB2, USB3, USB4, IDE1, EXT1 |
targetFolder required | string Network folder path where target image is created. Supports Linux and Windows formats of path separators (slashes, backslashes). Examples:
|
targetFile | string Target image file name without extension. If you don`t specify this parameter, target file name will be genereted from source disk model and serial. |
settings | string Name of the logical imaging settings with filters. Customized settings can be created and save on the logical imaging start page. Use 3-dot button in the bottom right corner and "Save to" option. Default value: |
targetType | boolean Type of target image file. In can be either L01 or zip. Default value: |
saveReport | boolean Save report in the target folder alongside with created image file. Default value: |
targetFolderLogin | string Username or login. Used when Empty by default. |
targetFolderPwd | string Password. Used when Empty by default. |
targetFolderDomain | string Network domain. Used when Empty by default. |
l01Case | string Case ID written to L01 image file metadata. Empty by default. |
l01Evid | string Evidence number written to L01 image file metadata. Empty by default. |
l01Desc | string Description written to L01 image file metadata. Empty by default. |
l01Inv | string Examiner/investigator name written to L01 image file metadata. Empty by default. |
compression | boolean Indicates whether target image is compressed. Default value: |
hash | string Specifies whether each file inside L01 image should include its hash. Available options: md5, sha1, md5+sha1, none Default value: |
logical_0_SanDisk%20SDSSDA120G_171108456213_Z32080R
Gets data about the progress of running or completed tasks. Requires taskKey
or source
parameter:
taskKey
value is generated in response to /start-image request.source
value can be specified in two ways: 1) Source port; 2) Source port, drive model and serial.Example:
http://TASKFORCE_IP/api/check-task?taskKey=image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R
http://TASKFORCE_IP/api/check-task?source=SATA5
Returns JSON object: { task, taskStep, source, port, state, message, progress, completionDate, target, report, hashes }
taskKey | string Task identifier. It is generated in response to /start-image request. Either this parameter or source must be specified. Example:
|
source | string Source identifier. It can be specified in two ways: 1) Source port; 2) Source port, drive model and serial. Either this parameter or taskKey must be specified. Examples:
Acceptable port names are SATA1, SATA2, SATA3, SATA4, SATA5, SATA6, SAS1, SAS2, SAS3, SAS4, SAS5, SAS6, USB1, USB2, USB3, USB4, IDE1, EXT1 |
{- "state": "completed",
- "source": "SanDisk SDSSDA120G 171108456213",
- "port": "SATA 4",
- "task": "image",
- "taskStep": "post-hash",
- "message": "completed",
- "completionDate": "2021-12-30 13:30",
- "progress": "100",
- "target": "//Server/share/SanDisk SDSSDA120G171108456213_0.E01",
- "report": "//Server/share/SanDisk SDSSDA120G171108456213_0_E01_report/Report.html",
- "hashes": {
- "MD5": "8ab092155e30c77e02a5708bdb1385e2",
- "SHA1": "47c173429553add911e2686125f9cd702f24ff37"
}
}
Running this request pauses imaging. Corresponding imaging report will be created. Imaging can be restarted in TaskForce user interface.
taskKey
is a mandatory parameter, whose value is generated in response to /start-image request.
Example:
http://TASKFORCE_IP/api/stop-task?taskKey=image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R
taskKey required | string Task identifier. It is generated in response to /start-image request. Example:
|
Downloads all report files and logs of the completed task as a single ZIP.
HTTP response is text/plain with ZIP file attached in Content Disposition header.
taskKey
is a mandatory parameter, whose value is generated in response to /start-image request.
Example:
http://TASKFORCE_IP/api/report?taskKey=image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R
taskKey required | string Task identifier. It is generated in response to /start-image request. Example:
|
{ "Content-Disposition": "attachment; filename=taskKey.zip" }