Actions222
- Application Baseline Actions
- Attack Surface Actions
- Backup Software Actions
- EDR Actions
- Tags Actions
- PII Actions
- External Scan Actions
- Settings Actions
- Compliance Assessment Actions
- Reports Actions
- Compliance Actions
- Jobs Actions
- Active Directory Actions
- Retrieve Ad Roles
- Retrieve Ad User Licenses
- Retrieve Azure Licenses
- Retrieve Azure Ad Logs
- Retrieve Azure Secure Score
- Retrieve Ad Password Policies
- Retrieve Ad Groups View
- Retrieve Ad Ous View
- Retrieve Ad Gpos View
- Retrieve Ad Computers View
- Retrieve Ad Users View
- Retrieve Ad Domain Details
- Retrieve Ad Gpos Details
- Retrieve Get Ous Details
- Retrieve Get Groups Details
- Retrieve Ad Group Users
- Retrieve Ad Group Computers
- Retrieve Get User Details
- Retrieve Get Computer Details
- Retrieve Ad Roles Details
- Retrieve Ad Roles Member
- Retrieve Ad Basic Info
- Audit Log Actions
- Ad Audit Actions
- Asset Data Actions
- Retrieve Bios Info
- Retrieve Bio Info
- Retrieve Browser Extensions
- Retrieve Browser Extension
- Retrieve Ciphers View
- Retrieve Cipher View
- Retrieve Windows Protection Status
- Retrieve Window Protection Status
- Retrieve Asset Compliance Report Card
- Retrieve Asset Firewall Policy
- Retrieve Asset Installed Drivers
- Retrieve Asset Installed Driver
- Retrieve Asset Interface
- Retrieve Asset Msdt
- Retrieve Asset Ports
- Retrieve Asset Port
- Retrieve Asset Security Report Data
- Retrieve Asset Security Report Datum
- Retrieve Asset Shares
- Retrieve Asset Share
- Retrieve Asset Storages
- Retrieve Asset Storage
- Retrieve Asset Unqouted Services
- Retrieve Asset Unqouted Service
- Retrieve Asset User Shares
- Retrieve Asset User Share
- Retrieve Asset Video Info
- Retrieve Asset Windows Reboot Required
- Retrieve Asset Window Reboot Required
- Vulnerabilities Actions
- Firewall Actions
- Integration Actions
- Retrieve Integration Credentials
- Retrieve Integration Credential
- Create Integration Credential
- Update Integration Credential
- Delete Integration Credential
- Retrieve Integration Rules
- Retrieve Integration Rule
- Create Integration Rule
- Update Integration Rule
- Delete Integration Rule
- Retrieve Company Mappings
- Retrieve Company Mapping
- Create Company Mapping
- Update Company Mapping
- Delete Company Mapping
- Event Set Actions
- Ticket Template Actions
- Scheduler Actions
- Credentials Actions
- Asset Actions
- Retrieve Records
- Retrieve Assets
- Retrieve Asset
- Create Asset
- Update Asset
- Delete Asset
- Retrieve Asset Stats
- Retrieve Asset Stat
- Retrieve Asset View
- Retrieve Cron Jobs
- Retrieve Kernel Modules
- Retrieve Suid Permissions
- Retrieve Ufw Firewall Rules
- Retrieve Selinux Settings
- Retrieve Asset Iptables Rules
- Retrieve Asset Users
- Retrieve Asset Processes Running
- Retrieve Asset Services
- Retrieve Asset Patches Info
- Retrieve Asset Firewall Rules
- Retrieve Asset Registry Misconfiguration
- Retrieve Asset Open Ports
- Retrieve Notification Tickets View
- Retrieve System Events View
- Discovery Settings Actions
- Retrieve Discovery Settings
- Retrieve Discovery Setting
- Create Discovery Setting
- Update Discovery Setting
- Delete Discovery Setting
- Retrieve Agent Discoverysettings Mapping
- Retrieve Agent Discoverysetting Mapping
- Create Agent Discoverysetting Mapping
- Update Agent Discoverysetting Mapping
- Delete Agent Discoverysetting Mapping
- Auth Actions
- Company Actions
- Agent Actions
Overview
This node operation "Retrieve Agents" fetches a list of agents from the Connect Secure API. It is useful in scenarios where you need to programmatically query and retrieve agent data, such as for monitoring, reporting, or integrating agent information into other workflows or systems.
Practical examples include:
- Retrieving all agents with specific attributes or statuses by applying query conditions.
- Paginating through large sets of agents using skip and limit parameters.
- Sorting the retrieved agents based on certain fields.
Properties
| Name | Meaning |
|---|---|
| X USER ID | User Id header required for authentication or identification purposes in the API call. |
| Condition | Query condition string to filter which agents to retrieve (e.g., status='active'). |
| Skip | Number of records to skip, used for pagination. |
| Limit | Maximum number of agent records to return. |
| Order By | Field(s) to order the results by (e.g., "name asc", "createdAt desc"). |
Output
The output contains JSON data representing the list of agents retrieved from the API according to the specified query parameters. Each item in the JSON array corresponds to an agent object with its associated properties as returned by the Connect Secure API.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the Connect Secure API.
- The node depends on the external Connect Secure API service being accessible.
- No additional environment variables are explicitly required beyond the API credential.
Troubleshooting
Common issues:
- Missing or invalid user ID header (
X USER ID) may cause authentication failures. - Incorrect query conditions can result in empty responses or errors.
- Pagination parameters (
skipandlimit) set incorrectly might lead to unexpected subsets of data. - Ordering by non-existent fields may cause API errors.
- Missing or invalid user ID header (
Error messages:
- Authentication errors typically indicate missing or invalid credentials or headers.
- Query parameter errors suggest malformed or unsupported query strings.
- Network or connectivity errors imply issues reaching the Connect Secure API endpoint.
To resolve these, verify that the user ID is correctly provided, ensure query syntax matches API expectations, and confirm network access to the API.
Links and References
- Connect Secure API documentation (refer to your organization's API docs for detailed query syntax and agent resource schema).