Lookup request for web address

Expand all | Collapse all

The endpoint is used to display specific information for a web address.

Request

Request method: GET

Endpoint: https://tip.kaspersky.com/api/url/<request>

Query parameters:

Expected parameters

Parameter

Description

request

Web address that you want to investigate. Use percent-encoding (URL encoding) to convert certain characters into a valid ASCII format.

For a web address, it's length is limited to a maximum of 2000 characters. If the requested web address length exceeds the limit, an HTTP error 414 (URI Too Long) is returned.

count

Maximum number of records in each data group to display.

If this parameter is not specified, up to 1000 records will be displayed. This restriction does not apply to DetectionsInfo and FileParentCertificates groups. For these groups all records are displayed regardless of the number of records.

sections

Sections that you want to investigate for the requested web address. Use the comma to specify several sections.

format

Investigation result format.

Optional parameter.

Available values:

json—Investigation results are returned in JSON format.

stix—Investigation results are returned in STIX format. If this value is specified, the count and sections parameters are ignored: data from all groups is returned.

If the format parameter is not specified, investigation results are returned in JSON format.

Use the question mark (?) to separate the first parameter from the request. Use the ampersand (&) to separate parameters from each other. The parameters can be specified in any order.

Dates in all sections are displayed in Coordinated Universal Time (UTC) format.

Key values are case-sensitive.

Request examples:

Investigate Zone, UrlGeneralInfo, FilesAccessed, FilesDownloaded, and UrlReferrals sections for the web address atomictrivia.ru/atomic.php:

curl --cert <file name>.pem --user <user name> https://tip.kaspersky.com/api/url/atomictrivia.ru/atomic.php?sections=Zone,UrlGeneralInfo,FilesAccessed,FilesDownloaded,UrlReferrals&count=10&format=stix

Run the same request by using an API token:

curl -H "Authorization: Bearer <API token>" https://tip.kaspersky.com/api/url/atomictrivia.ru/atomic.php?sections=Zone,UrlGeneralInfo,FilesAccessed,FilesDownloaded,UrlReferrals&count=10&format=stix

Responses

200 OK

401 Unauthorized

402 License Expired

403 Forbidden

451 Unavailable For Legal Reasons

Page top