This article will encompass all portalAPI calls that are related to /portalAPI/ComputerGroup/* 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
Table of Contents
ComputerGroupGetDropdownWithOrganization
ComputerGroupGetDropdownByOrganizationId
ComputerGroupGetForPermitApplication
ComputerGroupGetById
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetById
- Method: GET
- Description: This API is primarily used when navigating to the Assets icon and selecting the Groups page from the popout menu in the ThreatLocker Portal, then locating and selecting the group whose information you want to view. This API is also used whenever the computer group sidebar is accessed in the Portal. This API returns detailed group information for the selected group. To view information from a group in a different organization than the currently logged-in/managed organization, use the managedOrganizationId header as described below. Ensure the managedOrganizationId matches the location where the group exists.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Parameters
- computerGroupId: This field determines which group's information will be returned. To get a list of computerGroupIds, utilize the ComputerGroupGetByParameters API.
- Expects: <GUID> in format "00000000-0000-0000-0000-000000000000"
- computerGroupId: This field determines which group's information will be returned. To get a list of computerGroupIds, utilize the ComputerGroupGetByParameters API.
- Optional Body/Parameters
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- Permissions Needed for User
- Edit Computer Groups
- Install Computers
- View Computer Groups
ComputerGroupGetByParameters
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetByParameters
- Method: POST
- Description: This API is used when navigating to the Assets icon and selecting the Groups page from the popout menu in the ThreatLocker Portal. This API is also used when selecting the Groups tab when in another portion of the Assets section of the Portal. This API returns all your device groups based on the fields you select. To view groups in a different organization than the currently logged in/managed organization, use the managedOrganizationId header as described below.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Fields
- pageNumber and pageSize: These fields determine how many groups will be returned, as if the response were on the Device Groups page. However, this field does not follow the same conventions for pageNumber and pageSize as the Portal does (the Portal uses 25, 50, or 100 for pageSize). Any valid integer can be entered, and it will return in the selected formatting. For instance, if there are 5 groups to be returned but “pageNumber”: 1 and “pageSize”: 2, 2 entries will be returned per page, and the first two groups will be shown.
- Expects: An Integer value
- pageNumber and pageSize: These fields determine how many groups will be returned, as if the response were on the Device Groups page. However, this field does not follow the same conventions for pageNumber and pageSize as the Portal does (the Portal uses 25, 50, or 100 for pageSize). Any valid integer can be entered, and it will return in the selected formatting. For instance, if there are 5 groups to be returned but “pageNumber”: 1 and “pageSize”: 2, 2 entries will be returned per page, and the first two groups will be shown.
Required body
- Optional Body/Parameters
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- Fields
- osType: This field determines the OS type of the groups that will be returned. When this field is omitted, all OS types will be returned based on the other fields used. This field expects the Integer associated with the OSType:
- All = 0
- Windows = 1
- MAC = 2
- Linux = 3
- Windows XP = 5
- Ingester = 6
- iOS = 10
- Android = 11
- searchText: This field allows you to search/narrow the groups returned by inputting any text/details you want to search for. When this field is omitted, all groups will be displayed based on the other search fields. When text is entered into this field, it searches results by organization name and group name when showAllGroups is true or just by group name when showAllGroups is omitted or false, case-insensitively, effectively using wildcards on either side of the entered text. For example, when entering "Work" into this field, any group that contains the text "Work" anywhere in the name will be returned.
- Expects: Any text input
- showAllGroups: This field determines whether groups from your child organizations will be returned. When this field is omitted or set to false, only groups from the currently managed organization will be returned. When this field is set to true, all child organization groups, including grandchild organizations, will be returned.
- Expects: true or false
- osType: This field determines the OS type of the groups that will be returned. When this field is omitted, all OS types will be returned based on the other fields used. This field expects the Integer associated with the OSType:
Optional body
{
"osType": <Integer>,
"pageNumber": <Integer>,
"pageSize": <Integer>,
"searchText": "<String>",
"showAllGroups": <Boolean>
}
- Permissions Needed for User
- Edit Computer Groups
- Install Computers
- View Computer Groups
ComputerGroupGetDropdownWithOrganization
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetDropdownWithOrganization
- Method: GET
- Description: This API is used when copying policies from their respective pages, when looking to move computers on the Devices page, and when selecting to view computers from all child organizations on the Devices page in the ThreatLocker Portal. This API will return a list of all computer groups, including child organizations, and the organizations where they apply. This can be used to get all of the computer groups that can be installed into. The “label” field indicates the name of the organization or computer group. The “value” field is the organzationId or computerGroupId. When using the managedOrganizationId header, only the current organization and any child of the current organization will be displayed, unless the includeAvailableOrganizations field is used as described below.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Optional Body/Parameters
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- includeAvailableOrganizations: Will include a list of all the computer groups, including child AND parent organizations, and the organizations where they apply for any organization the effectively "logged in"/authenticated user has access to, regardless of the managedOrganizationId passed in.
- Permissions Needed for User
- Edit Computers
- Edit Computer Groups
- View Computers
ComputerGroupGetDropdownByOrganizationId
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetDropdownByOrganizationId
- Method: GET
- Description: This API is used on the Devices page in the ThreatLocker Portal when viewing an invidual computer and is typically used to load the computer groups where the computer can be moved to within the organization. This API will return a list of computer groups from a specific organization. To narrow the search results down more to specific OS Types, it is important to use both the computerGroupOSTypeId field and the computerOSType fields. Ensure that the computerGroupOSTypeId and the computerOSType apply to the same operating system and do not conflict. (1 goes with "windows", 2 goes with "mac", etc.). If looking to view the computer groups from a different organization than the currently logged in/managed organization, utilize the managedOrganizationId header as described below.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Optional Body/Parameters
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- computerGroupOSTypeId: This field expexts one of the Intergers from below to be entered AND should correspond with the computerOSType field from below:
- Windows = 1
- MAC = 2
- Linux = 3
- Windows XP = 5
- computerOSType: This field expects one of the strings from below to be entered AND should correspond with the ID entered above:
- "windows"
- "mac"
- "linux"
- "windows xp"
- Permissions Needed for User
- Edit Computers
- View Computers
- Install Computers
ComputerGroupGetForDownload
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetForDownload
- Method: GET
- Description: This API is used on the Devices page in the ThreatLocker Portal when selecting the Install Computer button and selecting a computer group to install into. This API will display the installation information for a computer group, including organizationId, name, OSType, whether the EULA has been accepted, whether a computer can be installed into the computer group, and whether there is a valid install link for the group. Utilize the install key for the computer group you would like to return the information from.
- Manadatory Body/Parameters
- Valid APIKey/Authorization Token in header
- installKey - 24 characters found on the Computer Groups page
- Optional Body/Parameters
- N/A
- Permissions Needed for User
- Since a valid install key is required to call this, no permissions are required
ComputerGroupGetForPermitApplication
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetForPermitApplication
- Method: GET
- Description: This API is used on the Response Center page in the ThreatLocker Portal when responding to an Application Control Approval Request and choosing a specific computer group to apply the request's Application Control policy to. This API populates the dropdown option when selecting Computer Group under the Applies To section of the Approval Request in the ThreatLocker Portal. To view the computer groups available from an Approval Request from a different organization than the currently logged in/managed organization, utlilize the managedOrganizationId header as described below.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Optional Body/Parameters
- osType: This field determines the OS Type of the computer groups you are looking to view. OS Types to select from are listed below. This field expects the Integer associated with the OS Type to be entered:
- Windows = 1
- MAC = 2
- Linux = 3
- Windows XP = 5
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- osType: This field determines the OS Type of the computer groups you are looking to view. OS Types to select from are listed below. This field expects the Integer associated with the OS Type to be entered:
- Permissions Needed for User
-
Approve for Entire Organization
-
Approve for Group
-
Approve for Single Computer
-
Approve for Single Computer Application Only
-
View Approvals
-
ComputerGroupGetGroupAndComputer
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetGroupAndComputer
- Method: GET
- Description: This API is used in most sidebars where policies are configured in the ThreatLocker Portal, including but not limited to, Application Control Policies, Storage Control Policies, and Network Control Policies. This API will retrieve a list of computers and groups depending on the parameters passed into the endpoint. If looking to view the computer groups from a different organization than the currently logged in/managed organization, utilize the managedOrganizationId header as described below.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Optional Body/Parameters
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- OSType: This field will limit the computer groups displayed to those of the selected OS Type, OS Types to select from are listed below and this field expects the Integer associated with the OS Type:
- All = 0
- Windows = 1
- MAC = 2
- Linux = 3
- Windows XP = 5
- includeGlobal: This field will determine whether the Global group, used for permitting applications on a global scale across your organization(s), is displayed in the results.
- Expects: true or false
- includeOrganizations: This field can also include the organizations that the user/currently authorized user has access to. If managing a grandchild organization, only the grand-child organization will be displayed. If managing a child organization, the parent organization and any child organizations of that child will be displayed, a grand-child of the parent organization.
- Expects: true or false
- includeParentGroups: This field will show all the parent computer groups, of the organization currently managed as long as the currently logged-in/authenticated user has access to the organization, including grandparents of the currently managed organization.
- Expects: true or false
- includeLoggedInObjects: This field will display additional information in the “label” fields of each computer group, computer, and organizations. For instance, if the organizations that are a direct parent of the currently managedOrganization will show “PARENT\\organizationName”, for the computer groups it will show “organizationName\\computerGroupName”, and for computers it will show “organizationName\\computerGroupName\\computerName”
- Expects: true or false
- Permissions Needed for User
- Super Admin
ComputerGroupInsert
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupInsert
- Method: POST
- Description: This API is used when navigating to the Assets icon and selecting the Groups page from the popout menu in the ThreatLocker Portal, locating and selecting the "+ Computer Group" button, entering and selecting new computer group details, and selecting "Create". This API creates new device groups in your organization. To create a new group in a different organization than the currently logged in/managed organization, use the managedOrganizationId header as described below.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Fields
Note: While these are the only fields required to call this API, it is important to note that only using these fields will create a new group with the following options:
- No initial Learning for newly installed devices
- No automatic policy creation during any initial Learning period
- Hearbeat interval of 60 seconds
- No excluded processes
- Baseline All Paths
- No additional customer guidelines set at the organization level will be displayed for Cyber Hero Requests
-
-
- name: This field specifies the name of the new group. Any name can be entered, and the computerGroupId and install key will be automatically generated.
- Expects: Any text input
- osType: This field determines the OS type of the new group. This field expects the Integer associated with the OSType:
- Windows = 1
- MAC = 2
- Linux = 3
- Windows XP = 5
- Ingester = 6
- iOS = 10
- Android = 11
- name: This field specifies the name of the new group. Any name can be entered, and the computerGroupId and install key will be automatically generated.
-
Required body
- Optional Body/Parameters
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- Fields
- autoCreatePolicies: This field determines how policies are created during the initial Learning period in the new group. When this field is omitted, the "Do Not Learn" option is selected from the options below. This field expects one of the Integers associated with the option you want. For more information on how these function, see the KB article below:
-
-
-
- Do Not Learn = 0
- Computer Level Policies = 1
- Computer Group Level Policies = 2
- System Policies for Computer = 3
- baselineAllPaths: This field determines whether all file paths will be scanned when a Baseline scan is completed on a device in the new group. When this field is omitted or set to true, the group will Baseline all paths. When this field is set to false, all paths except those listed in the baselineOptions field will be scanned.
- Expects: true or false
- baselineOptions: This field determines which file paths will be ignored during a Baseline scan on a device in the new group. This field should only be used when the baselineAllPaths field is set to false. The paths entered into this field will be ignored during the Baseline process, but may be learned during Learning Mode if they execute. Be sure to use \\ instead of a single \ for the existing slashes in the path. Wildcards can be used in this field in the same way as in the ThreatLocker Portal, as shown in this example: c:\\users\\*\\Documents\\*
- Expects: Full file path or partial path with wildcards
-
cyberHeroUseOrgSettings: This field determines whether the new group will use the Cyber Hero Management (CHM) request instructions from the organization. When this field is omitted or set to false, the organization settings will not be used, and instructions for the group can be specified using the tlInstructions field. When this field is set to true, the organization's CHM instructions will be used.
- Expects: true or false
- exclusions: This field determines if any processes will be excluded from processing in the new group. This should only be used in very specific circumstances. Nothing will be blocked or logged in the Unified Audit if it is being run by the process set to be excluded. No ThreatLocker policies will take effect on processes set to be excluded. When this field is omitted, no processes will be excluded. One or multiple exclusions can be added. As demonstrated in the "Optional body" section, each exclusion requires each of the fields listed below, except when setting exclusionType: 4. In this case, no file path can be specified; only the field value should be used. For additional information on excluding processes, see the KB article below:
-
-
Excluded Processes | ThreatLocker Help Center
-
-
-
- exclusionType: This field determines the exclusion type that will be applied. This field expects the Integer associated with the exclusion type:
- Execute = 1
- Install = 2
- Storage = 3
- Network = 4
- filePath: This field determines if a file path should also be matched with the entered excluded process. If you do not want to specify a file path for this process, you can leave this field as "". Be sure to use \\ instead of a single \ for the existing slashes in the path. Wildcards can be used in this field in the same way as in the ThreatLocker Portal, as shown in this example: c:\\users\\*\\documents\\*
- Expects: Full file path or partial path with wildcards
- value: This field determines the process path that will be excluded from processing. This field expects only a full process name, regardless of the directory (e.g., python.exe, code.exe). Wildcards cannot be used in this field.
- Expects: Full process path as described above
- exclusionType: This field determines the exclusion type that will be applied. This field expects the Integer associated with the exclusion type:
- initialMonitorModeHours: This field determines the initial Learning Mode duration applied to the new group. When this field is omitted, the initial Learning Mode duration will be set to 0. This field expects the length of time to be entered in hours. For display purposes in the Portal, the hours entered into this field are converted to days and hours. The maximum number of hours that can be entered is 90,000 (3,750 days). When entering an Integer between 89,976 and 90,000, "Indefinite" Learning will be selected for the group. Anything less than 89,976 will set the Learning length accordingly. When the autoCreatePolicies field is not used, no policies will be created for this Learning period.
- Expects: Any non-negative Integer value less than 90,000
-
-
Note: The options that can be applied to the new group in the options field below should be used with extreme care as changing these options may greatly impact ThreatLocker's ability to monitor and secure your environment.
-
-
- options: This field determines the options that will apply to the new group. When this field is omitted, no options will be applied to the new group. One or multiple options can be entered into this field. For each option, enter the text of the option exactly as it appears in the KB article above. The Optional body section formats adding four options. The options available are listed in the KB article above.
- Expects: Text of any organization option exactly as listed in the article above
- policyRefreshIntervalSeconds: This field determines the Heartbeat Interval, how often the ThreatLocker Agent checks in to the Portal in seconds, which will be assigned to the new group. When this field is omitted, the Heartbeat Interval will be set to 60. The minimum number of seconds that can be entered is 8, with a maximum of 300 (5 minutes).
- Expects: Any non-negative Integer value between 8 and 300
- tlInstructions: This field determines the Cyber Hero Management instructions that will be applied to the new group. When this field is omitted, no instructions will be applied to the new group. This field should only be used when the cyberHeroUseOrgSettings field is omitted or set to false.
- Expects: Any text input
- options: This field determines the options that will apply to the new group. When this field is omitted, no options will be applied to the new group. One or multiple options can be entered into this field. For each option, enter the text of the option exactly as it appears in the KB article above. The Optional body section formats adding four options. The options available are listed in the KB article above.
-
Optional body
- Permissions Needed for User
- Edit Computer Groups
ComputerGroupUpdateById
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupUpdateById
- Method: POST
- Description: This API is used when navigating to the Assets icon and selecting the Groups page from the popout menu in the ThreatLocker Portal, locating and selecting the group you wish to make changes to, making your changes, and selecting "Save". This API updates device groups in your organization. To edit a group in a different organization than the currently logged in/managed organization, use the managedOrganizationId header as described below.
Be sure to review the Optional Body/Parameters section. Review the current configuration of the group you are making changes to. Many fields listed are not required to be entered/included in the call to this API. If some fields are not included, you may unintentionally make changes to your group.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Fields
- computerGroupId: This field determines which group will be updated. The same computerGroupId as the one currently applied to the group is expected. It cannot be updated since the group has already been created.
- Expects: <GUID> in format "00000000-0000-0000-0000-000000000000"
- name: This field determines the name that will be applied to the group. Any name can be entered. If you do not wish to change the group's name, enter the existing name.
- Expects: Any text input
- osType: The same OS Type as the one currently applied to the group is expected. It cannot be updated since the group has already been created. This field expects the Integer associated with the OSType:
- Windows = 1
- MAC = 2
- Linux = 3
- Windows XP = 5
- Ingester = 6
- iOS = 10
- Android = 11
- computerGroupId: This field determines which group will be updated. The same computerGroupId as the one currently applied to the group is expected. It cannot be updated since the group has already been created.
Required body
- Optional Body/Parameters
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- Fields
- autoCreatePolicies: This field determines how policies are created during the initial Learning period in the group. When this field is omitted, the "Do Not Learn" option is selected from the options below. This field expects one of the Integers associated with the option you want. If you do not wish to change the initial Learning policy creation setting for the group, enter the existing Integer value. For more information on how these settings function, see the KB article below:
-
-
-
- Do Not Learn = 0
- Computer Level Policies = 1
- Computer Group Level Policies = 2
- System Policies for Computer = 3
- baselineAllPaths: This field determines whether all file paths will be scanned when a Baseline scan is completed on a device in the group. When this field is omitted or set to true, the group will Baseline all paths. When this field is set to false, all paths except those listed in the baselineOptions field will be scanned.
- Expects: true or false
- baselineOptions: This field determines which file paths will be ignored during a Baseline scan on a device in the group. This field should only be used when the baselineAllPaths field is set to false. The paths entered into this field will be ignored during the Baseline process, but may be learned during Learning Mode if they execute. Be sure to use \\ instead of a single \ for the existing slashes in the path. Wildcards can be used in this field in the same way as in the ThreatLocker Portal, as shown in this example: c:\\users\\*\\Documents\\*. If an excluded path(s) is already applied to the group, it will need to be re-entered in order to keep the path applied to the group.
- Expects: Full file path or partial path with wildcards
- cyberHeroUseOrgSettings: This field determines whether the group will use the Cyber Hero Management (CHM) request instructions from the organization. When this field is omitted or set to false, the organization settings will not be used, and instructions for the group can be specified using the tlInstructions field. When this field is set to true, the organization's CHM instructions will be used. If this field is omitted and cyberHeroUseOrgSettings was previously set to true, cyberHeroUseOrgSettings will default to false, and the group will not use the organization's instructions.
- Expects: true or false
- exclusions: This field determines if any processes will be excluded from processing in the group. This should only be used in very specific circumstances. Nothing will be blocked or logged in the Unified Audit if it is being run by the process set to be excluded. No ThreatLocker policies will take effect on processes set to be excluded. When this field is omitted, no processes will be excluded. One or multiple exclusions can be added. As demonstrated in the "Optional body" section, each exclusion requires each of the fields listed below, except when setting exclusionType: 4. In this case, no file path can be specified; only the field value should be used. If an excluded process(es) is already applied to the group, it must be re-entered with each supporting field, either exactly as configured or with desired changes, to keep the exclusion(s) applied. For additional information on excluding processes, see the KB article below:
-
-
Excluded Processes | ThreatLocker Help Center
-
-
-
- exclusionType: This field determines the exclusion type that will be applied. This field expects the Integer associated with the exclusion type:
- Execute = 1
- Install = 2
- Storage = 3
- Network = 4
- filePath: This field determines if a file path should also be matched with the entered excluded process. If you do not want to specify a file path for this process, you can leave this field as "". Be sure to use \\ instead of a single \ for the existing slashes in the path. Wildcards can be used in this field in the same way as in the ThreatLocker Portal, as shown in this example: c:\\users\\*\\documents\\*
- Expects: Full file path or partial path with wildcards
- value: This field determines the process path that will be excluded from processing. This field expects only a full process name, regardless of the directory (e.g., python.exe, code.exe). Wildcards cannot be used in this field.
- Expects: Full process path as described above
- exclusionType: This field determines the exclusion type that will be applied. This field expects the Integer associated with the exclusion type:
- initialMonitorModeHours: This field determines the initial Learning Mode duration applied to the group. When this field is omitted, the initial Learning Mode duration will be set to 0. This field expects the length of time to be entered in hours. For display purposes in the Portal, the hours entered into this field are converted to days and hours. The maximum number of hours that can be entered is 90,000 (3,750 days). When entering an Integer between 89,976 and 90,000, "Indefinite" Learning will be selected for the group. Anything less than 89,976 will set the Learning length accordingly. When the autoCreatePolicies field is not used, no policies will be created for this Learning period. If this field is omitted and a Learning Mode duration is already assigned, it will be reset to 0. Any duration entered here will overwrite the existing one.
- Expects: Any non-negative Integer value less than 90,000
-
-
Note: The options that can be applied to the group in the options field below should be used with extreme care as changing these options may greatly impact ThreatLocker's ability to monitor and secure your environment.
-
-
- options: This field determines the options that will apply to the group. When this field is omitted, no options will be applied to the group. One or multiple options can be entered into this field. For each option, enter the text of the option exactly as it appears in the KB article above. The Optional body section formats adding four options. If an option(s) is already applied to the group, it must be re-entered to keep the option(s) applied. The options available are listed in the KB article above.
- Expects: Text of any organization option exactly as listed in the article above
- policyRefreshIntervalSeconds: This field determines the Heartbeat Interval, how often the ThreatLocker Agent checks in to the Portal in seconds, which will be assigned to the group. When this field is omitted, the Heartbeat Interval will be set to 60. The minimum number of seconds that can be entered is 8, with a maximum of 300 (5 minutes). If this field is omitted and a Heartbeat Interval is already assigned, it will be reset to 60. Any duration entered here will overwrite the existing one.
- Expects: Any non-negative Integer value between 8 and 300
- tlInstructions: This field determines the Cyber Hero Management instructions that will be applied to the group. When this field is omitted, no instructions will be applied to the group. This field should only be used when the cyberHeroUseOrgSettings field is omitted or set to false. If this field is omitted or left blank (null or " "), and there are instructions already applied to the group, they will be removed. Any instructions entered here will overwrite any existing ones.
-
- Expects: Any text input
-
- options: This field determines the options that will apply to the group. When this field is omitted, no options will be applied to the group. One or multiple options can be entered into this field. For each option, enter the text of the option exactly as it appears in the KB article above. The Optional body section formats adding four options. If an option(s) is already applied to the group, it must be re-entered to keep the option(s) applied. The options available are listed in the KB article above.
-
Optional body
- Permissions Needed for User
- Edit Computer Groups
ComputerGroupUpdateForDelete
https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupUpdateForDelete
- Method: POST
- Description: This API is used when navigating to the Assets icon and selecting the Groups page from the popout menu in the ThreatLocker Portal, locating and selecting the group(s) you wish to delete, and selecting "Delete". This API is also used when clicking the trash can icon on the Groups page next to the group you wish to delete. This API deletes one or multiple device groups in your organization. When deleting a group(s) in a different organization than the currently logged in/managed organization, use the managedOrganizationId header as described below.
Currently, this API is only able to delete groups that are all within the same organization. Ensure that when deleting groups from your organization that each group you are looking to delete is in the same organization.
- Required Body/Parameters
- Valid APIKey/Authorization Token in header
- Fields
Note: For each group you wish to delete, enter each field below, as shown in the Required body section.
-
-
- computerGroupId: This field expects the computerGroupId of the group that will be deleted.
- Expects: <GUID> in format "00000000-0000-0000-0000-000000000000"
- name: This field determines the name that will be logged in the System Audit. This field should match the name of the group that will be deleted to ensure accurate logging.
- Expects: Text of the group's name
- organizationId: This field expects the organizationId of the organization where the group that will be deleted exists. The organizationId should match the managedOrganizationId header used, when applicable.
- Expects: <GUID> in format "00000000-0000-0000-0000-000000000000"
- computerGroupId: This field expects the computerGroupId of the group that will be deleted.
-
Required body
- Optional Body/Parameters
- In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
- Permissions Needed for User
- Edit Computer Groups
Help Center