Get list of web address browsing tasks

Expand all | Collapse all

The /sandbox/tasks/url endpoint is used to obtain a list of tasks for the web address.

Request

Request method: GET

Endpoint: https://tip.kaspersky.com/api/sandbox/tasks/url

Query parameters:

Expected parameters

Parameter	Description
status	Task state. Optional parameter. If this parameter is not specified, information about active tasks is returned. Available values: `all`—All tasks. `active`—Tasks with one of the following statuses: `in-progress`—Task is running. `completed`—Process completed successfully. `completed-with-errors`—Error occurred during the web address browsing, but the task is completed. `failed`—Failed to complete the task. The `active` variable is used by default.
count	Maximum number of entries to return. Optional parameter. If this parameter is not specified, information about 2000 object execution tasks is returned.

Parameter

Description

status

Task state.

Optional parameter. If this parameter is not specified, information about active tasks is returned. Available values:

all—All tasks.

active—Tasks with one of the following statuses:

in-progress—Task is running.
completed—Process completed successfully.
completed-with-errors—Error occurred during the web address browsing, but the task is completed.
failed—Failed to complete the task.

The active variable is used by default.

count

Maximum number of entries to return.

Optional parameter. If this parameter is not specified, information about 2000 object execution tasks is returned.

Request example:

To get a list of tasks for browsed web addresses:

curl -u <user name> --cert <full path to the certificate on your computer> -X GET 'https://tip.kaspersky.com/api/sandbox/tasks/url'

Responses

200 OK

Request processed successfully.

Endpoint returns a JSON object that contains parameters of all user's tasks.

200 OK response parameters

Parameter	Description
id	Task ID.
created	Date and time when the task was created, specified in the UNIX time stamp system (the number of seconds that have elapsed since 00:00:00 (UTC), 1 January 1970).
state	Task state. Available values: `in-progress`—Task is in progress. `completed`—Task is successfully completed. `completed-with-error`—Error occurred, but the task is completed. `error`—Error occurred.
url	Web address information. `link`—Submitted web address. `zone`—Zone of the web address. Available values: `red`—Task completed. The web address belongs to the red zone (dangerous). `orange`—Task completed. The web address belongs to the orange zone (there are Adware and other objects related to the web address). `yellow`—Task completed. The web address belongs to the yellow zone. `green`—Task completed. The web address belongs to the green zone (not dangerous). `gray`—Task completed. The web address belongs to the gray zone, no information about the web address is available. `null`—Task completed with error. `status`—Status of the web address. Available values: `dangerous`—Task completed. There are malicious objects related to the web address. `adware-and-other`—Task completed. There are objects related to the web address, which be classified as Not-a-virus. `not-trusted`—Task completed. The web address is categorized as Infected or Compromised. `good`—Task completed. The web address is not malicious. `not-categorized`—Task completed. No or not enough information about the web address is available to define the category. `null`—Task completed with error. `has_apt`—Boolean parameter. Indicates whether the web address is related to an advanced persistent threat (APT) attack.

Response sample

401 Unauthorized

403 Forbidden

451 Unavailable For Legal Reasons

Page top