Basic Parameters
| Parameter | Description |
|---|---|
| Filters | Filter Rules by specifying the field ID to filter by, and a list of values to include. Example: |
| Limit | Limit the returned number of results. |
| Offset | Use this to paginate through results. Insert the nextOffset value from the previous response to retrieve the next batch of results. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Add Ancestors | Select to show rules where the asset belongs to a group. |
| Add Builtins | Select to show global rules. |
| Entity Params | A JSON object of entity Parameters. Format: |
| With Count | Select to return the number of objects. |
Example Output
{
"items": [
{
"id": "<string>",
"localEntityId": "<string>",
"action": 0,
"createdBy": {
"createdBy": {
"id": "<string>",
"name": "<string>"
},
"userRole": 0,
"enforcementSource": 15
},
"description": "<string>",
"direction": 2,
"parentId": "<string>",
"parentType": 1,
"portsList": [
{
"ports": "<string>",
"protocolType": 1
}
],
"remoteEntityIdsList": [
"<string>"
],
"state": 0,
"createdAt": 1454731004689,
"updatedAt": 63585328123,
"localProcessesList": [
"<string>"
],
"servicesList": [],
"excludedLocalIdsList": [],
"updatedBy": {
"id": "<string>",
"name": "<string>"
},
"approvedBy": {
"id": "<string>",
"name": "<string>"
},
"ruleClass": 10,
"ipSecOpt": 1,
"srcUsersList": [],
"multipleLocalEntityIdsList": [],
"parentSwitchRuleId": "<string>",
"parentSwitchRuleType": 0,
"name": "<string>",
"changeTicket": "<string>",
"context": 0,
"aeOverridden": false,
"localEntityInfos": [
{
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"hasNetworkProtectionPolicy": false,
"hasIdentityProtectionPolicy": false,
"guid": "<string>",
"sid": "<string>"
}
],
"remoteEntityInfos": [
{
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"hasNetworkProtectionPolicy": false,
"hasIdentityProtectionPolicy": false,
"guid": "<string>",
"sid": "<string>"
}
],
"excludedEntityInfos": [],
"activitiesCount": 0,
"srcUserInfos": []
},
{
"id": "<string>",
"localEntityId": "<string>",
"action": 1,
"createdBy": {
"createdBy": {
"id": "<string>",
"name": "<string>"
},
"userRole": 1,
"enforcementSource": 6
},
"description": "<string>",
"direction": 0,
"parentId": "<string>",
"parentType": 0,
"portsList": [
{
"ports": "<string>",
"protocolType": 2
},
{
"ports": "<string>",
"protocolType": 13
}
],
"remoteEntityIdsList": [
"<string>"
],
"state": 2,
"createdAt": 1832869055821,
"updatedAt": 134091139417,
"localProcessesList": [
"<string>"
],
"servicesList": [],
"excludedLocalIdsList": [],
"updatedBy": {
"id": "<string>",
"name": "<string>"
},
"approvedBy": {
"id": "<string>",
"name": "<string>"
},
"ruleClass": 9,
"ipSecOpt": 1,
"srcUsersList": [],
"multipleLocalEntityIdsList": [],
"parentSwitchRuleId": "<string>",
"parentSwitchRuleType": 0,
"name": "<string>",
"changeTicket": "<string>",
"context": 2,
"aeOverridden": false,
"localEntityInfos": [
{
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"hasNetworkProtectionPolicy": false,
"hasIdentityProtectionPolicy": false,
"guid": "<string>",
"sid": "<string>"
}
],
"remoteEntityInfos": [
{
"id": "<string>",
"name": "<string>"
}
],
"excludedEntityInfos": [],
"activitiesCount": 1,
"srcUserInfos": []
}
]
}
Workflow Library Example
List Inbound Policies with Zero Networks and Send Results Via Email