The SecTeer VulnDetect API allows corporate users to access their SecTeer VulnDetect data outside the web-based user-interface.
The character set used by SecTeer VulnDetect is UTF-8.
All date/time values returned by the API are in UTC.
The data format returned by the API is Content-Type: application/json; charset=utf-8
A 400 response with code 7275 means the request body of an approval change does not contain the expected array, or an element of it is not a UUID. A 403 response means the API Token does not have the privilege the endpoint needs.
A 404 response means the agent UUID does not exist in the site. A 422 response with code 2070 means the group or tag UUID does not exist in the site, and with code 2033 that a query option has an invalid value or is given more than once; the message names the option. A channelTag that matches no application returns 200 with an empty array.
SecTeer VulnDetect uses uuids to identify most entities, such as agents/hosts and groups.
The SecTeer VulnDetect API uses Bearer token authorization with the Authorization HTTP header. Tokens are uuids in the form 11111111-2222-3333-4444-555555555555.

Example:
Authorization: Bearer 11111111-2222-3333-4444-555555555555
API Tokens can be created and deleted in the SecTeed VulnDetect user interface, in the Configuration page, under the API Tokens tab. Each API Token is keyed to a specific site.
Accept-Encoding: gzip
Some of the API endpoints can return a significant amount of data and compressing it will significantly improve response times and reduce network transfer times.
If using PowerShell to interact with the API, then the data will be automatically decompressed upon reception.
The terms 'host' and 'agent' have been used interchangeably in this manual.
Strictly speaking, a 'host' is a computer in the customer's network, and an 'agent' is the SecTeer VulnDetect agent, which is installed on a 'host', but this distinction is not always obvious.
Regardless, agents/hosts are uniquely identified by an agentUuid.
This value is a combination of bit-flags:
Sunday | 64 |
| Monday | 32 |
Tuesday | 16 |
Wednesday | 8 |
Thursday | 4 |
Friday | 2 |
Saturday |

The value is in seconds after midnight, interpreted in the local time zone on the host in question.
The window is the length of time, in seconds, after HOD during which the agent can run scheduled inspections.
Currently, the window is 6 hours, or 21600 seconds.
Manually requested inspections will still be performed outside the window.

Example: If the HOD value is 3600, and the window is 6 hours, then the agent will run its scheduled inspection as soon as possible after 01:00, but before 07:00, in its local time.
After performing an inspection, and the SecTeer VulnDetect backend servers have processed the inspection data, if there are available updates that have been approved the agent will attempt to perform those updates immediately.
Hosts/Agents that are shown in the Hosts page in the SecTeer VulnDetect interface are enabled (isEnabled=true).
Hosts/Agents shown in the Hidden Hosts tab in the Configuration page are disabled (isEnabled=false).
Hosts/Agents shown in the Dormant Hosts tab in the Configuration page are disabled (isEnabled=false), and dormant (isDormant=true).
Disabled agents cannot be in a group and have no application data. They can still check in and may perform inspections, but their inspections are not processed by the SecTeer VulnDetect backend servers.
Dormant agents are still members of their group, even though they are disabled.
Host name: https://corporate.vulndetect.com
Most endpoints return an object with a single property, which is either an array of objects or a single object.

Example: When called without an agentUuid, the agent endpoint returns data with the following shape: {"agents": [...]}
Writeable endpoints typically return {"success": true}
channelTag | Uniquely identifies this application |
title | Application title |
vendor | Application vendor |
icon | Application icon path (see notes) |
countInsecure | Count of insecure installations of the application |
countOk | Count of installations of the application with no known security issues |
countEoL | Count of End-of-Life installations of the application |
countZeroDay | Count of installations of the application which have a 0-Day |
countVersions | Count of different versions of the application detected |
countSolutions | Count of insecure installations of the application which have an upgrade that fixes the security issues |
countTotal | Total count of installations of the application |

NOTE that the counts are not independent, i.e., an End-of-Life installation will also be counted as either Insecure or Ok, as appropriate, and 0-Day installations are also counted as Insecure.
Still, countTotal will equal the sum of countInsecure and countOk.
The application icon is available at the given path, with the url prefix:
GET /api/corporate/v1/applications
Query options:
status: ok, insecure, eol or zeroday. Filter applications by status.
groupUuid: <groupUuid>. Request the application list for hosts in a single group.
Fetches the list of detected applications in the applications array.
channelTag | Uniquely identifies this application |
title | Application title |
vendor | Application vendor |
icon | Application icon path (see notes for Application Properties above) |
version | Application version |
countTotal | Total count of installations of this version the the application |
vulnStatus | Vulnerability status of this version of the application. Ok or Insecure |
updateStatus | Update type of this version of the application. Plain or Security |
isUntracked | True if this version is not tracked. This means that the vendor does not provide useful vulnerability information for the application |
isPrerelease | True if this version is a pre-release version of the application |
isEoL | True if this version is End-of-Life |
isZeroDay | True if this version has a 0-Day |
statusFlags | Not used |
isRecommendedVersion | True if this version is the recommended version for this application. If this is true, then the recommendedVersion property will not have any useful information, because it would be redundant. |
hasRecommendedVersion | True if this application has a recommended version. Note that even if this is true, if isRecommendedVersinis also true, then the recommendedVersion property will not have any useful information, because it would be redundant |
recommendedVersion | This property is an object that contains information about the recommended version of the application, including most of the same properties as described above. Some of those properties are contained in a child object named display, which is null if there is no recommended version of the application, or if this version of the application is the recommended version. In particular, the property recommendedVersion.display.version, if present, contains the version string of the recommended version of the application. |
GET /api/corporate/v1/application-versions
Query options:
channelTag: <channelTag>. Identifies the application. This option is required.
status: ok, insecure, eol or zeroday. Filter application versions by status.
groupUuid: <groupUuid>. Request the application version list for hosts in a single group.
Fetches the list of detected versions of the application, identified by the channelTag, in the versions array.
channelTag | Uniquely identifies this application |
title | Application title |
vendor | Application vendor |
icon | Application icon path (see notes for Application Properties above) |
product | Not used |
productFamily | Not used |
version | Application version |
icon | Application icon (see notes for Application Properties above) |
appUuid | Not used |
hostname | The host’s name |
hostDomain | The host’s domain |
agentUuid | The host’s agentUuid, uniquely identifies this host/agent |
groupName | The name of the host’s group |
groupUuid | The groupUuid of the host’s group |
vulnStatus | Vulnerability status of this version of the application. Ok or Insecure |
updateStatus | Update type of this version of the application. Plain or Security |
isUntracked | True if this version is not tracked. This means that the vendor does not provide useful vulnerability information for the application |
isPrerelease | True if this version is a pre-release version of the application |
isEoL | True if this version is End-of-Life |
isZeroDay | True if this version has a 0-Day |
statusFlags | Not used |
display | This property is an object that contains display information about the application. Some of the properties are duplicated, e.g., title, vendor, version. The display object contains the path and filename of the file that identifies the application. The display object also contains the isRecommendedVersion and hasrecommendedVersion properties that are described in the Application Version section, above. |
recommendedVersion | This property is an object that contains information about the recommended version of the application, including some of the same properties as described above. Some of those properties are contained in a child object named display, which is null if there is no recommended version of the application, or if this version of the application is the recommended version. In particular, the property recommendedVersion.display.version, if present, contains the version string of the recommended version of the application. |
GET /api/corporate/v1/application-hosts
Query options:
channelTag: <channelTag>. Identifies the application. This option is required.
status: ok, insecure, eol or zeroday. Filter application by status.
version: <application version>. Filter by application version.
groupUuid: <groupUuid>. Request the list for hosts in a single group.
Fetches the list of hosts that have the application, identified by the channelTag, in the hosts array.

