![](\"https://assets.threataware.com/assets/images/logo/TA-logo-light-2500px.png\"){kind=logo}
\n\nThe ThreatAware API
ThreatAware's API is REST based, over HTTPS. This will allow 'RESTful' based operations which are currently limited to reading data from your portal. Our API will provide data related to your devices, users, alerts as a whole and integration specific data found across your infrastructure, depending on the ThreatAware plan associated with your portal.
What is the API rate limit?
ThreatAware's rate limit vary based on the operation being performed and the ThreatAware plan associated to your portal. The limit is applied portal wide regardless of IP addresses used to make the calls.
Rate: 10 requests every 60 seconds (subject to change)
What is your Cloud Id?
Cloud Id is the identifier associated with your portal.
You can find it in the URL you use to access your portal e.g. if your Cloud Id was 'Sandbox': https://sandbox.threataware.com/
What is systemName?
An integration you have connected to your ThreatAware portal and wish to query against. E.g. Automox.
Your connected integrations: https://{cloudId}.threataware.com/settings/connections
How to generate an API Key?
Log into your portal, click onto your 'Settings', then click on 'API'. Click the button 'Generate Key' and fill out to form as desired. Please note your key will only be shown once.
Quick link: https://{cloudId}.threataware.com/settings/api/
How to authenticate using the API Key?
All calls to ThreatAware's API will require this API Key to be provided in the X-ThreatAware-ApiKey header.
HTTP request methods:
- GET
Note: In V1 we are currently only accepting GET requests. (Subject to change)
API Paging (Offset & Limit)
ThreatAware's paging is currently structured around Offset and Limit, by default both are 0. If limit is left blank or set to 0, the data returned will be all available data for that endpoint, otherwise it will return the amount set in the query unless it is greater than the total available data which will respond with everything.
Contact Support:
Email: help@threataware.com
Retrieve all user data that has been collected from your integrations.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-ThreatAware-ApiKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3fd97226-e36f-496c-a45a-a4481bffed81","id":"3fd97226-e36f-496c-a45a-a4481bffed81","name":"ThreatAware API Documentation","type":"collection"}},"urlObject":{"path":["users"],"host":["https://sandbox.threataware.com/public-api/v1"],"query":[{"disabled":true,"description":{"content":"Filter users based on their current state.
\n","type":"text/plain"},"key":"filter","value":"all"},{"disabled":true,"description":{"content":"Set the start position of the data returned by the api. Set to 0 by default
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Limit each request by the provided number. Leave blank or as 0 to return all data available.
\n","type":"text/plain"},"key":"limit","value":"0"}],"variable":[]}},"response":[{"id":"1d24e96c-b152-4f7c-9014-16075120997c","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-ThreatAware-ApiKey","value":"Retrieve specific integration data e.g. Automox and filter it further down by type of type e.g. Devices or workstations.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-ThreatAware-ApiKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3fd97226-e36f-496c-a45a-a4481bffed81","id":"3fd97226-e36f-496c-a45a-a4481bffed81","name":"ThreatAware API Documentation","type":"collection"}},"urlObject":{"path":["inventory"],"host":["https://sandbox.threataware.com/public-api/v1"],"query":[{"description":{"content":"(Required) Name of an integration you would like to query against.
\n","type":"text/plain"},"key":"systemName","value":"qualysdevices"},{"disabled":true,"description":{"content":"Type of data you wish to request from an integration e.g. Users or workstations.
\n","type":"text/plain"},"key":"type","value":"workstations"},{"disabled":true,"description":{"content":"Set the start position of the data returned by the api. Set to 0 by default
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Limit each request by the provided number. Leave blank or as 0 to return all data available.
\n","type":"text/plain"},"key":"limit","value":"0"}],"variable":[]}},"response":[{"id":"c906e6bb-a145-4caf-b1e8-604eeaa043b0","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-ThreatAware-ApiKey","value":"Access all your data related to your environments devices. Filter the data with varying query parameters to organise the data based on your requirements.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-ThreatAware-ApiKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3fd97226-e36f-496c-a45a-a4481bffed81","id":"3fd97226-e36f-496c-a45a-a4481bffed81","name":"ThreatAware API Documentation","type":"collection"}},"urlObject":{"path":["devices"],"host":["https://sandbox.threataware.com/public-api/v1"],"query":[{"description":{"content":"(Required) Filter devices based on their current state.
\n","type":"text/plain"},"key":"filter","value":"active"},{"disabled":true,"description":{"content":"Set the start position of the data returned by the api. Set to 0 by default
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Limit each request by the provided number. Leave blank or as 0 to return all data available.
\n","type":"text/plain"},"key":"limit","value":"0"}],"variable":[]}},"response":[{"id":"804eae7d-2c0a-4f1c-923c-76e493e48052","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-ThreatAware-ApiKey","value":"Request a list of all alerts throughout your entire environment or include the systemName query parameter to retrieve a list of alerts from a specific integration, e.g. Automox.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-ThreatAware-ApiKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3fd97226-e36f-496c-a45a-a4481bffed81","id":"3fd97226-e36f-496c-a45a-a4481bffed81","name":"ThreatAware API Documentation","type":"collection"}},"urlObject":{"path":["alerts"],"host":["https://sandbox.threataware.com/public-api/v1"],"query":[{"description":{"content":"(Required) Filter alerts based on their current state.
\n","type":"text/plain"},"key":"filter","value":"allunresolved"},{"disabled":true,"description":{"content":"Name of an integration you would like to query against. Leave blank if you wish to query all integrations.
\n","type":"text/plain"},"key":"systemName","value":"automox"},{"disabled":true,"description":{"content":"Set the start position of the data returned by the api. Set to 0 by default
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Limit each request by the provided number. Leave blank or as 0 to return all data available.
\n","type":"text/plain"},"key":"limit","value":"0"}],"variable":[]}},"response":[{"id":"d593b73d-fe5b-48ff-8fc4-42eb3415e84d","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-ThreatAware-ApiKey","value":"Retrieve data for all users that have been registered on the platform.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-ThreatAware-ApiKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3fd97226-e36f-496c-a45a-a4481bffed81","id":"3fd97226-e36f-496c-a45a-a4481bffed81","name":"ThreatAware API Documentation","type":"collection"}},"urlObject":{"path":["settings","usermanagement","users"],"host":["https://sandbox.threataware.com/public-api/v1"],"query":[{"disabled":true,"description":{"content":"Set the start position of the data returned by the api. Set to 0 by default
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Limit each request by the provided number. Leave blank or as 0 to return all data available.
\n","type":"text/plain"},"key":"limit","value":"0"}],"variable":[]}},"response":[{"id":"b2f37ba9-372c-4d4a-8e4f-9d3b85f67315","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-ThreatAware-ApiKey","value":"Retrieve data for all roles that have been registered on the platform.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-ThreatAware-ApiKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3fd97226-e36f-496c-a45a-a4481bffed81","id":"3fd97226-e36f-496c-a45a-a4481bffed81","name":"ThreatAware API Documentation","type":"collection"}},"urlObject":{"path":["settings","usermanagement","roles"],"host":["https://sandbox.threataware.com/public-api/v1"],"query":[{"disabled":true,"description":{"content":"Set the start position of the data returned by the api. Set to 0 by default
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Limit each request by the provided number. Leave blank or as 0 to return all data available.
\n","type":"text/plain"},"key":"limit","value":"0"}],"variable":[]}},"response":[{"id":"eccfa1a6-7271-4501-8ae8-c95399fde120","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-ThreatAware-ApiKey","value":"Retrieve data for all teams that have been registered on the platform.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-ThreatAware-ApiKey"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"3fd97226-e36f-496c-a45a-a4481bffed81","id":"3fd97226-e36f-496c-a45a-a4481bffed81","name":"ThreatAware API Documentation","type":"collection"}},"urlObject":{"path":["settings","usermanagement","teams"],"host":["https://sandbox.threataware.com/public-api/v1"],"query":[{"disabled":true,"description":{"content":"Set the start position of the data returned by the api. Set to 0 by default
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Limit each request by the provided number. Leave blank or as 0 to return all data available.
\n","type":"text/plain"},"key":"limit","value":"0"}],"variable":[]}},"response":[{"id":"7fabadb0-42a9-44cd-82be-1564e9c7ed10","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-ThreatAware-ApiKey","value":"Set the start position of the data returned by the api. Set to 0 by default
\n","type":"text/plain"},"key":"offset","value":"0"},{"disabled":true,"description":{"content":"Limit each request by the provided number. Leave blank or as 0 to return all data available.
\n","type":"text/plain"},"key":"limit","value":"0"},{"disabled":true,"description":{"content":"Filter the data down to a tag. Blank by default, will return all data.
\n","type":"text/plain"},"key":"tag","value":""},{"disabled":true,"description":{"content":"Retrieve archived data. Example 20240819 Which translates to 19th August 2024 (yyyyMMdd)
\n","type":"text/plain"},"key":"archiveDate","value":""}],"variable":[]}},"response":[{"id":"577d3435-d3fa-4b26-b613-e626cff278f5","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"X-ThreatAware-ApiKey","value":"