Policy

Get a list of policy rules

get/policy/rule

Request

Base URL
/v1 (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared. Required headers: X-Auth-Token
TypeScript
https://skmtc.dev/neuvector/apis/neuvector-api/docs/policy/rule/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

scope'fed' | 'local'

When set to fed, returned fed policy rules. When set to local, returned local policy rules. If there is no query string 'scope', all policy rules will be returned.

Headers

X-Auth-Tokenstring required

Response

Success

Example response

{
  "rules": [
    {
      "id": 10002,
      "comment": "a rule",
      "from": "nv.iperfc",
      "to": "Host:10.2.127.3",
      "ports": "any",
      "action": "allow",
      "applications": [
        "DNS"
      ],
      "learned": true,
      "created_timestamp": 1516563263,
      "last_modified_timestamp": 1516573243,
      "cfg_type": "ground"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.