The dashboard data is returned in a dashboard object that has two properties: counts and updates.
The updates property is an array of 7 objects, one for each day of the past week. Each object has a date property and a countVerified property, which indicates how many updates were successfully completed on that day.
The counts object has various properties that are listed in the table below.
countAgents | Host count |
countChannelTagVersions | Count of distinct application versions |
countChannelTags | Count of distinct applications |
countEoL | Count of End-of-Life applications |
countEoLNotZeroDayNotInsecure | Count of End-of-Life applications with no known security issues |
countGroups | Group count |
countInsecure | Count of applications with known security issues |
countInsecureNotZeroDay | Count of applications with known security issues but not affected by a 0-day |
countOk | Count of applications with no known security issues |
countOkNotZeroDayNotEoL | Count of applications with no known security issues that are not End-of-Life |
countOutOfDateApprovals | Count of out-of-date group-approvals |
countSolutions | Count of applications with known security issues that can be updated |
countTotal | Total count of all applications found |
countUnknown | Count of applications with an unknown security status. This value should always be 0 |
countZeroDay | Count of applications that are affected by a 0-day |
GET /api/corporate/v1/dashboard
Fetches the dashboard data, in the dashboard object.
groupUuid | Uniquely identifies this group |
groupName | The group's name |
comment | A descriptive comment |
countHosts | Number of hosts in this group |
countInsecure | Count of insecure applications installed on the hosts in this group |
countOk | Count of applications with no known security issues installed on the hosts in this group |
countTotal | Count of all applications installed on the hosts in this group |
createdAt | Creation time of the group |
updatedAt | Last update time of the group |
GET /api/corporate/v1/group
Returns the list of groups in the groups array.
Returns a single group, by groupUuid, in the group property.
To find the groupUuid, see the non-parameterized group endpoint above.
agentUuid | Uniquely identifies this host/agent |
hostName | The host's name |
hostDomain | The host's domain name |
canonicalName | The AD canonical name of the host |
timezoneOffset | The timezone offset of the host, in seconds |
lastInspectionAt | UTC time of the last inspection of the agent |
lastCheckinAt | UTC time of the last check-in of the agent |
lastKnownBootTime | UTC time of the last known startup of the host. Note that only agents version >= 3.2.0.0 report the host startup time |
lastIp | The last seen IP address of the host, as observed by the SecTeer servers |
isEnabled | Indicates whether the agent is enabled or disabled. Disabled agents are those that are in the Hidden Hosts tab, or Dormant Hosts tab. |
version | The version of the SecTeer VulnDetect agent installed on the host |
countOk | Number of applications with no known vulnerabilities found on the host |
countInsecure | Number of insecure applications found on the host |
countUnknown | Number of applications found on the host, where no reliable security information is available from the vendor |
countEoL | Number of End-of-Life applications found on the host |
countZeroDay | Number of insecure applications found on the host that are affected by a 0-Day vulnerability |
countInsecureNotZeroDay | Number of insecure applications found on the host that are not affected by a 0-Day vulnerability |
countEoLNotZeroDayNotInsecure | Number of applications found on the host that are not insecure (and not affected by a 0-Day vulnerability) |
countOkNotZeroDayNotEoL | Number of applications with no known vulnerabilities and not End-of-Life, that are found on the host |
countTotal | Total number of applications found on the host |
havePendingInspection | Indicates whether the agent has a pending non-scheduled inspection, i.e. if an inspection has been manually requested |
haveInProgressInspection | Indicates whether the agent is currently running an inspection |
checkInInterval | The agent check-in interval in seconds |
inspectionScheduleDow | The days of the week in which this agent runs inspections |
inspectionScheduleHod | The hour of day that this agent runs inspections. The value is in seconds after midnight |
inspectionScheduleWindow | The window in which to run inspections, in seconds |
groupUuid | Uniquely identifies the agent's group |
groupName | The name of the agent's group |
nextInspectionTime | UTC time of the next scheduled inspection |
The list shows properties that are present on all agents. Additional properties may be present on some agents.
Note that the counts of the number of applications found with various overlap in some cases.
For example, countInsecure includes all applications in countZeroDay. Applications may also be End-of-Life independently of whether they are Ok or Insecure (or Unknown).GET /api/corporate/v1/agent/${agentUuid}
Returns a single agent, by agentUuid, in the agent property.
To find the agentUuid, see the non-parameterized agent endpoints above.

