Get Rules | NSX-T Data Center REST API

Get Rules

Return all firewall rule(s) information for a given firewall 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

applied_tos

Optional

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

string

cursor

Optional

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

string

destinations

Optional

Destinations referenced by this section's Firewall Rules .

string

filter_type

Optional

Filter type

Possible values are : FILTER, SEARCH,

string

included_fields

Optional

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

integer

page_size

Optional

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

string

services

Optional

NSService referenced by this section's Firewall Rules .

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

sources

Optional

Sources referenced by this section's Firewall Rules .

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns FirewallRuleListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineFirewallRuleListResult1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_revision": 0,
            "_owner": {
                "rel": "string"
            },
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "description": "string",
            "is_default": false,
            "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,
            "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"
                    }
                }
            ],
            "action": "string",
            "sources_excluded": false,
            "destinations_excluded": false,
            "destinations": [
                {
                    "target_display_name": "string",
                    "is_valid": false,
                    "target_id": "string",
                    "target_type": "string"
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure