Cisco AMP for Endpoints API

PATCH /v1/groups/{:child_guid}/parent

Description

Converts an existing group to a child of another group or an existing child group to a root group (that is, one with no parent groups).

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.ancestry Array
data.ancestry[].name String
data.ancestry[].guid GUID
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

Examples

Makes a group child to another group
Converts a group to a root group

Makes a group child to another group

Request

Requires Authorization
PATCH /v1/groups/f1fd5996-1009-45dd-9da6-cc3a9dfd893e/parent
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 60

cURL Edit, then copy and paste on your terminal

curl -X PATCH \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 60' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"parent_group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df"}' \
-u YOUR_API_CLIENT_ID \
'https://api.apjc.amp.cisco.com/v1/groups/f1fd5996-1009-45dd-9da6-cc3a9dfd893e/parent'
Body
{"parent_group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df"}
      

Response

Shortened for readability

content-type: application/json; charset=utf-8
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 1959
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2793
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2021-05-05T23:55:49Z
{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.apjc.amp.cisco.com/v1/groups/f1fd5996-1009-45dd-9da6-cc3a9dfd893e/parent"
    }
  },
  "data": {
    "name": "sYFJOchL",
    "description": "This is a new group",
    "guid": "f1fd5996-1009-45dd-9da6-cc3a9dfd893e",
    "source": "Created via API",
    "ancestry": [
      {
        "name": "00-mar25-forensic-group",
        "guid": "a4a983ef-91df-428f-9b08-1e88ec5357df"
      }
    ],
    "policies": [
      {
        "name": "00-cat-forensic-mar25",
        "description": "",
        "guid": "3dc1435d-bdc8-4a9d-9da5-e7371562378d",
        "product": "windows",
        "default": false,
        "serial_number": 131,
        "links": {
          "policy_xml": "https://api.apjc.amp.cisco.com/v1/policies/3dc1435d-bdc8-4a9d-9da5-e7371562378d.xml",
          "policy": "https://api.apjc.amp.cisco.com/v1/policies/3dc1435d-bdc8-4a9d-9da5-e7371562378d"
        },
        "file_lists": [

        ],
        "ip_lists": [

        ],
        "isolation_ip_lists": [

        ],
        "exclusion_sets": [
          {
            "name": "Microsoft Windows Default",
            "guid": "9381546e-1617-46ae-98e7-f92fde16cffe"
          }
        ],
        "used_in_groups": [
          {
            "name": "Audit",
            "description": "Audit Group for FireAMP API Docs",
            "guid": "b077d6bc-bbdf-42f7-8838-a06053fbd98a"
          },
          {
            "name": "00-mar25-forensic-group",
            "description": "",
            "guid": "a4a983ef-91df-428f-9b08-1e88ec5357df"
          }
        ],
        "inherited": true
      },
      {
        "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": [

        ],
        "isolation_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": true
      }
    ]
  }
}

Converts a group to a root group

Request

Requires Authorization
PATCH /v1/groups/f1fd5996-1009-45dd-9da6-cc3a9dfd893e/parent
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 0

cURL Edit, then copy and paste on your terminal

curl -X PATCH \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 0' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-u YOUR_API_CLIENT_ID \
'https://api.apjc.amp.cisco.com/v1/groups/f1fd5996-1009-45dd-9da6-cc3a9dfd893e/parent'

Response

Shortened for readability

content-type: application/json; charset=utf-8
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 1958
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2792
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2021-05-05T23:55:49Z
{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.apjc.amp.cisco.com/v1/groups/f1fd5996-1009-45dd-9da6-cc3a9dfd893e/parent"
    }
  },
  "data": {
    "name": "sYFJOchL",
    "description": "This is a new group",
    "guid": "f1fd5996-1009-45dd-9da6-cc3a9dfd893e",
    "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": "IP Allow List",
            "name": "Sample White List",
            "guid": "444f184d-9965-48b8-a4df-8b3773398e9b"
          },
          {
            "type": "IP Block List",
            "name": "Sample Black List",
            "guid": "503f867d-a555-44d5-a541-6e5c8977f7c5"
          }
        ],
        "isolation_ip_lists": [

        ],
        "exclusion_sets": [
          {
            "name": "Workstation Exclusions For FireAMP Windows",
            "guid": "b20a94a7-f9e9-4b79-91ec-83f8015d5491"
          }
        ],
        "used_in_groups": [
          {
            "name": "AoVdQMjT",
            "description": "This is a new group",
            "guid": "bfe6abd0-6591-4bf2-a0d3-02efc1cd268e",
            "source": "Created via API"
          },
          {
            "name": "AfdYnoIi",
            "description": "This is a new group",
            "guid": "4060cf94-26e5-4176-8dea-cd3d0b68d8bc",
            "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": [

        ],
        "isolation_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
      }
    ]
  }
}