Submission queue size request

Gets the total number of running and queued submissions.

GET https://<address>/wsapis/v2.0.0/submissions/queueSize

Availability

This command is available on the following appliances:

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

GET https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/submissions/queueSize

Request headers:

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

Submission queue size response

HTTP/1.1 [Response Code] [Response Message]
Date: [Date]
 
{"queueSize":int}

Response fields

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

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

Date—Standard HTML date format.
queueSize—Total number of queued and running submissions.

Example

HTTP/1.1 200 OK
Date: Fri, 13 Jul 2018 09:00:00 GMT

{"queueSize":1138}

cURL code sample: submission queue size

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.

curl -qgsSkH --no-progress-bar
--header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-F "options={\"application\":\"2\",\"profiles\":[\"win7-sp1\"],\"analysistype\":\"2\",\"force\":\"true\",\"prefetch\":\"0\"}"
https://xxx.xxx.xxx.xxx:443/wsapis/mvx/v2.0.0/submissions/queueSize

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.
--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/queueSize—The queue size request URL. Replace the IP address xxx.xxx.xxx.xxx with the IP address of your appliance.

Results

This example returns the number of submissions.