Skip to main content
GET

Overview

The Vitals endpoint provides access to security control health data, showing deployment, functionality, and configuration status for all Vitals-enabled integrations.
This endpoint returns aggregate health data at the integration level. For device-specific Vitals status, use the /devices endpoint which includes security tool details per device.

Parameters

number
default:"0"
Set the start position of the data returned by the API
number
default:"0"
Limit each request by the provided number. Leave blank or as 0 to return all data available
string
Filter the data down to a specific tag. Blank by default, will return all data.
string
Retrieve archived historical data. Format: yyyyMMdd (e.g., 20240819 for August 19, 2024)
Use this parameter to track Vitals health over time for trend analysis and reporting.

Authentication

string
required
Your ThreatAware API key
string
default:"application/json"
Response format

Response

number
The starting position of this result set
number
The number of results returned
number
Total number of integrations
boolean
Whether the request was successful
number
HTTP status code
string
Status message
array

Understanding Vitals Metrics

The three-stage Vitals validation creates a funnel of compliance:
Each stage acts as a filter - devices must pass earlier stages before being checked in later stages.

Use Cases

Executive Dashboards

Build Power BI dashboards showing security posture trends over time

Compliance Evidence

Export historical Vitals data for audit and compliance reporting

Security Metrics

Track security control coverage and health KPIs

Capacity Planning

Identify integrations needing attention or resources

Historical Data

Use the archiveDate parameter to access historical Vitals data:
ThreatAware archives Vitals data daily, allowing you to track security posture improvements over time and demonstrate ROI of security initiatives.

Security Monitoring

Learn about Vitals configuration and thresholds

Devices

Get device-level Vitals status via the devices endpoint