Lists all application groups configured in the system

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns every application group (whitelist, blacklist) along with metadata such as rule count, associated custom groups, and timestamps.

Endpoints

Request URL

https://{server-hostname}:8383/dcapi/appctrl/appgroups

Scope

AppControl.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/appctrl/appgroups \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
groupIDlong

Unique identifier for the application group

appGroupNamestring

Name of the application group

appGroupTypeinteger

Type of application group (1=Whitelist, 2=Blacklist, 3=Privilege)

platformIDinteger

Platform ID (1=Windows, 2=Mac)

appGroupCategoryinteger

Category (1=User Defined, 2=System)

applicationRuleCountlong

Total count of application rules in the group

associatedCustomGroupCountlong

Count of custom groups associated with this app group

descriptionstring

Description of the application group

createdTimelong

Creation timestamp in milliseconds since epoch

modifiedTimelong

Last modification timestamp in milliseconds since epoch

- HTTP code 401

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 500

Response Body - application/json
JSON object
Hide Sub-Attributes
errorCodestring

Internal error code: INTERNAL_ERROR when exception occurs fetching app groups

errorMessagestring

Detailed message: Exception Occurred While getting AppGroups

Possible Response Codes

200HTTP code
401HTTP code
500HTTP code

Sample Response: HTTP 200

List of application groups

Copied!
  [
    {
      "modifiedTime": 1700100000000,
      "associatedCustomGroupCount": 3,
      "appGroupName": "Whitelist Group 1",
      "appGroupType": 1,
      "groupID": 101,
      "description": "Default whitelist group",
      "createdTime": 1700000000000,
      "appGroupCategory": 1,
      "platformID": 1,
      "applicationRuleCount": 25
    }
  ]
                
Show full

Sample Response: HTTP 401

Authentication credentials missing or invalid

Copied!
  {
    "errorMessage": "Authentication credentials are missing or invalid",
    "errorCode": "UNAUTHORIZED"
  }
                
Show full

Sample Response: HTTP 500

Internal error while fetching application groups

Copied!
  {
    "errorMessage": "Exception Occurred While getting AppGroups",
    "errorCode": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 120 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.