Submission status request

Checks the status of submissions.

Central Management System and Malware Analysis:

GET https://<address>/wsapis/[v2.0.0]/submissions/status/<Submission_Key>

This command is available on the following appliances:

Central Management System
Malware Analysis

Required headers:

X-FeApi-Token: [API-Token]X-FeClient-Token: [Client-Token]

Parameters

address—The IP address of the appliance running the Web Services API.
Submission Key—Provided by your appliance during the submission process, this key identifies the unique file submitted for analysis.
API-Token—This token authenticates the session. By default, the session times out after 15 minutes of inactivity.
Client-Token—(Optional) This client token is provided by Trellix. For more information about the client token, contact your sales representative.

Example request

Central Management System:

GET https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/submissions/status/3831_5

Malware Analysis:

GET https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/submissions/status/7709

Request headers:

X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
X-FeClient-Token: BigDataInc

Submission status response

After the Central Management System appliance receives the submission status request, it forwards the submission request to the managed appliance. The managed appliance analyzes the malware object and produces a malware object report. This report can be retrieved using the submission results request.

HTTP/1.1 [Response Code] [Response Message]
Date: [Date]

Body:

[Status Message]

Response fields

Response Code—A standard HTML response code.
- 200—Request successful.
- 401—Request unsuccessful because the session token was incorrect.
- 404—Request unsuccessful because the submission key was incorrect.

Response Message—A standard HTML response message.
- OK—Request successful.
- Unauthorized—Request unsuccessful because the session token was incorrect.
- Not Found—Request unsuccessful because the submission key was incorrect.

Date—Standard HTML date format.
Status Message—Provides the status of the file analysis. The format is either JSON or XML.
- Submission not found.
- In Progress.
- Done.

Examples

HTTP/1.1 200 OK
Date: Fri, 17 Nov 2017 08:00:00 GMT
{"submissionStatus":"In Progress"}

HTTP/1.1 200 OK
Date: Fri, 17 Nov 2017 08:00:00 GMT
{"submissionStatus":"Done"}

HTTP/1.1 200 OK
Date: Fri, 17 Nov 2017 08:00:00 GMT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<submissionStatus>
   <submissionStatus>In Progress</submissionStatus>
</submissionStatus>

HTTP/1.1 200 OK
Date: Fri, 17 Nov 2017 08:00:00 GMT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<submissionStatus>
  <submissionStatus>Done</submissionStatus>
</submissionStatus>

cURL code sample: submission status

The following code samples can be copied and executed from any command-line interface that includes the cURL library. This sample builds on the authentication cURL code sample.

Note

In this sample, line breaks are added for readability. Remove these line breaks before you paste the code sample into your command-line tool.

Central Management System:

curl -qgsSkH "Content-Type: multipart/form-data"
--no-progress-bar
--header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/submissions/status/3831_5

This cURL sample includes the following options:

-q—This option specifies that the curlrc config file is not read or used. Although this is an optional setting, Trellix recommends that you include this option.
-g—This option turns off the URL globbing parser. Although this is an optional setting, Trellix recommends that you include this option.
-s—This option turns off the progress meter and error message. Although this is an optional setting, Trellix recommends that you include this option.
-S—When used with the -s option, this option shows error messages if your cURL switch fails. Although this is an optional setting, Trellix recommends that you include this option.
-k—This option explicitly allows cURL to perform insecure SSL connections and transfers. This allows you to test your SSL connection without installing a CA certificate.
-H—This switch allows you to specify a custom header with the --header switch.
Content-Type: multipart/form-data—This option encodes the data as a multipart form.
--no-progress-bar—This option suppresses the cURL download progress bar, which can interfere with the request.
--header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"—This custom header includes the API-Token that was returned by your appliance during the authentication request. In the authentication cURL code sample, this token was included in the auth.txt file. Replace the token in the sample with the token received in the response to your authentication request.
https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/submissions/status/3831_5—(Central Management System) The submission request URL. Replace the IP address xxx.xxx.xxx.xxx with the IP address of your appliance. Replace 415_75 with the submission key of interest.
https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/submissions/status/415—(Malware Analysis appliances) The submission request URL. Replace the IP address xxx.xxx.xxx.xxx with the IP address of your appliance. Replace 415 with the submission key of interest.

Results

The requested submission returns one of two status responses:

In Progress
Done

When the status changes from In Progress to Done, you can then retrieve the submission results.