Vectra AI Entities API
The Entities API from Vectra AI — 4 operation(s) for entities.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/vectranetworks-entities-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Vectra Platform Entities API
description: Comprehensive API documentation for Vectra's breach detection data, platform configuration, and health information.
version: '3.3'
contact:
name: Vectra AI Support
url: https://vectra.ai/support
servers:
- url: https://{vectra_portal_url}/api/v3.3
description: Vectra Platform API Server
variables:
vectra_portal_url:
default: platform.vectra.ai
security:
- oauth2: []
tags:
- name: Entities
paths:
/entities:
get:
summary: Retrieve all entities
operationId: getEntities
tags:
- Entities
parameters:
- name: type
in: query
schema:
type: string
enum:
- account
- host
description: Specifies the type of entities to retrieve (e.g., "account" or "host")
- name: is_prioritized
in: query
schema:
type: boolean
description: Filter entities by priority (only entities above the configured priority threshold)
- name: ordering
in: query
schema:
type: string
description: Specifies the order of results, e.g., by urgency_score, last timestamp, or last_modified_timestamp
- name: last_detection_timestamp_gte
in: query
schema:
type: string
format: date-time
description: Only entities with a last detection timestamp greater than or equal to this time (inclusive, ISO-8601 format)
- name: last_detection_timestamp_lte
in: query
schema:
type: string
format: date-time
description: Only entities with a last detection timestamp less than or equal to this time (inclusive, ISO-8601 format)
- name: last_modified_timestamp_gte
in: query
schema:
type: string
format: date-time
description: Only entities with a last modified timestamp greater than or equal to this time (inclusive, ISO-8601 format)
- name: last_modified_timestamp_lte
in: query
schema:
type: string
format: date-time
description: Only entities with a last modified timestamp less than or equal to this time (inclusive, ISO-8601 format)
- name: name
in: query
schema:
type: string
description: Filter by entity name
- name: note_modified_timestamp_gte
in: query
schema:
type: string
format: date-time
description: Only entities with notes modified on or after this time (ISO-8601 format)
- name: page
in: query
schema:
type: integer
description: Page number for pagination
- name: page_size
in: query
schema:
type: integer
maximum: 5000
description: Number of entities per page, with a maximum of 5000
- name: state
in: query
schema:
type: string
enum:
- active
- inactive
description: Filter by entity activation state (either "active" or "inactive")
- name: tags
in: query
schema:
type: string
description: Filter entities by tags (comma-separated list of tags, returns entities with any specified tags)
responses:
'200':
description: List of entities
content:
application/json:
schema:
type: object
properties:
count:
type: integer
next:
type:
- string
- 'null'
format: uri
previous:
type:
- string
- 'null'
format: uri
results:
type: array
items:
$ref: '#/components/schemas/Entity'
/entities/{entity_id}:
get:
summary: Get entity by ID
tags:
- Entities
parameters:
- name: entity_id
in: path
required: true
schema:
type: integer
- name: type
in: query
required: true
schema:
type: string
enum:
- account
- host
responses:
'200':
description: Entity details
content:
application/json:
schema:
$ref: '#/components/schemas/Entity'
/entities/{entity_id}/notes:
get:
summary: Get entity notes
tags:
- Entities
parameters:
- name: entity_id
in: path
required: true
schema:
type: integer
- name: type
in: query
required: true
schema:
type: string
enum:
- account
- host
responses:
'200':
description: List of notes
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Note'
post:
summary: Add note to entity
tags:
- Entities
parameters:
- name: entity_id
in: path
required: true
schema:
type: integer
- name: type
in: query
required: true
schema:
type: string
enum:
- account
- host
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
note:
type: string
responses:
'200':
description: Created note
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
/entities/{entity_id}/notes/{note_id}:
get:
summary: Get specific entity note
tags:
- Entities
parameters:
- name: entity_id
in: path
required: true
schema:
type: integer
- name: note_id
in: path
required: true
schema:
type: integer
- name: type
in: query
required: true
schema:
type: string
enum:
- account
- host
responses:
'200':
description: Note details
content:
application/json:
schema:
$ref: '#/components/schemas/Note'
patch:
summary: Update entity note
tags:
- Entities
parameters:
- name: entity_id
in: path
required: true
schema:
type: integer
- name: note_id
in: path
required: true
schema:
type: integer
- name: type
in: query
required: true
schema:
type: string
enum:
- account
- host
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
note:
type: string
responses:
'200':
description: Updated note
delete:
summary: Delete entity note
tags:
- Entities
parameters:
- name: entity_id
in: path
required: true
schema:
type: integer
- name: note_id
in: path
required: true
schema:
type: integer
- name: type
in: query
required: true
schema:
type: string
enum:
- account
- host
responses:
'204':
description: Note deleted successfully
components:
schemas:
Note:
type: object
properties:
id:
type: integer
created_by:
type: string
modified_by:
type: string
note:
type: string
date_created:
type: string
format: date-time
date_modified:
type: string
format: date-time
Entity:
type: object
properties:
id:
type: integer
type:
type: string
urgency:
type: integer
importance:
type: integer
last_detection_timestamp:
type: string
format: date-time
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://{vectra_portal_url}/oauth2/token
scopes: {}