We’re currently experiencing a high volume of support requests, which may result in longer response times — thank you for your patience and understanding.
cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

This documentation is for the new preview UI. It’s still being refined and is subject to change. For documentation for the old UI, see Knowledge Base.

Article link copied to clipboard
Updated
Published
27 min read

The Lansweeper Connector enables seamless integration with the Lansweeper API to manage assets, software, vulnerabilities, and users.
It allows you to retrieve, filter, update, and delete asset-related data across sites using configurable actions and filters.

Component key: lansweeperConnector

API Documentation

This connector is built using the Lansweeper API Documentation.

Connections

The Lansweeper Connector uses a built-in global connection, so you don't need to set up a connection manually. One is automatically created and used for each connector action. The information below on generating a personal access token and configuring OAuth 2.0 authentication is provided for reference only. No action is required on your part to configure a connection.

Personal Access Token

Follow the instructions to create a personal access token.

Input Type Comments Example
Access Token
accessToken
string / Required A Lansweeper token generated for the user. lsf_eyJ0b2tlbiI6ImQDZhZTM...7f480235

OAuth 2.0 Authentication

Follow the instructions to create an OAuth connection.

For the OAuth redirect URL, enter:

Input Type Comments Example
Authorize URL string / Required The OAuth 2.0 authorization URL for Lansweeper. https://app.lansweeper.com/authorize-app/420996b1f1c606ec878a77814658dbdd
Token URL string / Required The URL used to generate the authorization code. https://api.lansweeper.com/api/integrations/oauth/token
Client ID string / Required Client ID received when creating the Lansweeper app. 420996b1f1c606ec878a77814658dbdd
Client Secret password / Required Client Secret received when creating the Lansweeper app. 9ifrZ-I01oK7bYXih9jvTc-sTshbsgbgAQ8R...
Grant Type string OAuth 2.0 grant type. refresh_token

Obtainable Lansweeper Data

The Lansweeper Connector can return a wide range of asset, software, user, and vulnerability information.
Use the paths listed below when filtering data, building queries, or interpreting results.

Each entry includes:

  • Input Path: The field name used within the Lansweeper Connector.
  • Description: Details about the field’s purpose.

Asset Fields

