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 Notes API

Manage entities notes

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

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

This API exposes 15 operations across 6 paths, and defines 7 schemas. It is described by OpenAPI 3.0.2, at version 1.0.0.

Requests are made against a single base URL, https://{fqdn}/api/{apiVersion}.

15 operations 6 paths 7 schemas 3 DELETE6 GET3 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.0
Base URL
https://platform.vectra.ai/api/v3.3
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Vectra AI Notes API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (VectraToken). By default, every request must be authenticated.

Paths & Operations 15

Across 6 paths, the API surfaces 15 operations — 3 DELETE, 6 GET, 3 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Notes 15

Manage entities notes

GET
/accounts/{accountID}/notes
Get all account notes
accountNotesGetSeveral 1 param → 200401403
POST
/accounts/{accountID}/notes
Create a new Account note
accountNoteCreate 1 param body → 200401403
GET
/accounts/{accountID}/notes/{noteID}
Get a single Account note
accountNoteGetSingle 2 params → 200401403
PATCH
/accounts/{accountID}/notes/{noteID}
Update an existing Account note
accountNoteUpdate 2 params body → 200401403
DELETE
/accounts/{accountID}/notes/{noteID}
Delete an existing Account note
accountNoteDelete 2 params → 200401403
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
/hosts/{hostID}/notes
Get all Host notes
hostNotesGetSeveral 1 param → 200401403
POST
/hosts/{hostID}/notes
Create a new Host note
hostNoteCreate 1 param body → 200401403
GET
/hosts/{hostID}/notes/{noteID}
Get a single Host note
hostNoteGetSingle 2 params → 200401403
PATCH
/hosts/{hostID}/notes/{noteID}
Update an existing Host note
hostNoteUpdate 2 params body → 200401403
DELETE
/hosts/{hostID}/notes/{noteID}
Delete an existing Host note
hostNoteDelete 2 params → 200401403

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are note (6 properties), error (2 properties), noteRequestBody (1 property). Each schema is shown below with its type and property counts.

isoDate
string
ISO representation of a date
note
object
6 properties
name
string
error
object
2 properties
noteRequestBody
object
1 property 1 required
ID
integer
ID
text
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vectranetworks-notes-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 Detections 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 Proxies API
Where this information came from

This is an independent, third-party profile of Vectra AI Notes 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.