Skip to main content
Version: v3.4

REST API Documentation

Overview​

A REST API is available for administrators and developers to integrate Vectra's breach detection data into their applications. Vectra RESTful API provides access to security event data, platform configuration, and health information via URI paths.

Vectra REST API is based on open standards. You can use any web development language to access and retrieve information via the API. A common use-case would be to retrieve security event information generated by the Vectra platform and supply this information to a security operations dashboard or incident response and ticketing systems.

The REST API can be accessed via HTTPS connection to the interface IP address of the Vectra brain. The data in the response to the API query is in JSON format.

Examples of security event data that can be integrated into your application:

  • Security event type detected
  • Account information associated with the security event
  • Severity of the Account activities

The Vectra REST API is accessible using OAuth2 authentication.

Security Detection Data​

The "Detections" and "Accounts" elements retrieve security events that can be inserted into external applications. The REST API provides filtering options to extract data. Advanced parsing of the data can be performed after data has been retrieved and saved into your target application. Order of the response data returned is latest first.

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

basic

License