Vectra AI Match API
The Match API from Vectra AI — 7 operation(s) for match.
The Match API from Vectra AI — 7 operation(s) for match.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/vectranetworks-match-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: Vectra Platform Match 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: Match
paths:
/vectra-match/enablement:
get:
summary: Retrieve Vectra Match enablement status
operationId: getVectraMatchEnablement
tags:
- Match
responses:
'200':
description: Vectra Match enablement status
content:
application/json:
schema:
$ref: '#/components/schemas/VectraMatchEnablement'
post:
summary: Enable/disable Vectra Match
tags:
- Match
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
device_serial:
type: string
desired_state:
type: boolean
responses:
'200':
description: Updated enablement status
/vectra-match/stats:
get:
summary: Retrieve Vectra Match statistics
operationId: getVectraMatchStats
tags:
- Match
responses:
'200':
description: Vectra Match statistics
content:
application/json:
schema:
$ref: '#/components/schemas/VectraMatchStats'
/vectra-match/alert-stats:
get:
summary: Retrieve Vectra Match alert statistics
operationId: getVectraMatchAlertStats
tags:
- Match
responses:
'200':
description: Vectra Match alert statistics
content:
application/json:
schema:
$ref: '#/components/schemas/VectraMatchAlertStats'
/vectra-match/status:
get:
summary: Retrieve Vectra Match status
operationId: getVectraMatchStatus
tags:
- Match
responses:
'200':
description: Vectra Match status
content:
application/json:
schema:
$ref: '#/components/schemas/VectraMatchStatus'
/vectra-match/available-devices:
get:
summary: Retrieve available devices for Vectra Match
operationId: getVectraMatchAvailableDevices
tags:
- Match
responses:
'200':
description: List of available devices
content:
application/json:
schema:
$ref: '#/components/schemas/VectraMatchAvailableDevices'
/vectra-match/rules:
get:
summary: Retrieve Vectra Match rules
operationId: getVectraMatchRules
tags:
- Match
responses:
'200':
description: List of Vectra Match rules
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VectraMatchRule'
post:
summary: Create or upload Vectra Match rules
operationId: uploadVectraMatchRules
tags:
- Match
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: Rules file to upload
responses:
'201':
description: Vectra Match rules uploaded successfully
/vectra-match/assignment:
get:
summary: Retrieve Vectra Match assignment details
operationId: getVectraMatchAssignment
tags:
- Match
responses:
'200':
description: Vectra Match assignment details
content:
application/json:
schema:
$ref: '#/components/schemas/VectraMatchAssignment'
post:
summary: Assign devices to Vectra Match
operationId: assignVectraMatchDevices
tags:
- Match
requestBody:
content:
application/json:
schema:
type: object
properties:
device_ids:
type: array
items:
type: integer
description: List of device IDs to assign
responses:
'201':
description: Devices assigned successfully
components:
schemas:
VectraMatchStatus:
type: object
properties:
status:
type: string
description: Current status of Vectra Match
last_updated:
type: string
format: date-time
description: Timestamp of the last status update
Device:
type: object
properties:
id:
type: integer
name:
type: string
status:
type: string
description: Device status (e.g., "available", "assigned")
VectraMatchAssignment:
type: object
properties:
assigned_devices:
type: array
items:
$ref: '#/components/schemas/Device'
unassigned_devices:
type: array
items:
$ref: '#/components/schemas/Device'
VectraMatchStats:
type: object
properties:
total_rules:
type: integer
description: Total number of rules
active_rules:
type: integer
description: Number of active rules
matched_events:
type: integer
description: Total matched events
VectraMatchAlertStats:
type: object
properties:
total_alerts:
type: integer
description: Total number of alerts
critical_alerts:
type: integer
description: Number of critical alerts
high_alerts:
type: integer
description: Number of high alerts
medium_alerts:
type: integer
description: Number of medium alerts
low_alerts:
type: integer
description: Number of low alerts
VectraMatchRule:
type: object
properties:
id:
type: integer
name:
type: string
description:
type: string
enabled:
type: boolean
created_timestamp:
type: string
format: date-time
VectraMatchEnablement:
type: object
properties:
enabled:
type: boolean
description: Indicates if Vectra Match is enabled
VectraMatchAvailableDevices:
type: object
properties:
devices:
type: array
items:
$ref: '#/components/schemas/Device'
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://{vectra_portal_url}/oauth2/token
scopes: {}