Get Groups Related Rule Counts

Get Groups Related Rule Counts
Get aggregate related rule counts for groups

Returns aggregate DFW and IDS rule counts for each of the specified groups. Each result entry contains the group ID along with its DFW rule count and IDS rule count.

Notes:

  • start_time is required. Either site_id or site_ids must also be provided.
  • Either group_ids or group_paths must be provided, but not both. Each list accepts up to 20 entries.
  • relationship_type: CONTAINS (default) counts rules that directly reference the group in their applied-to, source, or destination scope.
  • relationship_type: EFFECTIVE_MEMBERS counts rules affecting individual VMs within the group rather than the group directly.
  • To retrieve the full list of DFW rules for a specific group, use POST /visualization/security-analysis/groups/{group-id}/related-dfw-rules.
  • To retrieve the full list of IDS rules for a specific group, use POST /visualization/threat-analysis/groups/{group-id}/related-ids-rules.
  • To get equivalent rule counts for computes instead of groups, use POST /visualization/security-analysis/computes/related-rule-counts.
Request
URI
POST
https://{api_host}/intelligence/visualization/security-analysis/groups/related-rule-counts
COPY
Request Body

Wrapper request for GroupsRelatedRuleCounts

VizGroupsRelatedRuleCountsRequest of type(s) application/json
Required  
This request body class requires all of the following: VizTimeIntervalListSiteRequest , InlineVizGroupsRelatedRuleCountsRequest1 
{
    "start_time": 0,
    "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
    "group_ids": [
        "24725593-6e9b-41b9-9681-e8b3a273849a"
    ],
    "relationship_type": "CONTAINS"
}
Authentication
This operation uses the following authentication methods.
Responses
200

success

Returns RelatedRuleCountsResult of type(s) application/json 
{
    "results": [
        {
            "entity_id": "24725593-6e9b-41b9-9681-e8b3a273849a",
            "dfw_rule_count": 0,
            "ids_rule_count": 0
        }
    ]
}
array of object
results
Optional

The list of entity rule counts.


400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


default

Error

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/intelligence/visualization/security-analysis/groups/related-rule-counts
On This Page
Security Explorer Operations
POST
Get App Flow Details
POST
Export App Flow Details
POST
Get App Related Rules
POST
Get Group Related Dfw Rules
POST
Get Group Related Ids Rules
POST
Get Computes Related Rule Counts
POST
Get Groups Related Rule Counts
POST
Get Apps Flow Topology
POST
Get Compute Flow Connections
POST
Get Compute Flow Connections Flow Type
POST
Get Computes Flow Topology
POST
Query Compute Flow Details
POST
Get Compute Flow Details
POST
Export Compute Flow Details
POST
Get Compute Related Ids Rules
POST
Get Compute Related Rules
POST
Get Compute Related Info
POST
Get Environment Pair Flow Details
POST
Export Environment Pair Flow Details
POST
Query Flow Export Jobs
GET
Get Flow Export Job
DELETE
Delete Flow Export Job
PUT
Update Flow Export Job
POST
Get Group Flow Connections
POST
Get Group Flow Connections Flow Type
POST
Get Groups Flow Topology
POST
Fetch Groups Topology Other Members
POST
Get Pinned Group Flow Topology
POST
Get Group Flow Details
POST
Export Group Flow Details
POST
Query Workloads Affected
POST
Get Compute Related Ids Signatures
POST
Get Ids Signature Events History
POST
Get Infra Monitoring Flow Details
POST
Get Infra Monitoring Leaked Flow Details
POST
Export Infra Monitoring Leaked Flow Details
POST
Export Infra Monitoring Flow Details
POST
Get Export Job Download Key