Input Path Description
asset.active_directory_ad.computer_description The asset's description as set in the Active Directory description attribute.
asset.active_directory_ad.computer_ou The Active Directory Organizational Unit (OU) the asset belongs to.
asset.active_directory_ad.group.description The Active Directory group description to which the asset belongs.
asset.active_directory_ad.group.name The Active Directory group name to which the asset belongs.
asset.active_directory_ad.group.type The Active Directory group type to which the asset belongs.
asset.asset_group.name An asset group the asset belongs to. Asset groups can be added via Configuration > Asset management > Groups.
asset.cloud.environment_id Azure Subscription ID/AWS Account ID/GCP Project number
asset.cloud.environment_name Azure Subscription name/AWS Account name/GCP Project ID
asset.cloud.provider It refers to the cloud provider (Azure, Aws, Gcp)
asset.cloud.region It refers to the region where the cloud asset is located (east-us).
asset.cloud.tags The tags (Azure, AWS) and labels (GCP) you configured in your cloud providers admin consoles.
asset.cloud.tenant_org_id Azure Tenant/AWS Org. Unit/GCP Org.
asset.cloud.tenant_org_name Azure Tenant/AWS Org. Unit/GCP Org.
asset.custom_field.key Asset custom field primary key
asset.custom_field.name Name of the custom field
asset.custom_field.value Value of the custom field
asset.db_server_instance.database.name The names of individual databases contained within the SQL Server instance installed on the asset.
asset.db_server_instance.display_version The friendly version of the SQL Server instance.
asset.db_server_instance.edition The edition or SKU name of the installed SQL Server.
asset.db_server_instance.service_pack The service pack level of the SQL Server instance.
asset.db_server_instance.version The semantic version of the SQL Server instance.
asset.disk.disk_drive.caption The name assigned to the disk drive, typically provided by the system.
asset.disk.disk_drive.freespace The available storage space remaining on the logical disk, measured in bytes.
asset.disk.disk_drive.size The total storage capacity of the logical disk, measured in bytes.
asset.display.display.caption The name of the video controller installed on the asset.
asset.display.display.driver_version The version number of the driver installed for the video controller.
asset.financial.acquisition_type How the asset was acquired. Standard value field which is meant to be filled in manually. Can be reconfigured via Configuration > Asset Management > Standard values.
asset.financial.cost_center The cost center of the asset. Standard value field which is meant to be filled in manually. Can be reconfigured via Configuration > Asset Management > Standard values.
asset.financial.invoice_number The invoice number of the asset. Standard value field which is meant to be filled in manually. Can be reconfigured via Configuration > Asset Management > Standard values.
asset.financial.po_date The date of the Purchase Order (PO) of the asset. Standard value field which is meant to be filled in manually. Can be reconfigured via Configuration > Asset Management > Standard values.
asset.financial.po_number The purchase order (PO) number of the asset. This field is meant to be filled in manually.
asset.financial.purchase_date When the asset was purchased. This field is automatically populated for the following manufacturers: Dell, Fujitsu, IBM, Lenovo and Toshiba. For other manufacturers, it is meant to be filled in manually.
asset.financial.vendor_name The name of the vendor of the asset. Standard value field which is meant to be filled in manually. Can be reconfigured via Configuration > Asset Management > Standard values.
asset.general.category It refers to the classification of the asset type ( computer, storage, network...).
asset.general.description Description of the asset as configured locally on the asset.
asset.general.device_version Device version, retrieved from plug and play devices via the UPnP, DNS-SD or SSDP protocol.
asset.general.dns_name Name of the asset as returned by a DNS server.
asset.general.domain Domain the asset belongs to, e.g. Active Directory domain.
asset.general.domain_role The role of a Windows computer in a workgroup or domain. Can be used to identify workstations, servers or domain controllers.
asset.general.firmware The firmware of this module of the OT device.
asset.general.fqdn The fully qualified domain name of the asset.
asset.general.ip_location_end_ip End IP Location in dot format: XXX.XXX.XXX.XXX.
asset.general.ip_location_name The location of the asset based on its IP address. IP locations can be managed via Inventory > IP locations.
asset.general.ip_location_start_ip Start IP Location in dot format: XXX.XXX.XXX.XXX.
asset.general.key A unique identifier provided by Lansweeper to distinguish individual assets.
asset.general.last_change Last time the asset record was changed.
asset.general.last_update Last time the asset was updated.
asset.general.manufacturer The manufacturer of the asset. Can be retrieved via scanning or manually filled in.
asset.general.memory The total amount of RAM installed on the asset in MB.
asset.general.model The model of the asset. Can be retrieved via scanning or manually filled in.
asset.general.name The name of the asset as determined by scanning.
asset.general.notes Notes added manually to the asset as a comment.
asset.general.origin Whether the asset was scanned via an OT installation or an IT installation.
asset.general.os_build_number The specific build number of the operating system installed on the asset.
asset.general.os_name The full name of the operating system that could include the name, version, market version and/or build.
asset.general.os_version The version of the operating system.
asset.general.processor The CPU model of the asset.
asset.general.serial_number The serial number of the asset. Can be retrieved via scanning or manually filled in.
asset.general.state The state of the asset. Automatically modified by cleanup options (Configuration > Server Options). Can be manually changed.
asset.general.state_key Identifier of the asset state.
asset.general.subtype The asset's subtype as determined by scanning.
asset.general.system_sku Stock Keeping Unit (SKU) of the asset. Can be retrieved via scanning or manually filled in.
asset.general.type The asset's type as determined by scanning. Can be manually changed.
asset.general.uptime How long the asset has been turned on since the last boot.
asset.general.warranty_end_date When the asset's warranty expires. This field is automatically populated for the following manufacturers: Dell, Fujitsu, IBM, Lenovo and Toshiba. For other manufacturers, it is meant to be filled in manually.
asset.hardware.chassis_name The name of the asset’s physical chassis Note that there are 3 chassis names that identify laptops: "Portable", "Laptop" and "Notebook". .
asset.lifecycle.hw_end_of_sale The date at which the manufacturer stopped or will stop offering the asset's model.
asset.lifecycle.hw_end_of_support The date at which the manufacturer stopped or will stop supporting the asset's model.
asset.lifecycle.hw_general_availability The date at which the asset's model was first made publicly available.
asset.lifecycle.os_end_of_support The date at which the publisher stopped or will stop supporting the asset's operating system.
asset.location.barcode The asset's bar code. This field is meant to be filled in manually.
asset.location.branch_office The branch office the asset belongs to. This field is meant to be filled in manually.
asset.location.building The building in which the asset is located. This field is meant to be filled in manually.
asset.location.contact Contact person of the asset. This field is automatically populated for devices scanned via SNMP. In other cases it is meant to be filled in manually.
asset.location.department The department the asset belongs to. This field is meant to be filled in manually.
asset.location.industry The industry the asset belongs to. Standard value field which is meant to be filled in manually. Can be reconfigured via Configuration > Asset Management > Standard values.
asset.location.location The location of the asset. This field is automatically populated for devices scanned via SNMP. In other cases it is meant to be filled in manually.
asset.location.owner The owner of the asset. Standard value field which is meant to be filled in manually. Can be reconfigured via Configuration > Asset Management > Standard values.
asset.maintenance.last_backup The last time a full backup was taken of the asset. This field is meant to be filled in manually.
asset.maintenance.last_image The last time a full image was made of the asset. This field is meant to be filled in manually.
asset.maintenance.last_patched The last time the asset was patched. This field is meant to be filled in manually.
asset.network.ip_address Primary IP address of the asset, as determined by Lansweeper.
asset.network.mac_address The MAC address of the primary interface of the asset, as determined by Lansweeper.
asset.ot.bus_number It refers to the OT bus number that holds OT hardware modules.
asset.ot.is_main_module Whether or not this module is the OT asset's main module.
asset.ot.module_number It refers to a specific position in the OT rack and contains an OT hardware module.
asset.ot.module_type The module type of this module of the OT device.
asset.ot.part_number It is the OT asset identifier reference.
asset.ot.protocol The OT protocol through which the asset was last scanned.
asset.ot.route The path the OT sensor took to communicate with this specific device.
asset.relation.child_asset_key Child's asset key of the relation.
asset.relation.comment Comment added to the relation.
asset.relation.end_date Contains the end date, only if explicitly filled in.
asset.relation.last_change Last time the relation record was changed.
asset.relation.parent_asset_key Parent's asset key of the relation.
asset.relation.start_date Creation date of the relation or date manually selected during creation.
asset.relation.type Relation type name or reverse name depending on its hierarchy. A parent will see the name, a child will see the reverse name.
asset.relation.user_domain The Domain of the related user
asset.relation.user_name The name of the related user
asset.scan.created_at When the asset was first created, manually or via a scanning target.
asset.scan.installation_id The identifier of the scanner which detected the asset.
asset.scan.issue.last_change Last time the scan issue record was changed.
asset.scan.issue.message The message content of the scan issue, may contain information about the scanning target or credential names. It is recommended to select this field together with the scan issue "Type".
asset.scan.issue.type The type of scan issue encountered. It is recommended to select this field together with the scan issue “Message”.
asset.scan.last_active_scan Last scan attempt made for the asset by the Active Scanning scanning method, successful or unsuccessful.
asset.scan.last_lsagent_scan_date The last time the asset was scanned via the LsAgent scanning agent.
asset.scan.last_scan_attempt The last time the asset was attempted to be scanned, successfully or unsuccessfully.
asset.scan.last_scan_server Name of the last scanning server to scan the asset.
asset.scan.last_successful_scan The last time the asset was successfully scanned, via any scanning method.
asset.scan.lsagent_version The version of the LsAgent client on the asset when the last scan was sent.
asset.scan.scanner_type Asset's scanner type. Possible responses are: Unknown, LS, SCCM, ActiveDirectory, HyperV, AWS, Azure, ChromeOS, Citrix, Intune, vCenter, AirWatch, Esxi, AssetRadar, AzureAD, Local, Quick, or Cloud.
asset.windows.os_current_timezone Amount of time the unitary computer system is offset from Coordinated Universal Time (UTC).
asset.windows.registry.last_change The date and time when the scanned registry entry was last modified on the Windows computer.
asset.windows.registry.path The path in the Windows Registry where a specific value is located.
asset.windows.registry.value The actual value stored at the specified path in the Windows Registry.
asset.windows.registry.value_name The name of a specific registry entry on the asset. A record is created only if the entry exists in the Windows computer's registry.

