List Recommended Rules

Get recommended firewall rules based on the flow data gathered by vRealize Network Insight. This API provides service to retrieve recommended rules based on flow traffic that is observed between two groups OR for a single group based on all the inbound and outboud traffic for that group. In case two groups are provided, both the groups should be of same type. Currently supported groups are Application, Tier, NSXSecurityGroup, EC2SecurityGroup.

Request

URI

POST

https://vrni.example.com/api/ni/micro-seg/recommended-rules

COPY

Request Body

Recommended Rules Request

RecommendedRulesRequest of type(s) application/json

Optional

{
    "group_1": {
        "entity": {
            "entity_type": "Tier",
            "entity_id": "10000:562:1904698621"
        }
    },
    "group_2": {
        "entity": {
            "entity_type": "Tier",
            "entity_id": "10000:562:1780351215"
        }
    }
}

MicroSecGroup

group_1

Optional

group_1

MicroSecGroup

group_2

Optional

group_2

TimeRange

time_range

Optional

time_range

boolean

include_external

Optional

When True, includes ungrouped endpoints outside defined scope

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

Returns RecommendedRules of type(s) application/json

{
    "results": [
        {
            "sources": [
                {
                    "entity_id": "string",
                    "entity_type": "VirtualMachine",
                    "entity_name": "string"
                }
            ],
            "destinations": [
                {
                    "entity_id": "string",
                    "entity_type": "VirtualMachine",
                    "entity_name": "string"
                }
            ],
            "protocols": [
                "string"
            ],
            "port_ranges": [
                {
                    "start": 0,
                    "end": 0
                }
            ],
            "action": "string"
        }
    ],
    "time_range": {
        "start_time": 1597247025,
        "end_time": 1597247999
    }
}

array of RecommendedRule

results

Optional

results

TimeRange

time_range

Optional

time_range

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details