Cisco AMP for Endpoints API

PATCH /v1/groups/{:group_guid}

Description

Updates group to a given policy and returns all the policies in that 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

Updates group to a given windows policy
Updates group to a given mac policy
Updates group to a given android policy
Updates group to a given linux policy
Updates group to given policies

Updates group to a given windows policy

Request

Requires Authorization 
PATCH /v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 62

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: 62' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"windows_policy_guid":"3dc1435d-bdc8-4a9d-9da5-e7371562378d"}' \
-u YOUR_API_CLIENT_ID \
'https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df'
Body
{"windows_policy_guid":"3dc1435d-bdc8-4a9d-9da5-e7371562378d"}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 874
strict-transport-security: max-age=31536000; includeSubDomains
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: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df"
    }
  },
  "data": {
    "name": "00-mar25-forensic-group",
    "description": "",
    "guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "source": null,
    "policies": [
      {
        "name": "00-cat-forensic-mar25",
        "description": "",
        "guid": "3dc1435d-bdc8-4a9d-9da5-e7371562378d",
        "product": "windows",
        "default": false,
        "serial_number": 140,
        "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": 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
      }
    ]
  }
}

Updates group to a given mac policy

Request

Requires Authorization 
PATCH /v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 58

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: 58' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"mac_policy_guid":"c65a7166-3b9a-4b56-b7c3-62e60c5dac8b"}' \
-u YOUR_API_CLIENT_ID \
'https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df'
Body
{"mac_policy_guid":"c65a7166-3b9a-4b56-b7c3-62e60c5dac8b"}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 874
strict-transport-security: max-age=31536000; includeSubDomains
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: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df"
    }
  },
  "data": {
    "name": "00-mar25-forensic-group",
    "description": "",
    "guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "source": null,
    "policies": [
      {
        "name": "00-cat-forensic-mar25",
        "description": "",
        "guid": "3dc1435d-bdc8-4a9d-9da5-e7371562378d",
        "product": "windows",
        "default": false,
        "serial_number": 140,
        "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": 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
      }
    ]
  }
}

Updates group to a given android policy

Request

Requires Authorization 
PATCH /v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 62

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: 62' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"android_policy_guid":"cf86e1d9-1499-41ad-82e6-7333a2ca2ab0"}' \
-u YOUR_API_CLIENT_ID \
'https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df'
Body
{"android_policy_guid":"cf86e1d9-1499-41ad-82e6-7333a2ca2ab0"}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 873
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2791
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df"
    }
  },
  "data": {
    "name": "00-mar25-forensic-group",
    "description": "",
    "guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "source": null,
    "policies": [
      {
        "name": "00-cat-forensic-mar25",
        "description": "",
        "guid": "3dc1435d-bdc8-4a9d-9da5-e7371562378d",
        "product": "windows",
        "default": false,
        "serial_number": 140,
        "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": 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
      }
    ]
  }
}

Updates group to a given linux policy

Request

Requires Authorization 
PATCH /v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df
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 '{"linux_policy_guid":"f55db9c4-51a0-4e3b-8a3a-6532f06fc0c8"}' \
-u YOUR_API_CLIENT_ID \
'https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df'
Body
{"linux_policy_guid":"f55db9c4-51a0-4e3b-8a3a-6532f06fc0c8"}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 873
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2790
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df"
    }
  },
  "data": {
    "name": "00-mar25-forensic-group",
    "description": "",
    "guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "source": null,
    "policies": [
      {
        "name": "00-cat-forensic-mar25",
        "description": "",
        "guid": "3dc1435d-bdc8-4a9d-9da5-e7371562378d",
        "product": "windows",
        "default": false,
        "serial_number": 140,
        "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": 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
      }
    ]
  }
}

Updates group to given policies

Request

Requires Authorization 
PATCH /v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 239

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: 239' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"windows_policy_guid":"3dc1435d-bdc8-4a9d-9da5-e7371562378d","mac_policy_guid":"c65a7166-3b9a-4b56-b7c3-62e60c5dac8b","android_policy_guid":"cf86e1d9-1499-41ad-82e6-7333a2ca2ab0","linux_policy_guid":"f55db9c4-51a0-4e3b-8a3a-6532f06fc0c8"}' \
-u YOUR_API_CLIENT_ID \
'https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df'
Body
{"windows_policy_guid":"3dc1435d-bdc8-4a9d-9da5-e7371562378d","mac_policy_guid":"c65a7166-3b9a-4b56-b7c3-62e60c5dac8b","android_policy_guid":"cf86e1d9-1499-41ad-82e6-7333a2ca2ab0","linux_policy_guid":"f55db9c4-51a0-4e3b-8a3a-6532f06fc0c8"}

Response

Shortened for readability 

content-type: application/json
transfer-encoding: chunked
status: 202 Accepted
x-ratelimit-limit: 3000
x-ratelimit-reset: 872
strict-transport-security: max-age=31536000; includeSubDomains
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2789
x-permitted-cross-domain-policies: none
x-download-options: noopen
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.apjc.amp.cisco.com/v1/groups/a4a983ef-91df-428f-9b08-1e88ec5357df"
    }
  },
  "data": {
    "name": "00-mar25-forensic-group",
    "description": "",
    "guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "source": null,
    "policies": [
      {
        "name": "00-cat-forensic-mar25",
        "description": "",
        "guid": "3dc1435d-bdc8-4a9d-9da5-e7371562378d",
        "product": "windows",
        "default": false,
        "serial_number": 140,
        "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": 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
      }
    ]
  }
}