Get Rules

Get Rules

Get All the Rules for a Section

Request
URI
GET
https://nsxmanager.your.domain/api/v1/firewall/sections/{section-id}/rules
COPY
Path Parameters
string
section-id
Required

section-id

Query Parameters
string
included_fields
Optional

Comma separated list of fields that should be included to result of query

string
applied_tos
Optional

AppliedTo's referenced by this section or section's Firewall Rules .

integer
page_size
Optional

Maximum number of results to return in this page (server may return fewer)

string
sort_by
Optional

Field by which records are sorted

string
cursor
Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string
sources
Optional

Sources referenced by this section's Firewall Rules .

string
services
Optional

NSService referenced by this section's Firewall Rules .

boolean
sort_ascending
Optional

sort_ascending

string
destinations
Optional

Destinations referenced by this section's Firewall Rules .

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns FirewallRuleListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineFirewallRuleListResult1 
{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_owner": {
                "rel": "string"
            },
            "display_name": "string",
            "description": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_revision": 0,
            "_schema": "string",
            "resource_type": "string",
            "id": "string",
            "direction": "string",
            "rule_tag": "string",
            "ip_protocol": "string",
            "notes": "string",
            "applied_tos": [
                {
                    "target_display_name": "string",
                    "is_valid": false,
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "logged": false,
            "destinations_excluded": false,
            "disabled": false,
            "sources": [
                {
                    "target_display_name": "string",
                    "is_valid": false,
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "services": [
                {
                    "target_display_name": "string",
                    "is_valid": false,
                    "target_id": "string",
                    "target_type": "string",
                    "service": {
                        "resource_type": "string"
                    }
                }
            ],
            "sources_excluded": false,
            "action": "string",
            "destinations": [
                {
                    "target_display_name": "string",
                    "is_valid": false,
                    "target_id": "string",
                    "target_type": "string"
                }
            ]
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Services Operations
POST
Add Dne Key Manager
POST
Add Dne Key Policy
POST
Add Dne Rule In Section
POST
Add Dne Rules In Section
POST
Add Dne Section
POST
Add Dne Section With Rules
POST
Add Member
POST
Add Rule In Section
POST
Add Rules In Section
POST
Add Section
POST
Add Section With Rules
POST
Check Member If Exists
POST
Create Dhcp Ip Pool
POST
Create Dhcp Profile
POST
Create Dhcp Server
POST
Create Dhcp Static Binding
POST
Create Metadata Proxy
DELETE
Delete Dhcp Ip Pool
DELETE
Delete Dhcp Profile
DELETE
Delete Dhcp Server
DELETE
Delete Dhcp Static Binding
DELETE
Delete Dne Key Manager
DELETE
Delete Dne Key Policy
DELETE
Delete Dne Rule
DELETE
Delete Dne Section
DELETE
Delete Metadata Proxy
DELETE
Delete Rule
DELETE
Delete Section
GET
Get Dne Key Manager
GET
Get Dne Key Policy
GET
Get Dne Key Policy Stats
GET
Get Dne Rule
GET
Get Dne Rules
GET
Get Dne Rules By Key Policy
GET
Get Dne Rule State
GET
Get Dne Rule Stats
GET
Get Dne Section
GET
Get Dne Section State
POST
Get Dne Section With Rules
GET
Get Exclude List
GET
Get Firewall Stats
GET
Get Rule
GET
Get Rules
GET
Get Rule State
GET
Get Section
GET
Get Section State
POST
Get Section With Rules
GET
List Dhcp Ip Pools
GET
List Dhcp Profiles
GET
List Dhcp Servers
GET
List Dhcp Static Bindings
GET
List Dne Key Managers
GET
List Dne Key Policies
GET
List Dne Sections
GET
List Metadata Proxy
GET
List Sections
GET
Read Dhcp Ip Pool
GET
Read Dhcp Profile
GET
Read Dhcp Server
GET
Read Dhcp Static Binding
GET
Read Metadata Proxy
POST
Remove Member
PUT
Reset Default Dne Key Policy To System Default
POST
Revise Dne Rule
POST
Revise Dne Section
POST
Revise Dne Section With Rules
POST
Revise Rule
POST
Revise Section
POST
Revise Section With Rules
POST
Revoke Dne Key Policy
POST
Rotate Dne Key Policy
PUT
Update Dhcp Ip Pool
PUT
Update Dhcp Profile
PUT
Update Dhcp Server
PUT
Update Dhcp Static Binding
PUT
Update Dne Key Manager
PUT
Update Dne Key Policy
PUT
Update Dne Rule
PUT
Update Dne Section
POST
Update Dne Section With Rules
PUT
Update Exclude List
PUT
Update Metadata Proxy
PUT
Update Rule
PUT
Update Section
POST
Update Section With Rules