/portalAPI/ComputerCheckin/*

2 min. readlast update: 10.31.2024

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 will return the check in history of a computer when a valid ComputerId is inserted. Listed below is a sample body that will display the check-in information for a specific computer. Insert a valid computerId in the "00000000-0000-0000-0000-000000000000" field below, then any integer value can be used for the pageSize and pageNumber. These values determine how many checkins will be returned as if the response was on the Computer Details sidebar. 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’s check-ins will be shown. The hideHeartbeat value can be true or false. True will hide the heartbeat check-ins from being displayed and only show full check-ins from the selected computerId. 
  • Required body/permissions
    • Requires valid APIKey/Authorization Token in header
    • Body:

{ 

"computerId": "00000000-0000-0000-0000-000000000000", 

"pageSize": 1, 

"pageNumber": 25, 

"hideHeartbeat" : false 

} 

  • Permissions
    • Allow View Checkin History
Was this article helpful?