Cisco AMP for Endpoints API

GET /v1/groups/{:group_guid}

Description

Returns a particular group. Use group_guid to get information about a particular group.

Show Response Fields

Name Type Description
version String
metadata.links.self String
data.name String
data.description String
data.guid GUID
data.source String
data.policies Array
data.policies[].name String
data.policies[].description String
data.policies[].guid GUID
data.policies[].product String
data.policies[].default Boolean
data.policies[].serial_number Integer
data.policies[].links.policy_xml String
data.policies[].links.policy String
data.policies[].file_lists Array
data.policies[].file_lists[].name String
data.policies[].file_lists[].guid GUID
data.policies[].file_lists[].type String
data.policies[].ip_lists Array
data.policies[].ip_lists[].type String
data.policies[].ip_lists[].name String
data.policies[].ip_lists[].guid GUID
data.policies[].exclusion_set.name String
data.policies[].exclusion_set.guid GUID
data.policies[].used_in_groups Array
data.policies[].used_in_groups[].name String
data.policies[].used_in_groups[].description String
data.policies[].used_in_groups[].guid GUID
data.policies[].inherited Boolean
Write
Preview
Auto Generate

Examples

Fetch group with given group_guid

Fetch group with given group_guid

Request

Requires Authorization 
GET /v1/groups/67b5e432-1d8c-4a1c-9208-17d2c797e318
Headers
accept: application/json
content-type: application/json
authorization: Basic FILTERED

cURL Edit, then copy and paste on your terminal

curl -X GET \
-H 'accept: application/json' \
-H 'content-type: application/json' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-u YOUR_API_CLIENT_ID \
'https://api.apjc.amp.cisco.com/v1/groups/67b5e432-1d8c-4a1c-9208-17d2c797e318'

Response

Shortened for readability 

strict-transport-security: max-age=31536000
content-type: application/json; charset=utf-8
status: 200 OK
x-ratelimit-limit: 3000
x-ratelimit-reset: 1826
x-ratelimit-remaining: 2808
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-01-09T17:44:06Z
transfer-encoding: chunked

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.apjc.amp.cisco.com/v1/groups/67b5e432-1d8c-4a1c-9208-17d2c797e318"
    }
  },
  "data": {
    "name": "afcILiVA",
    "description": "This is a new group",
    "guid": "67b5e432-1d8c-4a1c-9208-17d2c797e318",
    "source": "Created via API",
    "policies": [
      {
        "name": "Audit Policy",
        "description": "",
        "guid": "89912c9e-8dbd-4c2b-a1d8-dee8a0c2bb29",
        "product": "windows",
        "default": true,
        "serial_number": 112,
        "links": {
          "policy_xml": "https://api.apjc.amp.cisco.com/v1/policies/89912c9e-8dbd-4c2b-a1d8-dee8a0c2bb29.xml",
          "policy": "https://api.apjc.amp.cisco.com/v1/policies/89912c9e-8dbd-4c2b-a1d8-dee8a0c2bb29"
        },
        "file_lists": [
          {
            "name": "Quick SCD",
            "guid": "03097bae-53f9-44b1-a0e5-d23b1f33a94a",
            "type": "simple_custom_detections"
          },
          {
            "name": "Sample Application Blocking List",
            "guid": "e773a9eb-296c-40df-98d8-bed46322589d",
            "type": "application_blocking"
          }
        ],
        "ip_lists": [
          {
            "type": "whitelist",
            "name": "Sample White List",
            "guid": "444f184d-9965-48b8-a4df-8b3773398e9b"
          },
          {
            "type": "blacklist",
            "name": "Sample Black List",
            "guid": "503f867d-a555-44d5-a541-6e5c8977f7c5"
          }
        ],
        "exclusion_sets": [
          {
            "name": "Workstation Exclusions For FireAMP Windows",
            "guid": "b20a94a7-f9e9-4b79-91ec-83f8015d5491"
          }
        ],
        "used_in_groups": [
          {
            "name": "Audit",
            "description": "Audit Group for FireAMP API Docs",
            "guid": "b077d6bc-bbdf-42f7-8838-a06053fbd98a"
          },
          {
            "name": "AoVdQMjT",
            "description": "This is a new group",
            "guid": "bfe6abd0-6591-4bf2-a0d3-02efc1cd268e",
            "source": "Created via API"
          }
        ],
        "inherited": false
      },
      {
        "name": "Default FireAMP Android",
        "guid": "cf86e1d9-1499-41ad-82e6-7333a2ca2ab0",
        "product": "android",
        "default": true,
        "serial_number": 81,
        "links": {
          "policy_xml": "https://api.apjc.amp.cisco.com/v1/policies/cf86e1d9-1499-41ad-82e6-7333a2ca2ab0.xml",
          "policy": "https://api.apjc.amp.cisco.com/v1/policies/cf86e1d9-1499-41ad-82e6-7333a2ca2ab0"
        },
        "file_lists": [

        ],
        "ip_lists": [

        ],
        "used_in_groups": [
          {
            "name": "Audit",
            "description": "Audit Group for FireAMP API Docs",
            "guid": "b077d6bc-bbdf-42f7-8838-a06053fbd98a"
          },
          {
            "name": "AoVdQMjT",
            "description": "This is a new group",
            "guid": "bfe6abd0-6591-4bf2-a0d3-02efc1cd268e",
            "source": "Created via API"
          }
        ],
        "inherited": false
      }
    ]
  }
}