Reference manual

This is the reference document for the F-Secure Radar API. The API targets F-Secure Radar user interface application.

This is the latest API version. However, there is also a stable version for developers working on a third party integration. The F-Secure Radar API is also available as a JSON document (https://{FSecure-Radar-API-hostname}/apidoc/latest/documentation.json) that contains the documentation for each resource in the API.

URI structure

F-Secure Radar API provides access to resources (data entities) via URI paths. By default, the F-Secure Radar API uses JSON as its communication format and standard HTTP methods like GET, PUT, POST, and DELETE , most often in a following way:

Access to most resources via F-Secure Radar API requires user authentication. However there are several API actions that can be performed anonymously.

API channels

F-Secure Radar provide two types of API channels (they may be regarded as two API versions serving different purposes):

latest channel
Up to date API development. May introduce breaking changes without prior notice. Click here to see the documentation.
integration channel
Designated for developers wanting to integrate with F-Secure Radar. Will preserve existing endpoints for a time being if a breaking change is introduced in the 'latest' channel (users will be notified as of 2018-01-01). Click here to see the documentation.

Request headers and parameters

To follow best practices and to ensure that all requests work correctly, apply the following HTTP header to all API requests:

Content-Type: application/json;

The request authentication headers (ApiAccessKey and ApiAccessKey) together with their values are case-sensitive.
The parameter names in the request body are also case-sensitive.

Authentication

F-Secure Radar API uses API keys for authentication. An API key consists of an access key (for example, PA3IAKNANLM9) and a secret key (for example, UO9mkDEHFGa1Vau6o#1AfxwRmBQW@!qV). To create an API key:

  1. Log in to F-Secure Radar.
  2. Select My profile.
  3. Scroll down to the Configure API Keys section.
  4. Add a new API key and store it safely.
  5. Apply the created API key to the HTTP header of every API request that requires authentication.
  6. Run a simple request to check the authentication:
curl -X GET https://api.radar.f-secure.com/api/integration/authenticationcheck
-H 'Content-Type: application/json'
-H 'ApiAccessKey: {ApiAccessKey}'
-H 'ApiSecretKey: {ApiSecretKey}'

Note that access and secret keys in the above request must be replaced with real values. Enclosing braces must be omitted when you submit requests.

If authentication was successful, you will get a HTTP 'Authenticated' response with status code 200.

Above example as well as all sample requests described in use cases are performed towards the integration channel of the API located on https://api.radar.f-secure.com/. If you are using a different channel or instance of F-Secure Radar, replace it with the appropriate server URL.

Use cases

See F-Secure Radar API help page to see example use cases.

Throttle API requests for better throughput

F-Secure Radar throttles API requests to prevent servers from being overwhelmed by too many requests. When request submissions from particular client exceeds the limit, 429 HTTP error message (Too Many Requests) is responsed to client. Response contains 'Retry-After' HTTP header that inform how long to wait before request could be resubmitted.

API documentation

Processing documentation from the source file.

Please wait...