Software Fields

Input Path Description
software.antivirus.enabled True/False value indicating whether the Windows computer's antivirus software is enabled. This information does not exist on Windows server operating systems.
software.antivirus.last_change Last time the the anti-virus software record was changed.
software.antivirus.name The name of the Windows computer's antivirus software. This information does not exist on Windows server operating systems.
software.antivirus.up_to_date True/False value indicating whether the Windows computer's antivirus software is up to date. This information does not exist on Windows server operating systems.
software.general.architecture The processor architecture the software was developed for.
software.general.category The second level of classification in Lansweeper’s software taxonomy.
software.general.edition The version identifier of a program that typically informs functional capabilities. E.g. Enterprise Edition.
software.general.install_date Oldest software installation date of the software found among all assets.
software.general.language Language in which the software is available.
software.general.last_change The date of the last change detected in the software inventory.
software.general.market_version The commercial, friendly name given by the vendor to a particular software version. E.g. SQL Server 2022.
software.general.name The name of the software application installed on the asset.
software.general.os_family The general classification of the operating system installed on the asset, such as Windows, Linux, or macOS.
software.general.publisher The organization that develops and markets the software.
software.general.short_version The version limited to the Major and Minor version number.
software.general.type The first level of classification in Lansweeper's software taxonomy.
software.general.version The complete version number of the software. Typically consists of several components, such as: Major Version Number, Minor Version Number, Patch Version Number, Build Number, and other additional information. E.g. v2.5.3.8421

User Fields

Input Path Description
user.general.ad_active Indicates whether the user's account is active in Active Directory (AD).
user.general.cannot_change_password Indicates whether the user is prohibited from changing their password.
user.general.company The company name associated with the user, often part of organizational records.
user.general.country_code The numeric code corresponding to the user's country.
user.general.department The department within the organization to which the user is assigned.
user.general.description An optional description or notes field for the user account, providing additional context.
user.general.display_name The full name of the user as it appears in systems or directories, often combining first and last names.
user.general.domain The domain to which the user belongs, identifying their network environment.
user.general.email The user's primary email address for communication.
user.general.employee_id A unique identifier assigned to the user as an employee in Active Directory.
user.general.employee_number A unique number assigned to the employee within the organization.
user.general.employee_type The type of employee, such as full-time, part-time, or contractor.
user.general.first_name The given name or first name of the user.
user.general.key A unique identifier provided by Lansweeper to distinguish individual users.
user.general.last_change The date and time when the user's attributes were last modified.
user.general.last_login The most recent date and time the user logged into the system.
user.general.last_name The family or surname of the user.
user.general.name The user's account name or identifier within the system.
user.general.office The physical or virtual office location assigned to the user.
user.general.ou The AD organizational unit where the user account is stored, reflecting their placement in the hierarchy.
user.general.password_changeable_date The earliest date and time the user is allowed to change their password.
user.general.password_expiration_date_ The date and time when the user's password is set to expire.
user.general.password_last_change The date and time when the user's password was last updated.
user.general.password_never_expires Indicates whether the user's password is exempt from expiration policies.
user.general.password_required Indicates whether a password is required for the user's account.
user.general.title The user's job title within the organization.
user.general.upn The user's name, basically the ID of the user, in an email-like format.
user.general.username The username of an Active Directory user associated with the asset.
user.group.is_admin Indicates whether the user is part of an administrative group (e.g., local admins).
user.group.name The name of the Active Directory group to which a user or device belongs.
user.last_user.domain Domain of the last logged on user.
user.last_user.username Username of the last logged on user.

Vulnerability Fields

