[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api

List Recommended Rules

Description

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

Request

URL

URL


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

Request Body

Request Body

RecommendedRulesRequest of type(s) application/json Optional

Recommended Rules Request

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

group_2 Optional

boolean
include_external Optional

When True, includes ungrouped endpoints outside defined scope


time_range Optional
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns RecommendedRules of type(s) application/json
{
	"results": [
		{
			"action": "ALLOW",
			"destinations": [
				{
					"entity_id": "string",
					"entity_type": "VirtualMachine"
				}
			],
			"port_ranges": [
				{
					"end": 0,
					"start": 0
				}
			],
			"protocols": [
				"string"
			],
			"sources": [
				{
					"entity_id": "string",
					"entity_type": "VirtualMachine"
				}
			]
		}
	],
	"time_range": {
		"end_time": 1597247999,
		"start_time": 1597247025
	}
}
array of RecommendedRule
results Optional

time_range Optional
Errors

Errors

400

Bad Request


401

Unauthorized


500

Internal Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"group_1":{"entity":{"entity_id":"10000:562:1904698621","entity_type":"Tier"}},"group_2":{"entity":{"entity_id":"10000:562:1780351215","entity_type":"Tier"}}}' https://vrni.example.com/api/ni/micro-seg/recommended-rules


[{"label":"Latest (6.4.0)","version":"latest"}]
vrealize-network-insight-api
Feedback

Was this page helpful?