---
title: "Show group"
method: GET
path: "/group/{name}"
tags: ["Group"]
---

# Show group

`GET /group/{name}`

## Request

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

## Path parameters

- `name` string, required

## Headers

- `X-Auth-Token` string, required

## Response `200`

Success

- RESTGroupData
  - `group` RESTGroupDetail, required
    - `name` string, required
    - `learned` boolean, required
    - `reserved` boolean, required
    - `policy_mode` string
    - `domain` string, required
    - `creater_domains` string[], required
    - `kind` string, required
    - `platform_role` string, required
    - `cap_change_mode` boolean, required
    - `cfg_type` string, required
    - `criteria` RESTCriteriaEntry[], required
      - `key` string, required
      - `value` string, required
      - `op` string, required
    - `members` RESTWorkloadBrief[], required
      - `id` string, required
      - `name` string, required
      - `display_name` string, required
      - `pod_name` string, required
      - `image` string, required
      - `image_id` string, required
      - `platform_role` string, required
      - `domain` string, required
      - `state` string, required
      - `service` string, required
      - `author` string, required
      - `service_group` string, required
      - `share_ns_with` string
      - `cap_sniff` boolean, required
      - `cap_quarantine` boolean, required
      - `cap_change_mode` boolean, required
      - `policy_mode` string, required
      - `profile_mode` string, required
      - `scan_summary` RESTScanBrief, required
        - `status` string, required
        - `high` integer, required
        - `medium` integer, required
        - `result` string, required
        - `scanned_timestamp` integer, required
        - `scanned_at` string, required
        - `base_os` string, required
        - `scanner_version` string, required
        - `cvedb_create_time` string, required
      - `children` RESTWorkloadBrief[], required
      - `quarantine_reason` string
      - `service_mesh` boolean, required
      - `service_mesh_sidecar` boolean, required
      - `privileged` boolean, required
      - `run_as_root` boolean, required
    - `policy_rules` RESTPolicyRule[], required
      - `id` integer, required
      - `comment` string, required
      - `from` string, required: group name
      - `to` string, required: group name
      - `ports` string, required: free-style port list
      - `action` string, required
      - `applications` string[], required
      - `learned` boolean, required
      - `disable` boolean, required
      - `created_timestamp` integer, required
      - `last_modified_timestamp` integer, required
      - `cfg_type` string, required
      - `priority` integer, required
    - `response_rules` RESTResponseRule[], required
      - `id` integer, required
      - `event` string, required
      - `comment` string, required
      - `group` string, required
      - `conditions` RESTCLUSEventCondition[], required
        - `type` string
        - `value` string
      - `actions` string[], required
      - `webhooks` string[], required
      - `disable` boolean, required
      - `cfg_type` string, required

---

[API](https://skmtc.dev/neuvector/apis/neuvector-api.md) - [All operations](https://skmtc.dev/neuvector/apis/neuvector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/neuvector/apis/neuvector-api/revisions/b8d8d28840b3?raw)