Input Path Description
vulnerability.cvss.attack_complexity Describes how difficult a successful attack using this vulnerability is.
vulnerability.cvss.attack_vector Describes the context in which a vulnerability is exploitable.
vulnerability.cvss.avaiability Measures the impact on availability that successful use of a vulnerability has.
vulnerability.cvss.base_score An industry standard metric (CVSS - Common Vulnerability Scoring System) by which one vulnerability is compared with another for purposes of prioritization.
vulnerability.cvss.confidentiality Measures the impact on confidentiality that successful use of a vulnerability has.
vulnerability.cvss.integrity Measures the impact on integrity that successful use of a vulnerability has.
vulnerability.cvss.privilege_required Describes the level of privilege (or access) an attacker must have to use the vulnerability successfully.
vulnerability.cvss.scope Indicates whether the use of a vulnerability affects components beyond the originally compromised system ("changed") or remains confined to the initially vulnerable component ("unchanged").
vulnerability.cvss.user_interaction Indicates whether a user, other than the attacker, must perform an action for the exploitation of the vulnerability to be successful.
vulnerability.cwe.weakness_enumeration The Common Weakness Enumeration (CWE) is a category system for hardware and software weaknesses and vulnerabilities.
vulnerability.epss.last_modified This field records the last time the EPSS data for this particular vulnerability was updated.
vulnerability.epss.percentile This is the percentile rank of the vulnerability compared to all others in the EPSS dataset.
vulnerability.epss.score The Exploit Prediction Scoring System (EPSS) score is a metric that estimates the likelihood of a vulnerability being exploited in the wild within the next 30 days.
vulnerability.exploitability.botnets Documented instances where the vulnerability has been used by botnets to compromise systems were reported.
vulnerability.exploitability.cisa_due_date This is the limit date when the vulnerability must be patched by Government and U.S Military Organizations to be compliant with the Binding Operational Directive released by CISA at the end of 2021.
vulnerability.exploitability.cisa_exploited CISA Exploited indicates that the vulnerability has been leveraged by adversaries to carry out attacks.
vulnerability.exploitability.cisa_ransomware_campaign It indicates whether the CVE is associated with the ransomware campaign.
vulnerability.exploitability.commercial_exploit An exploit code or method for the vulnerability that is available through commercial channels was found.
vulnerability.exploitability.exploit_maturity Indicates the state of existing exploit techniques and code availability.
vulnerability.exploitability.exploit_type The Exploit Type field helps distinguish between high impact exploits, like initial access exploits, and lower impact exploits, like denial of service exploits.
vulnerability.exploitability.exploitability Explotable is a LS calculated value to indicate that there is information to know if a vulnerability can be exploited.
vulnerability.exploitability.exploited_in_the_wild It refers to a CVE that is actively being used by attackers in real-world situations.
vulnerability.exploitability.msrc_exploitation It is a rate that means the likelihood of a vulnerability being exploited.
vulnerability.exploitability.nvd_exploitability It is the probability offered by NVD that this CVE could be exploited by an attacker.
vulnerability.exploitability.nvd_impact It refers to the potential impact that the attack could generate with this CVE based on NVD metrics.
vulnerability.exploitability.public_exploit An exploit code or method for the vulnerability that is freely available to the public was found.
vulnerability.exploitability.ransomware Documented cases where the vulnerability has been leveraged by ransomware groups to conduct attacks were reported.
vulnerability.exploitability.threat_actors Documented instances where the vulnerability has been actively exploited by malicious threat actors were reported.
vulnerability.general.affected_product List of product names that are present in the asset and cause this vulnerability.
vulnerability.general.category One or more items telling the root cause type (O.S., Software or Hardware).
vulnerability.general.cve CVE stands for Common Vulnerabilities and Exposures. CVE is an ID that uniquely identifies a vulnerability.
vulnerability.general.id CVE stands for Common Vulnerabilities and Exposures. CVE is an ID that uniquely identifies a vulnerability.
vulnerability.general.published_on Indicate the date and time that the CVE was published to the NVD (NIST database).
vulnerability.general.risk_score The base score is an industry-standard metric (CVSS - Common Vulnerability Scoring System) by which one vulnerability is compared with another for prioritisation purposes.
vulnerability.general.severity Indicates how severe a vulnerability is (based on the base score).
vulnerability.general.source Asset creation source
vulnerability.general.updated_on Indicate the date and time that the CVE was last modified in the NVD (NIST database).
vulnerability.general.vendor List of vendor names that are present in the asset and cause this vulnerability.
vulnerability.patch.info Indicates whether LS possesses any information regarding the patch for that CVE.

Lansweeper Trigger

Get notified when assets are created, updated, deleted, or when a new discovery source is added.

Key: lansweeperTrigger

The Lansweeper connector uses webhooks to deliver event notifications. These notifications serve as triggers, allowing you to build workflows that automatically run when specific events occur.

To test the Lansweeper Trigger:

1. Select Trigger Events

  • In the first step of your workflow, add the Lansweeper Trigger from the Lansweeper connector.
  • Choose the events you want to receive notifications for.

2. Enable the Test Trigger Environment

  • Save the workflow after selecting your events.
  • Select the Lansweeper Trigger, then Test.
  • Select Advanced testing > Instance deploy to activate the test environment.

The connector will now begin receiving notifications from Lansweeper.

3. Stop the Test Trigger Environment

  • To stop receiving notifications, select Advanced testing > Instance delete.

Note:

  • If you make changes to your workflow and want to test them, remember to Save your draft and select the Advanced testing > Instance deploy again.
  • Instance deploy and Instance delete are only for testing while building workflows.
  • Once the workflow is enabled, event notifications are received automatically—no manual action is required.
Input Comments Example
Connection Existing Lansweeper connection.
New Asset Notify on new asset creation. true
Asset Updated Notify on asset property changes. true
Asset Deleted Notify on asset deletion. true
New Discovery system Notify when a new discovery system is added. true

Filters

Some actions allow you to filter data within the same request, improving workflow efficiency. However, the number of fields available for filtering is limited. See the tables below for details.

Filter Assets

Defines filters for assets.

Input Comments Example
Conjunction (string) Specifies the conjunction to use when filtering data. Determines how multiple conditions are combined in the query. AND, OR
Conditions (array) Defines the condition used to filter data. See the table below.

Conditions

