Cisco AMP for Endpoints API

GET /v1/policies

Description

Returns a list of policies. You can filter this list by name and product.

Query Parameters

Name	Type	Example Values
`product[]`	String	windows
`limit`	Integer	10, 3
`offset`	Integer	2
`name[]`	String	Audit Policy

Show Response Fields

Name	Type	Description
version	String
metadata.links.self	String
metadata.links.prev	String
metadata.links.next	String
metadata.results.total	Integer
metadata.results.current_item_count	Integer
metadata.results.index	Integer
metadata.results.items_per_page	Integer
data	Array
data[].name	String
data[].guid	GUID
data[].product	String
data[].default	Boolean
data[].serial_number	Integer
data[].links.policy	String

Write

Preview

Describe this action in markdown

Auto Generate

Examples

Fetch list of policies

Fetch list of policies filtered by name

Fetch list of policies filtered by product

Fetch list of policies

Request

Requires Authorization

GET /v1/policies?limit=3&offset=2

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.eu.amp.cisco.com/v1/policies?limit=3&offset=2'

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: 3530
x-ratelimit-remaining: 2904
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-11-22T19:40:39Z
transfer-encoding: chunked

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.eu.amp.cisco.com/v1/policies?limit=3&offset=2",
      "prev": "https://api.eu.amp.cisco.com/v1/policies?limit=3&offset=0",
      "next": "https://api.eu.amp.cisco.com/v1/policies?limit=3&offset=5"
    },
    "results": {
      "total": 14,
      "current_item_count": 3,
      "index": 2,
      "items_per_page": 3
    }
  },
  "data": [
    {
      "name": "Protect",
      "description": "This is the standard policy for Clarity that will log and alert on convictions and block any potentially malicious traffic.",
      "guid": "2d167ea4-5020-4ea1-aa99-b1ec025a7a48",
      "product": "ios",
      "default": false,
      "serial_number": 125,
      "links": {
        "policy": "https://api.eu.amp.cisco.com/v1/policies/2d167ea4-5020-4ea1-aa99-b1ec025a7a48"
      }
    },
    {
      "name": "Audit Policy for FireAMP Linux",
      "description": "",
      "guid": "f55db9c4-51a0-4e3b-8a3a-6532f06fc0c8",
      "product": "linux",
      "default": true,
      "serial_number": 120,
      "links": {
        "policy": "https://api.eu.amp.cisco.com/v1/policies/f55db9c4-51a0-4e3b-8a3a-6532f06fc0c8"
      }
    }
  ]
}

Fetch list of policies filtered by name

Request

Requires Authorization

GET /v1/policies?name[]=Audit%20Policy&limit=10

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.eu.amp.cisco.com/v1/policies?name[]=Audit%20Policy&limit=10'

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: 3530
x-ratelimit-remaining: 2902
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-11-22T19:40:39Z
transfer-encoding: chunked

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.eu.amp.cisco.com/v1/policies?name[]=Audit%20Policy&limit=10"
    },
    "results": {
      "total": 4,
      "current_item_count": 4,
      "index": 0,
      "items_per_page": 10
    }
  },
  "data": [
    {
      "name": "Audit Policy for FireAMP Linux",
      "description": "",
      "guid": "f55db9c4-51a0-4e3b-8a3a-6532f06fc0c8",
      "product": "linux",
      "default": true,
      "serial_number": 120,
      "links": {
        "policy": "https://api.eu.amp.cisco.com/v1/policies/f55db9c4-51a0-4e3b-8a3a-6532f06fc0c8"
      }
    },
    {
      "name": "Audit Policy for FireAMP Mac",
      "description": "",
      "guid": "c65a7166-3b9a-4b56-b7c3-62e60c5dac8b",
      "product": "mac",
      "default": true,
      "serial_number": 117,
      "links": {
        "policy": "https://api.eu.amp.cisco.com/v1/policies/c65a7166-3b9a-4b56-b7c3-62e60c5dac8b"
      }
    }
  ]
}

Fetch list of policies filtered by product

Request

Requires Authorization

GET /v1/policies?product[]=windows&limit=10

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.eu.amp.cisco.com/v1/policies?product[]=windows&limit=10'

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: 3529
x-ratelimit-remaining: 2901
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-11-22T19:40:39Z
transfer-encoding: chunked

{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.eu.amp.cisco.com/v1/policies?product[]=windows&limit=10"
    },
    "results": {
      "total": 6,
      "current_item_count": 6,
      "index": 0,
      "items_per_page": 10
    }
  },
  "data": [
    {
      "name": "Audit Policy",
      "description": "",
      "guid": "89912c9e-8dbd-4c2b-a1d8-dee8a0c2bb29",
      "product": "windows",
      "default": true,
      "serial_number": 112,
      "links": {
        "policy": "https://api.eu.amp.cisco.com/v1/policies/89912c9e-8dbd-4c2b-a1d8-dee8a0c2bb29"
      }
    },
    {
      "name": "Domain Controller Policy",
      "description": "",
      "guid": "cb9fc67b-df28-424e-92d7-9d09fc4b4475",
      "product": "windows",
      "default": false,
      "serial_number": 116,
      "links": {
        "policy": "https://api.eu.amp.cisco.com/v1/policies/cb9fc67b-df28-424e-92d7-9d09fc4b4475"
      }
    }
  ]
}