Atola TaskForce Web API (2024.1)

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

Response samples

Content type
application/json
{
  • "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, IDE1, EXT1
and, for TaskForce 2 only: SATA7, SATA8, SAS7, SAS8, NVME1, NVME2, NVME3, NVME4.

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.

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: 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

Response samples

Content type
text/plain
image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R

Start logical imaging

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
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, IDE1, EXT1
and, for TaskForce 2 only: SATA7, SATA8, SAS7, SAS8, NVME1, NVME2, NVME3, NVME4.

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 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: Default

targetType
boolean

Type of target image file. In can be either L01 or zip.

Default value: L01

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.

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: yes

hash
string

Specifies whether each file inside L01 image should include its hash. Available options: md5, sha1, md5+sha1, none

Default value: md5+sha1

Responses

Response samples

Content type
text/plain
logical_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, port, state, message, progress, completionDate, target, report, hashes }

  • 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
  • port - unit port where a device was plugged in. Example: SATA 3
  • 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
  • hashes - one or two image hashes calculated during imaging
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, IDE1, EXT1
and, for TaskForce 2 only: SATA7, SATA8, SAS7, SAS8, NVME1, NVME2, NVME3, NVME4.

Responses

Response samples

Content type
application/json
{
  • "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": {
    }
}

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

Download report

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

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

Example:

  • image_0_SanDisk%20SDSSDA120G_171108456213_Z32080R

Responses

Response samples

Content type
text/plain
{
  "Content-Disposition": "attachment; filename=taskKey.zip"
}

Show API documentation

Opens this API documentation page.

Responses