Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
openapi: 3.2.0
info:
title: Vectra Platform Health 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: Health
paths:
/health:
get:
summary: Retrieve health data of the appliance
operationId: getHealthData
tags:
- Health
responses:
'200':
description: Health data of the appliance
content:
application/json:
schema:
$ref: '#/components/schemas/Health'
components:
schemas:
Health:
type: object
properties:
status:
type: string
components:
type: array
items:
type: object
properties:
name:
type: string
status:
type: string
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://{vectra_portal_url}/oauth2/token
scopes: {}
x-provenance:
method: harvested
publisher: Vectra AI
source: https://vectranetworks.github.io/openapi-rux/vectra_rux_openapi_v3.3.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)