Accessing the REST API
22 August 2024
ID 198537
This section explains how to access the Kaspersky CyberTrace REST API.
REST API endpoint
Kaspersky CyberTrace accepts requests on the endpoint which consists of the IP address of the computer with Kaspersky CyberTrace and the port specified in the GUISettings > HTTPServer > ConnectionString
element of the kl_feed_service.conf configuration file.
The format of the address is:
https://%ENDPOINT%/api/%API_VERSION%/%REQUEST%
For example, if ConnectionString
is 0.0.0.0:104
, and the IP address of the computer with Kaspersky CyberTrace is 192.168.0.2, the lookup request must be made to the following address:
https://192.168.0.2:104/api/1.1/lookup
Request headers
Each request must have the following headers:
- Accept
Response content type. This header must have the
application/json
value. - Authorization
This header must hold the Basic authorization string.
Basic authorization
The credentials for the Basic authorization scheme are constructed as follows:
- The user name and the password are combined with a colon.
For example, if the user name is
user
, and the password ispassword
, the string must beuser:password
. - The resulting string is then base64 encoded.
For the example above, the resulting string is
dXNlcjpwYXNzd29yZA==
. - The final authorization string is constructed by prepending the "Basic" string to the credentials string.
For the example above, the final authorization string is
Basic dXNlcjpwYXNzd29yZA==
.