Skip to content
English
More support Sign in
EveryCloud
  • There are no suggestions because the search field is empty.

EveryCloud Visibility

Powerered by ThreatAware Public API (V1) – Authentication, Usage & Core Concepts

 

Introduction

The ThreatAware API is a REST‑based HTTPS interface that currently supports read‑only operations. Depending on your ThreatAware licence tier, the API can retrieve data relating to devices, users, alerts, and integration‑specific information across your environment.

API Rate Limits

ThreatAware enforces a global portal‑wide rate limit:
  • 10 requests per 60 seconds (subject to change)
  • Limits vary based on your ThreatAware plan and the specific endpoint in use.

Cloud ID

Your Cloud ID will be created by us - this uniquely identifies your ThreatAware tenant.
Format:
https://{cloudId}.threataware.com/

systemName

systemName refers to a connected integration within your ThreatAware portal (e.g., Automox).
View your connected integrations at:
https://{cloudId}.threataware.com/settings/connections

Generating an API Key

  1. Log in to your ThreatAware portal
  2. Navigate to Settings → API
  3. Select Generate Key
  4. Complete the form and save your key
    • Important: The key is only displayed once.
Direct URL:
https://{cloudId}.threataware.com/settings/api/

Authentication

All API requests must include:
X-ThreatAware-ApiKey: <your API key>
API V1 currently supports GET requests only (subject to change).

Paging (Offset & Limit)

Parameter Description
offset Start index for returned data (default: 0)
limit Number of items to return. 0 or blank returns all items
Paging applies consistently across all supported endpoints.

 

Endpoints

Teams

Retrieve all teams configured in your ThreatAware portal.
URL:
https://{cloudId}.threataware.com/public-api/v1/settings/usermanagement/teams

Headers

Accept: application/json
X-ThreatAware-ApiKey: <API Key>

Query Parameters

Parameter Description
offset Start index of returned data (default: 0)
limit Maximum records to return (0 = all)

Vitals

Retrieve system vitals and related metadata.
URL:
https://{cloudId}.threataware.com/public-api/v1/vitals

Query Parameters

Parameter Description
offset Start index (default: 0)
limit Maximum records to return (0 = all)
tag Optional tag filter
archiveDate Retrieve archived data (format: yyyyMMdd)