Input Comments Example
Path (string / Required) The specific field or attribute to apply the condition to. Key, Cloud Category, Cloud Provider, Cloud Region, Cloud Tags, Created At, Description, DNS Name, Domain, Environment ID, Environment Name, IP Address, Last Seen, Last Updated, Last User Name, MAC Address, Manufacturer, Model, Module Type, Name, Origin, Purchase Date, Serial Number, State, Sub Type, Tenant Org ID, Tenant Org Name, Type, Warranty End Date
Operator (string / Required) The operator used for the condition. Equal, Not equal, Smaller than, Smaller than or equal, Greater than, Greater than or equal, Exists, Like, Regexp, Contains, Not contains
Value (string / Required) The value against which the condition will be evaluated. asset123

Filter Vulnerabilities

Defines filters for vulnerabilities.

Input Comments Example
Conjunction (string) Specifies the conjunction to use when filtering data. Determines how multiple conditions are combined in the query. AND, OR
Conditions (array) Defines the condition used to filter data. See the table below.

Conditions

Input Comments Example
Path (string / Required) The field or attribute to apply the condition to. Attack Complexity, Attack Vector, Availability Impact, Base Score, Confidentiality, CVE, Integrity, Privilege Required, Published On, Risk Score, Scope, Source, Severity, Updated On, User Interaction
Operator (string / Required) The operator used for the condition. Equal, Not equal, Smaller than, Smaller than or equal, Greater than, Greater than or equal, Exists, Like, Regexp, Contains, Not contains
Value (string / Required) The value against which the condition will be evaluated. CVE-2025-21307

Filter Software

Defines filters for software.

Input Comments Example
Fields (List of String / Required) Fields or attributes to apply the condition to. State Name, Software, Operating System, Publisher, Version, Language, Edition, Market Version, Architecture, Category, Type, Short Version
Type (string / Required) The operator type to use for the condition. LIKE, EQUAL
Value (string / Required) The value against which the condition will be evaluated. Edge

Filter Users

Defines filters for users.

Input Comments Example
Conjunction (string) Specifies the conjunction to use when filtering data. Determines how multiple conditions are combined in the query. AND, OR
Conditions (array) Defines the condition used to filter data. See the table below.

Conditions

Input Comments Example
Path (string / Required) The field or attribute to apply the condition to. Key, Employee Id, Employee Number, Employee Type, Enabled in AD, Last Logon, Organizational Unit, Office, Password Changeable Date, Password Expiration Date, Password Last Set, Password Never Expires, Password Required, User Principal Name, User Cannot Change Password
Operator (string / Required) The operator used for the condition. Equal, Not equal, Smaller than, Smaller than or equal, Greater than, Greater than or equal, Exists, Like, Regexp, Contains, Not contains
Value (string / Required) The value against which the condition will be evaluated. MTIwLUFkVXNlci1hNTg4OWQ0MS1hYWM5LTQ0NGEtYmZhMy0yODU3ZGE3NDU1MmE=

Filter Discovery Sources

Defines filters for discovery sources.

Input Comments Example
Conjunction (string) Specifies the conjunction to use when filtering data. Determines how multiple conditions are combined in the query. AND, OR
Conditions (array) Defines the condition used to filter data. See the table below.

Conditions

Input Comments Example
Path (string / Required) The field or attribute to apply the condition to. ID, State Value, External Id, Type
Operator (string / Required) The operator used for the condition. Equal, Not equal, Exists
Value (string / Required) The value against which the condition will be evaluated. false

Actions

List of Assets

Fetches a list of assets.
Key: listAssetsAction

Input Comments Example
Connection (connection / Required)
Max Records (number / Optional) Maximum number of records to retrieve in a single request. 10
Filter (GraphQL / Valid JSON format) Valid filter object in JSON format. Use condition values listed below for path, operator, and value. { conjunction: OR, conditions: [ { path: "asset.general.key", operator: EQUAL, value: "04c2d1c8-13c8-30b0-87d4-4891827d621a" }, { path: "asset.general.description", operator: EQUAL, value: "This is test description 153 run" } ] }
Additional Assets Details (Value List / Optional) Additional asset fields to include in the response. asset.scan.created_at, asset.general.category, asset.cloud.provider, asset.cloud.region, asset.cloud.tags, asset.general.description, asset.general.domain, asset.cloud.environment_id
Page Number The page number to fetch. 2
Page Size Number of records to fetch. Default: 500. 200

Pagination Scenarios

Page Number Page Size Max Records (Limit) Expected Result
NA NA NA Fetch all records. Example: if total is 15,000 → return all 15,000 records.
NA NA 100 Return the first 100 records.
2 NA 100 Default page size = 500. Skip first 500, return 100. Range: 501–600
2 100 100 Page size = 100. Skip first 100, return next 100. Range: 101–200
2 200 100 Page size = 200. Skip 200, return next 100. Range: 201–300 (but capped at 100)
2 100 200 Page size = 100. Skip first 100, return next 100. Range: 101–200
2 100 NA Page size = 100. Skip first 100, return next 100. Range: 101–200
2 NA NA Default page size = 500. Skip 500, return next 500. Range: 501–1000

Condition Values for Asset Filters

Input Comments Example
Path (string / Required) The field or attribute to apply the condition to. user.last_user.username, asset.general.key, asset.scan.created_at, asset.general.category, asset.cloud.provider, asset.cloud.region, asset.cloud.tags, asset.general.description, asset.general.domain, asset.cloud.environment_id, asset.cloud.environment_name, asset.cloud.tenant_org_id, asset.cloud.tenant_org_name, asset.network.ip_address, asset.scan.last_successful_scan, asset.network.mac_address, asset.general.name, asset.general.type, asset.general.last_update, asset.general.dns_name, asset.general.manufacturer, asset.general.model, asset.ot.module_type, asset.general.origin, asset.financial.purchase_date, asset.general.serial_number, asset.general.state, asset.general.subtype, asset.general.warranty_end_date
Operator (string / Required) Operator to use for the condition. EQUAL, NOT_EQUAL, SMALLER_THAN, SMALLER_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, EXISTS, LIKE, REGEXP, CONTAINS, NOT_CONTAINS
Value (string / Required) The value against which the condition will be evaluated. asset123

