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

Dedicated endpoint to Accounts.

Vectra AI Accounts 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 Account. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 13 operations across 8 paths, and defines 32 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.

13 operations 8 paths 32 schemas 1 DELETE8 GET2 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 Accounts 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 13

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

Accounts 13

Dedicated endpoint to Accounts.

GET
/accounts
Get several Accounts
accountGetSeveral 18 params → 200401403
GET
/accounts/{accountID}
Describe a specific Account
accountGetSingle 2 params → 200401403404
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
/search/accounts
Search for Accounts
searchAccounts 3 params → 200401403
GET
/tagging/account/{accountID}
Get all Account's tags
accountTagsGetAll 1 param → 200401403
PATCH
/tagging/account/{accountID}
Replace all Account's tags
accountTagsReplace 1 param body → 200401403
GET
/accounts/{account_id}
Retrieve single account details
getAccountById 1 param → 200
POST
/accounts/{account_id}
Add note to account
postAccountsByAccountId 1 param body → 200
GET
/accounts/{id}/notes
Get account notes
getAccountsByIdNotes 1 param → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are account (21 properties), assignment (11 properties), Account (6 properties), Note (6 properties). Each schema is shown below with its type and property counts.

assignmentHistorycalEvent
object
Assignment history event
5 properties
name
string
tags
object
3 properties
arrayOfIDs
array
Array of IDs
assignmentUser
object
Assignment user (tiny Vectra User)
2 properties
assignment
object
Assignment
11 properties 4 required
arrayOfNames
array
Array of names
ID
integer
ID
positiveInt
integer
assignmentEventType
string
Type of event that can happen to an assignment
isoDate
string
ISO representation of a date
error
object
2 properties
assignmentOutcomeCategory
string
arrayOfLinks
array
Array of links
tagsRequestBody
object
1 property 1 required
link
stringnull
URL Link
privilegeCategory
stringnull
vectraScore
number
accountType
array
Account's type
resultsOfAccounts
queryAccountFields
array
assignmentOutcome
object
Label resolution outcome for an assignment
5 properties 5 required
privilegeLevel
numbernull
noteRequestBody
object
1 property 1 required
severity
string
Severity
results
object
3 properties
account
object
Account
21 properties
note
object
6 properties
text
string
state
string
Note
object
6 properties
Account
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vectranetworks-accounts-api-openapi.yml Raw ↑

Other APIs Vectra AI publishes across the network.

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 Notes API
Vectra AI Proxies API
Where this information came from

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