Atola TaskForce web API (1.0.2)

Download OpenAPI specification:Download

TaskForce API is based on HTTP GET requests and JSON-encoded responses.

Get available Source drives

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.

Max number of Source ports: 18. You can put each port into Source mode by turning on the Source switch of the port.

Responses

200

OK

400

Bad request. Any unexpected error. Error message returned as HTTP message body.

408

Timeout. The request took too long. Make sure TaskForce and/or the device from which it is operated are connected to the network.

get /scan-devices
http://taskforce_ip/api/scan-devices

Response samples

application/json
Copy
Expand all Collapse all
{
  • "scannedSourcePorts": 9,
  • "totalSourcePorts": 13,
  • "foundSourceDevices":
    [
    ]
}

Start imaging

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
query Parameters
source
required
string

Source identifier. It can be specified in two ways: 1) Source port; 2) Source port, drive model and serial

Examples:

  • Source port: SATA4
  • Source port, drive model and serial: SATA4 SanDisk SDSSDA120G 171108456213

Acceptable port names are SATA1, SATA2, SATA3, SATA4, SATA5, SATA6, SAS1, SAS2, SAS3, SAS4, SAS5, SAS6, USB1, USB2, USB3, USB4, IDE, EXT

targetFolder
required
string

Network folder path where target image is created. Supports Linux and Windows formats of path separators (slashes, backslashes).

Examples:

  • //10.0.0.14/Share
  • //MyServer/Shared-folder
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: Default

targetType
boolean

Type of target image file. In can be either e01 or raw.

Default value: e01

saveReport
boolean

Save report in the target folder alongside with created image file.

Default value: yes

targetFolderLogin
string

Username or login. Used when targetFolder points to a password-protected network path.

Empty by default.

targetFolderPwd
string

Password. Used when targetFolder points to a password-protected network path.

Empty by default.

targetFolderDomain
string

Network domain. Used when targetFolder points to a password-protected network path.

Empty by default.

e01Case
string

Case ID 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 wheter E01 target image is compressed.

Default value: yes

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)

Responses

200

OK. Returns taskKey if imaging starts successfully.

Use this taskKey to track imaging via /api/check-task. Example:
/api/check-task?taskKey=image_0_SanDisk%20SDSSDA120G_171108456213_Z32081RL

400

Bad request. Any unexpected error. Error message returned as HTTP message body.

403

Forbidden. Incorrect network path or its credentials. Check whether you specified an existing network path, valid login and password to access a remote shared folder.

408

Timeout. The request took too long. Check network connection with TaskForce.

get /start-image
http://taskforce_ip/api/start-image

Response samples

text/plain
Copy
image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R

Check task status

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, state, message, progress, completionDate, target, report }

  • state - completed, failed, paused or stopped
  • task - name of the task. Example: image
  • taskStep - a stage of the imaging task. It can be: pre-hash, image, post-hash
  • source - source device model and serial
  • progress - shown in percents. If state=failed, then progress=-1
  • message - additional information
  • completionDate - completion date and time of the task
  • target - file path to the network target image
  • report - file path to the network imaging report
query Parameters
taskKey
string

Task identifier. It is generated in response to /start-image request. Either this parameter or source must be specified.

Example:

  • image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R
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:

  • Source port: SATA4
  • Source port, drive model and serial: SATA4 SanDisk SDSSDA120G 171108456213

Acceptable port names are SATA1, SATA2, SATA3, SATA4, SATA5, SATA6, SAS1, SAS2, SAS3, SAS4, SAS5, SAS6, USB1, USB2, USB3, USB4, IDE, EXT

Responses

200

OK

400

Bad request. Any unexpected error. Error message returned as HTTP message body.

408

Timeout. The request took too long. Check network connection with TaskForce.

get /check-task
http://taskforce_ip/api/check-task

Response samples

application/json
Copy
Expand all Collapse all
{
  • "state": "completed",
  • "source": "SanDisk SDSSDA120G 171108456213",
  • "task": "image",
  • "taskStep": "post-hash",
  • "message": "completed",
  • "completionDate": "2019-12-30 13:30",
  • "progress": "100",
  • "target": "//Server/share/SanDisk SDSSDA120G171108456213_0.E01",
  • "report": "//Server/share/SanDisk SDSSDA120G171108456213_0_E01_report/Report.html"
}

Stop running task

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
query Parameters
taskKey
required
string

Task identifier. It is generated in response to /start-image request.

Example:

  • image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R

Responses

200

OK

400

Bad request. Any unexpected error. Error message returned as HTTP message body.

408

Timeout. The request took too long. Make sure TaskForce and/or the device from which it is operated are connected to the network.

get /stop-task
http://taskforce_ip/api/stop-task

Show API documentation

Opens this API documentation page.

Responses

200

OK

get /help
http://taskforce_ip/api/help