approvalUuid | The approval rule uuid. Used when changing the rule. Null on a site row that stands in for a site with no rule of its own for the application; such a row cannot be changed. |
level | The level of the rule: site, group or tag. |
channelTag, title, vendor, product | Identify the application, as in the Application Properties. |
groupUuid, groupName | Identify the group. Group rules only. |
tagUuid, tagName | Identify the tag. Tag rules only. |
status | The status of the rule: disabled, auto, blocked, staged, up-to-date or out-of-date. |
siteDefault | The status of the site rule for the same application, which a disabled group or tag rule falls back to. Null on site rules. |
systemDefault | The status of the SecTeer default rule for the application, which a disabled site rule falls back to. |
approvedVersion | The version this rule has approved. Null when the rule is disabled. |
recommendedVersion | The version SecTeer currently recommends. |
isUpToDate | Whether the approved version is the recommended version. Null when the rule is disabled. |
changedAt | UTC time of the last decision on the rule: approve, automate, block, stage, disable or enable. Null when no decision has been recorded. |
changedByAccountUuid | Identifies the user account that made the last decision. For a decision made through the API, the account the API Token belongs to. |
versionApprovedAt | UTC time the currently approved version became approved, by a decision or by an auto or staged rule picking up a new recommended version. |
isEnabled | Whether the rule is switched on. False corresponds to the status disabled. |
isAutoUpdate | Whether the rule approves new versions automatically. |
isBlocked | Whether the rule blocks updates. |
isStaged | Whether the rule rolls out through update rings. |
updateRing | The update ring the rule is assigned to. Staged tag rules only. |
channelTag: <channelTag>. Identifies the application. Without it, every application is returned.
showHidden: true. Includes applications no host in the site has any more. First route only.
agentUuid | Uniquely identifies the host/agent. |
groupUuid | Identifies the group of the host. |
tagUuids | The tags of the host, as an array of tag UUIDs. |
approvals | One entry per application, each with channelTag, title, vendor, product, status, approvedVersion and recommendedVersion of the rule that applies to this host, appliedLevel (system, site, group or tag, null when no rule applies), appliedApprovalUuid, and approvals: every rule considered for this host, in the order consulted, each with the Approval Properties and isApplied. The SecTeer default rule is listed with the level system and no approvalUuid. |
The action is one of:
approve: switches the rules on and approves the currently recommended version.
automate: switches the rules on and approves every future recommended version automatically.
block: switches the rules on and blocks updates of the application.
stage: tags only. Switches the rules on for a staged rollout through update rings.
disable: switches the rules off. The level above applies again. This corresponds to Inherit in the user interface, or No Default at site level.
enable: switches the rules back on as a manual approval of the version last approved. Rules that are already switched on as automatic, blocked or staged are also changed to a manual approval.
The request body is a JSON object with one array of approval UUIDs, named after the level: siteApprovals, groupApprovals or tagApprovals, as in {"groupApprovals": ["<approvalUuid>", ...]}. The UUIDs must belong to the level of the endpoint.
Returns {"success": true}. UUIDs that match no rule of the site are ignored, so read the rules back to confirm the result. Every change is recorded in the activity log of the site under the user account the API Token belongs to, with the UUID of the API Token.
|
|
|
|
If that agent has no results or the results are old, request an inspection:
|
|
|
Take the approvalUuid of the returned rule, then:
|
Invoke-RestMethod -Method GET ` |

Note that the times returned are in UTC. Periodically issue requests to this endpoint until the inspection has completed.
Our support team will assist with the actual setup.
All support questions should be addressed to the SecTeer Customer Support Center:
Several support and information resources are also available through our:
Patch Current - Stay Curret