Get Asset by Key

Retrieves an asset by its unique key.
Key: getAssetByKeyAction

Input Comments Example
Connection (connection / Required)
Asset Key (string / Required) The unique key of the asset to retrieve. 00031243-7800-3b08-a345-a79ce8cbb96e
Additional Assets Details (Value List / Optional) Additional asset fields to include in the response. asset.scan.created_at, asset.general.category, asset.cloud.provider, asset.cloud.region, asset.cloud.tags, asset.general.description

List Asset States

Fetches a list of asset states.
Key: listAssetStatesAction

Input Comments Example
Connection (connection / Required)

Edit Asset by Key

Edits an asset by its unique key.
Key: editAssetAction

Input Comments Example
Connection (connection / Required)
Asset Key (string / Required) The unique key of the asset to edit. 4b7f1f20-43ea-4913-95e2-ab8f50db9db4
Asset Description Value to update. This is test Description
Asset Domain Value to update. lansweeper.com
Asset IP address Value to update. 0.0.0.0
Asset Name Value to update. Test_asset
Acquisition Type Value to update. Lease
Barcode Value to update. barcode
Branch Office Value to update. branchOffice
Building Value to update. Building
Comment Value to update. This is edit asset
Contact Value to update. contact
Cost Center Value to update. Dummy
Department Value to update. Department
DNS Name Value to update. Crest
Industry Value to update. Dummy
Invoice Number Value to update. INC0001
Last Backup Value to update. 12-31-2024
Last Image Value to update. 12-31-2024
Last Patched Value to update. 12-31-2024
Location Value to update. Location
Manufacturer Value to update. Microsoft
Model Value to update. 750-881
PO Number Value to update. 20
Owner Value to update. Dummy
PO Date Value to update. 12-31-2024
Purchase Date Value to update. 12-31-2024
Serial Number Value to update. de098822
System SKU Value to update.
State Key Value to update. MS1TdGF0ZS02ZGQyY2MyZC0zOWM2LTQ2YzAtYTAxOS1hYTQ2YWUzNmM1MjI=
Vendor Name Value to update. Dummy
Warranty End Date Value to update. 12-31-2024
Asset Custom Fields To Edit (Key-Value List / Optional) User-defined custom fields to edit. Add the field key and provide a value. See API reference.

Delete Assets by Key

Deletes one or more assets by their keys.
Key: deleteAssetsAction

  • Supports up to 500 asset IDs in one operation.
Input Comments Example
Connection (connection / Required)
Asset Keys to Delete (string / Required) The unique keys of the assets to delete. ae8cfa9a-6b56-48de-90e0-7e252b050f64, 8b68c735-6b4e-48f6-9480-5aa67b629af9

List of Assets with Specific Software Installed

Fetches assets by software name and (optionally) publisher.
Key: listAssetsBySoftwareAction

Input Comments Example
Connection (connection / Required)
Software Name (string / Required) The name of the software. Edge Update
Publisher Name (string / Optional) The publisher of the software. Microsoft
Max Records (number / Optional) Maximum records to retrieve in one request. 10
Filter (GraphQL / Valid JSON format) Valid filter object in JSON format. Use condition values for path, operator, and value. { conjunction: OR, conditions: [ { path: "asset.general.key", operator: EQUAL, value: "04c2d1c8-13c8-30b0-87d4-4891827d621a" }, { path: "asset.general.description", operator: EQUAL, value: "This is test description 153 run" } ] }
Additional Assets Details Additional fields to include in the response. asset.scan.created_at, asset.general.category, asset.cloud.provider

List of Assets with Vulnerabilities

Fetches assets affected by specific vulnerabilities (CVEs).
Key: listAssetsByVulnerabilityAction

Input Comments Example
Connection (connection / Required)
Vulnerabilities CVE List (string / Required) CVE IDs to filter assets. CVE-2020-32969, CVE-2022-22919
Max Records (number / Optional) Maximum records to retrieve in one request. 10
Filter (GraphQL / Valid JSON format) Valid filter object in JSON format. Use condition values for path, operator, and value. { conjunction: OR, conditions: [ { path: "asset.general.key", operator: EQUAL, value: "04c2d1c8-13c8-30b0-87d4-4891827d621a" }, { path: "asset.general.description", operator: EQUAL, value: "This is test description 153 run" } ] }
Additional Assets Details Additional fields to include in the response. For the complete list, see Asset Fields. asset.scan.created_at, asset.general.category, asset.cloud.provider

Report Details

Deprecated Action

This action is still functional but no longer recommended. It remains available for backward compatibility and will be removed in a future version.

Retrieves report details by report ID in CSV format.
Key: getReportByIdAction

Input Comments Example
Connection (connection / Required)
Report Id (string / Required) Unique ID of the report. 66t1b73399bdd7d9a1835dob

List of Authorized Reports

Deprecated Action

This action is still functional but no longer recommended. It remains available for backward compatibility and will be removed in a future version.

Lists reports authorized for the site.
Key: listReportsAction

Input Comments Example
Connection (connection / Required)

Get Software Details

Retrieves software details by software name and optional publisher.
Key: getSoftwareDetailsByNameAction

