/portalAPI/ComputerCheckin/*

This article will encompass all portalAPI calls that are related to /portalAPI/ComputerCheckin/* 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

ComputerCheckinGetByParameters

https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerCheckin/ComputerCheckinGetByParameters

• Method: POST
• Description: This API is utilized on the Devices page when viewing an individual computer and navigating to the Check-ins tab in the computer sidebar on the ThreatLocker Portal. This API will return the check-in history of a computer when a valid ComputerId is provided. The fields below determine which computer's check-ins will be returned and how many check-ins will be returned.
• Required Body/Parameters
  • Valid APIKey/Authorization Token in header
  • Fields
    • computerId: This field will determine which computer's check-ins will be returned.
      • Expects: <GUID> in format "00000000-0000-0000-0000-000000000000" 
    • pageSize and pageNumber: This field determines how many check-ins will be displayed. However, this field does not follow the same numbering conventions of the pageNumber and pageSize values as the Portal does (pageSize in the Portal is 25, 50, 100). Any valid integer can be entered and it will return the checkins in the selected formatting. For instance, if there are 5 check-ins to be returned but “pageNumber” : 1 and “pageSize” : 2, 2 entries will be returned per page, and the first two computer check-ins will be shown.
      • Expects: An Integer value
    • hideHeartbeat: This field will determine whether the heartbeat check-ins will be displayed or not. True will hide the heartbeat check-ins from being displayed and only show full check-ins from the selected computerId.
      • Expects: true or false
  • Required body:

• Permissions Needed for User
  • Allow View Checkin History