/portalAPI/OnlineDevices/*

2 min. readlast update: 10.31.2024

This article will encompass all portalAPI calls that are related to /portalAPI/OnlineDevices/* endpoints

 

Be sure to input the instance your organization exists on for each call. This is indicated with the "INSTANCE" text in each endpoint. Linked here is a KB to find your instance: 

Locating Your Organization's Instance | ThreatLocker Help Center

 

OnlineDevicesGetByParameters

https://portalapi.INSTANCE.threatlocker.com/portalapi/OnlineDevices/OnlineDevicesGetByParameters

  • Method: GET
  • Description: This API will return a list of online computers without ThreatLocker installed. These originate from the Logon Scripts that you can setup in your environment to routinely check and ensure ThreatLocker is installed onto all the machines you manage. The parameters that can be passed into this call are pageNumber” and “pageSize” and are optional but recommended for sorting. These values determine how many computers will be returned as if the response was on the Computers page. However, these fields do not follow the same conventions of the pageNumber and pageSize values as the portal does (pageSize in the portal is 25, 50, 100, 500). Any valid integer can be entered, and it will return the computers in the selected formatting. For instance, if there are 5 computers to be returned but “pageNumber” : 1 and “pageSize” : 2, 2 entries will be returned per page, and the first two computers will be shown. To view computers in a child organization, use the "managedOrganizationId" header with the organizationId from where you would like to view the Online Computers in.
  • Mandatory body/parameters
    • Requires valid APIKey/Authorization Token in header
  • Optional parameters
    • pageNumber” : 1
    • "pageSize" : 25
    • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
  • Permissions
    • View Comptuers
    • Install Computers
Was this article helpful?