Input Comments Example
Connection (connection / Required)
Software Name (string / Required) Name of the software to retrieve. Edge Update
Publisher (string / Optional) Publisher of the software. Microsoft
Additional Software Details (List of fields) Additional fields to include in the response. For the complete list, see Software Fields software.general.architecture, software.general.category, software.general.edition

List of Software

Lists available software.
Key: listSoftwareAction

Input Comments Example
Connection (connection / Required)
Max Records (number / Optional) Maximum number of records to retrieve. 10
Filter (GraphQL / Valid JSON format) Valid filter object in JSON format. Use condition values below for fields, operator, and value. [ { fields: ["software.general.name"], value: "Edge Update", type: LIKE } ]

Condition Values for Software Filters

Input Comments Example
Fields (List of software fields) Fields to filter software on. asset.general.state, software.general.name, software.general.os_family, software.general.publisher, software.general.version, software.general.language, software.general.edition, software.general.market_version, software.general.architecture, software.general.category, software.general.type, software.general.short_version
Operator (string / Required) Operator to use for the condition. EQUAL, LIKE
Value (string / Required) The value against which the condition will be evaluated. win

List Software Present in Asset

Lists software installed on a specific asset.
Key: listSoftwaresPresentInAsset

Input Comments Example
Connection (connection / Required)
Asset Key (string Value List / Required) The unique key of the asset. 00031243-7800-3b08-a345-a79ce8cbb96e

Get Vulnerability Details

Retrieves details of a vulnerability by CVE.
Key: getVulnerabilityByCVEAction

Input Comments Example
Connection (connection / Required)
Vulnerability CVE (string / Required) CVE identifier of the vulnerability. CVE-2020-32969
Additional Vulnerability Details (string / Value List) Additional fields to include in the response. For the complete list, see Vulnerability Fields vulnerability.cvss.attack_complexity, vulnerability.cvss.attack_vector, vulnerability.cvss.availability, vulnerability.cvss.base_score, vulnerability.cvss.confidentiality, vulnerability.general.cve

List of Vulnerabilities

Lists vulnerabilities.
Key: listVulnerabilitiesAction

Input Comments Example
Connection (connection / Required)
Max Records (number / Optional) Maximum number of records to retrieve. 10
Filter (GraphQL / Valid JSON format) Valid filter object in JSON format. Use condition values below for path, operator, and value. { conjunction: AND, conditions: [ { path: "vulnerability.general.cve", operator: LIKE, value: "CVE-2025-21307" }, { path: "vulnerability.cvss.attack_complexity", operator: LIKE, value: "Low" } ] }
Additional Vulnerability Details (string / Value List) Additional vulnerability-related fields to include in the response. Asset Keys, Availability Impact, Cause, Confidentiality, Exploitability, Integrity, Patchable, Privilege Required, Updated On, User Interaction, Weakness Enumeration

Condition Values for Vulnerability Filters

Input Comments Example
Path (string / Required) Field or attribute to apply the condition to. vulnerability.cvss.attack_complexity, vulnerability.cvss.attack_vector, vulnerability.cvss.availability, vulnerability.cvss.base_score, vulnerability.cvss.confidentiality, vulnerability.general.cve, vulnerability.cvss.integrity, vulnerability.cvss.privilege_required, vulnerability.general.published_on, vulnerability.general.risk_score, vulnerability.cvss.scope, vulnerability.general.source, vulnerability.general.severity, vulnerability.general.updated_on, vulnerability.cvss.user_interaction
Operator (string / Required) Operator to use for the condition. EQUAL, NOT_EQUAL, SMALLER_THAN, SMALLER_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, EXISTS, LIKE, REGEXP, CONTAINS, NOT_CONTAINS
Value (string / Required) The value against which the condition will be evaluated. CVE-2019

List Vulnerabilities in Assets

Lists vulnerabilities present in specified assets.
Key: listVulnerabilitiesInAssetsAction

Input Comments Example
Connection (connection / Required)
Asset Key (string / Required Value List) Unique key(s) of the asset(s). 00031243-7800-3b08-a345-a79ce8cbb96e
Max Records (number / Optional) Maximum number of records to retrieve. 10
Filter (GraphQL / Valid JSON format) Valid filter object in JSON format. Use condition values for path, operator, and value. { conjunction: AND, conditions: [ { path: "vulnerability.general.cve", operator: LIKE, value: "CVE-2025-21307" }, { path: "vulnerability.cvss.attack_complexity", operator: LIKE, value: "Low" } ] }
Additional Vulnerability Details (string / Value List) Additional vulnerability-related fields to include in the response. vulnerability.cvss.attack_complexity, vulnerability.cvss.attack_vector, vulnerability.cvss.availability, vulnerability.cvss.base_score, vulnerability.cvss.confidentiality, vulnerability.general.cve

List of Users

Lists users.
Key: listUsersAction

Input Comments Example
Connection (connection / Required)
Max Records (number / Optional) Maximum number of records to retrieve. 10
Filter (GraphQL / Valid JSON format) Valid filter object in JSON format. Use condition values below for path, operator, and value. { conjunction: OR, conditions: [ { path: "user.general.key", operator: LIKE, value: "" }, { path: "user.general.employee_id", operator: LIKE, value: "" } ] }
Additional User Details (string / Value List) Additional fields to include in the response. For the complete list, see User Fields user.general.key, user.general.employee_id, user.general.employee_number, user.general.employee_type, user.general.ad_active, user.general.last_login, user.general.ou, user.general.office

Condition Values for User Filter

