How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vectra AI Detections API

Dedicated endpoint to Detections.

Vectra AI Detections API is one of 18 APIs that Vectra AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Detections. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 17 operations across 10 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{fqdn}/api/{apiVersion}, https://{vectra_portal_url}/api/v3.3.

17 operations 10 paths 29 schemas 1 DELETE10 GET4 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://platform.vectra.ai/api/v3.3
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Vectra AI Detections API declares 2 security schemes for authenticating requests. An API key is passed in the header as authorization (VectraToken). It supports OAuth 2.0 (oauth2) using the clientCredentials flow.

Paths & Operations 17

Across 10 paths, the API surfaces 17 operations — 1 DELETE, 10 GET, 4 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Detections 17

Dedicated endpoint to Detections.

GET
/detections
Get all detections
detectionGetSeveral 27 params → 200401403
PATCH
/detections
Mark/Unmark several Detections as fixed
detectionMarkSeveral body → 200401403
GET
/detections/{detectionID}
Describe a specific detection
detectionGetSingle 2 params → 200401403404
GET
/detections/{detectionID}/notes
Get all Detection notes
detectionNotesGetSeveral 1 param → 200401403
POST
/detections/{detectionID}/notes
Create a new Detection note
detectionNoteCreate 1 param body → 200401403
GET
/detections/{detectionID}/notes/{noteID}
Get a single Detection note
detectionNoteGetSingle 2 params → 200401403
PATCH
/detections/{detectionID}/notes/{noteID}
Update an existing Detection note
detectionNoteUpdate 2 params body → 200401403
DELETE
/detections/{detectionID}/notes/{noteID}
Delete an existing Detection note
detectionNoteDelete 2 params → 200401403
GET
/detections/{detectionID}/pcap
Download a Detection PCAP
detectionDownloadPCAP 1 param → 200401403
GET
/search/detections
Search for Detections
searchDetections 3 params → 200401403
GET
/tagging/detection/{detectionID}
Get all Detection's tags
detectionTagsGetAll 1 param → 200401403
PATCH
/tagging/detection/{detectionID}
Replace all Detection's tags
detectionTagsReplace 1 param body → 200401403
GET
/detections/{detection_id}
Retrieve a single detection event
getDetectionById 1 param → 200
PATCH
/detections/{detection_id}
Mark detection as fixed
markDetectionAsFixed 1 param body → 204
GET
/detections/{id}/pcap
Download PCAP data for detection
getPCAP 1 param → 200
GET
/detections/{id}/notes
Get detection notes
getDetectionsByIdNotes 1 param → 200
POST
/detections/{id}/notes
Add note to detection
postDetectionsByIdNotes 1 param body → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are detection (40 properties), Detection (9 properties), Note (6 properties), note (6 properties). Each schema is shown below with its type and property counts.

detectionMarkRequestBody
object
2 properties 2 required
name
string
tags
object
3 properties
arrayOfIDs
array
Array of IDs
groupType
string
arrayOfNames
array
Array of names
ID
integer
ID
positiveInt
integer
resultsOfDetections
detectionCategory
string
isoDate
string
ISO representation of a date
queryDetectionCategory
string
error
object
2 properties
detection
object
40 properties
tagsRequestBody
object
1 property 1 required
port
integer
link
stringnull
URL Link
detectionType
string
vectraScore
number
queryDetectionFields
array
IP
string
IP Address
noteRequestBody
object
1 property 1 required
results
object
3 properties
note
object
6 properties
text
string
booleanString
string
state
string
Note
object
6 properties
Detection
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vectranetworks-detections-api-openapi.yml Raw ↑

Other APIs Vectra AI publishes across the network.

Vectra AI Accounts API
Vectra AI Assignment Outcomes API
Vectra AI Assignments API
Vectra AI Entities API
Vectra AI Events API
Vectra AI Groups API
Vectra AI Health API
Vectra AI Hosts API
Vectra AI Lockdown API
Vectra AI Match API
Vectra AI Notes API
Vectra AI Proxies API
Where this information came from

This is an independent, third-party profile of Vectra AI Detections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.