Group

Get a list of groups

get/group

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/group/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 groups. When set to local, returned local groups. If there is no query string 'scope', all groups will be returned.

Headers

X-Auth-Tokenstring required

Response

Success

Example response

{
  "groups": [
    {
      "name": "kafkadocker_kafka",
      "learned": true,
      "policy_mode": "Discover",
      "platform_role": "core",
      "cap_change_mode": true,
      "criteria": [
        {
          "key": "image",
          "value": "kafkadocker_kafka",
          "op": "="
        }
      ],
      "members": [
        {
          "id": "7304e72fd093155c4cbcd65d07375329b2db82cc679",
          "name": "k8s_POD.d86c_calico-node-mzhtk_kube-system_0050565a_365c13d",
          "display_name": "calico-node-mzhtk",
          "pod_name": "istio-policy-5cdbc47674-t67p4",
          "image": "calico",
          "image_id": "d572b7ee3511b21a2b78b8915bc03c5786ad01949704c1418624224c4cae2c5f",
          "platform_role": "core",
          "state": "exit",
          "service": "kafkazookeeper",
          "service_group": "nv.calico",
          "share_ns_with": "cc0709d522749203042e89dba28bf6924a4b0d360648",
          "cap_sniff": true,
          "cap_quarantine": true,
          "cap_change_mode": true,
          "policy_mode": "Discover",
          "profile_mode": "Discover",
          "scan_summary": {
            "status": "scheduled",
            "result": "success",
            "scanned_timestamp": 1516561253,
            "scanned_at": "2018-01-21T19:00:53Z",
            "base_os": "ubuntu:16.04",
            "scanner_version": "1.011",
            "cvedb_create_time": "2018-06-20T19:00:53Z"
          },
          "quarantine_reason": "violation",
          "service_mesh": true,
          "service_mesh_sidecar": true,
          "privileged": true,
          "run_as_root": true
        }
      ],
      "policy_rules": [
        10005
      ],
      "response_rules": [
        1247
      ]
    }
  ]
}

Changes

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