Input Comments Example
Path (string / Required) Field or attribute to apply the condition to. user.general.key, user.general.employee_id, user.general.employee_number, user.general.employee_type, user.general.ad_active, user.general.last_login, user.general.ou, user.general.office, user.general.password_changeable_date, user.general.password_expiration_date, user.general.password_last_change, user.general.password_never_expires, user.general.password_required, user.general.upn, user.general.cannot_change_password
Operator (string / Required) Operator to use for the condition. EQUAL, NOT_EQUAL, SMALLER_THAN, SMALLER_THAN_OR_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, EXISTS, LIKE, REGEXP, CONTAINS, NOT_CONTAINS
Value (string / Required) Value against which the condition will be evaluated. MS1BZFVzZXItYTU4ODlkNDEtYWFjOS00NDRhLWJmYTMtMjg1N2RhNzQ1NTJi

List of Discovery Sources

Lists discovery sources.
Key: listDiscoverySourcesAction

Input Comments Example
Connection (connection / Required)
Max Records (number / Optional) Maximum number of records to retrieve. 10
Filter (GraphQL / Valid JSON format) Valid filter object in JSON format. Use condition values below for path, operator, and value. { conjunction: OR, conditions: [ { operator: EXISTS, path: "id", value: "true" } ] }

Condition Values for Discovery Source Filters

Input Comments Example
Path (string / Required) Field or attribute to apply the condition to. id, state.value, externalId, type
Operator (string / Required) Operator to use for the condition. EQUAL, NOT_EQUAL, EXISTS
Value (string / Required) Value against which the condition will be evaluated. true

Get Relations

Lists relations.
Key: listOfRelationsAction

Input Comments Example
Connection (connection / Required)

Create Relation

Creates a new relation between assets or users.
Key: createRelationAction

Input Comments Example
Connection (connection / Required)
Relation Kind (User Relation or Asset Relation / Required) Defines whether the relation links a user to an asset or two assets together. User Relation
Parent Key (string / Required) Key of the parent asset in the relation. 00031243-7800-3b08-a345-a79ce8cbb96e
Child Key (string / Required) Key of the child asset (in an asset relation) or the user (in a user relation). 00051f91-203a-3d1b-9475-dd6b3139be05
Relation Type Key (string / Required) Key of the relation type. Obtainable from the Get Relations action. MTAtQXNzZXRSZWxhdGlvblR5cGUtNmRkMmNjMmQtMzljNi00NmMwLWEwMTktYWE0NmFlMzZjNTIy
Start Date (DateTime / Optional) Start date of the relation (yyyy-MM-dd). 2025-08-29
End Date (DateTime / Optional) End date of the relation (yyyy-MM-dd). 2025-08-29
Comment (string / Optional) Comment for the relation. It is the asset relation

Match Assets

Matches Lansweeper assets against external data.
Key: matchAssetsAction

Input Comments Example
Connection (connection / Required)
External Data External data in JSON array format, where each object represents an asset. [ { "srno": "23123", "details": { "name": "Asset 01", "model": "model-1" }, "network": { "mac": "00:1A:2B:3C:4D:5E", "ip_address": "192.168.2.4" }, "custom": { "domain": "aws-domain" } } ]
Serial Number Path Path in external data for serial number. srno
Asset MAC Address Path Path in external data for MAC address. network.mac
Asset Name Path Path in external data for asset name. details.name
Asset IP Address Path Path in external data for IP address. network.ip_address
Model Path Path in external data for model name. details.model
Additional Match Field 1 Field Corresponding Lansweeper field for additional match field 1. asset.general.domain
Additional Match Field 1 Path Path in external data for additional match field 1. custom.domain
Additional Match Field 2 Field Corresponding Lansweeper field for additional match field 2. asset.general.domain
Additional Match Field 2 Path Path in external data for additional match field 2. custom.domain
Case Sensitive Match Boolean flag for case-sensitive matching. true
Additional Assets Details (Value List / Optional) Additional asset fields to include in the response. asset.scan.created_at, asset.general.category, asset.cloud.provider, asset.cloud.region

Output

Field Path Description
results.matched Array containing matched assets.
results.matched[].key Unique identifier for an asset.
results.matched[].matchedBy Fields that contributed to the match.
results.matched[].matchPercentage Percentage of fields that matched.
results.matched[].unmatchFields Fields that did not match.
results.matched[].unmatchFields[].lansweeperFieldValue Value of the Lansweeper asset for the unmatched field.
results.matched[].unmatchFields[].lansweeperFieldName Field name in Lansweeper.
results.matched[].unmatchFields[].externalFieldValue Value of the external asset for the unmatched field.
results.matched[].unmatchFields[].externalFieldName Field name in the external source.
results.matched[].externalAssetData Source data for the external asset.
results.matched[].lansweeperAssetData Source data for the Lansweeper asset.
results.unmatched External assets not matched to any Lansweeper asset.

Implementation Approach

  1. Validate input: Confirm that external data is in an array-of-objects format. Validate external data path inputs.

    • Example valid formats:
      • detail.name
      • detail.name[0]
  2. Perform matching:

    • Build GraphQL query from conditions and extra fields.
    • Call Lansweeper API and handle pagination if needed.
    • Compare external and Lansweeper data (hash maps recommended for efficiency).
  3. Calculate match percentage:

    • Assign weights to fields (see table).
    • Adjust weights dynamically to total 100.
    Field Name Weight
    Serial Number 40
    MAC Address 30
    Asset Name 15
    IP Address 10
    Model Name 5
    Additional Match Field 1 0
    Additional Match Field 2 0
    • Example: Only Serial Number is matched.
      • Weight Adjustment = 100 / (40+30) = 1.429
      • Adjusted Serial Number = 40 × 1.429 = 57.14
      • Match Percentage = 57.14
  4. Build matched asset list: Include details of matches and unmatched fields.

  5. Build unmatched asset list: Identify which external assets were not matched to any Lansweeper asset.