Cisco AMP for Endpoints API

GET /v0/computers

Description

Returns a list of computers with agents deployed on them. You can use parameters to narrow the search by IP address or hostname.

Query Parameters

Name	Type	Example Values
`internal_ip`	String	202.146.2.246
`limit`	Integer	10
`offset`	Integer	20
`external_ip`	String	226.13.104.250
`group_guid[]`	GUID	6c3c2005-4c74-4ba7-8dbb-c4d5b6bafe03
`hostname[]`	String	Demo_AMP

Show Response Fields

Name	Type	Description
version	String
metadata.links.self	String
metadata.results.total	Integer
metadata.results.current_item_count	Integer
metadata.results.index	Integer
metadata.results.items_per_page	Integer
data	Array
data[].connector_guid	GUID
data[].hostname	String
data[].active	Boolean
data[].links.computer	String
data[].links.trajectory	String
data[].links.group	String
data[].connector_version	String
data[].operating_system	String
data[].internal_ips	Array
data[].internal_ips[]	String
data[].external_ip	String
data[].group_guid	GUID
data[].install_date	String (Time ISO8601)
data[].network_addresses	Array
data[].network_addresses[].mac	String
data[].network_addresses[].ip	String
data[].policy.guid	GUID
data[].policy.name	String
data[].last_seen	String (Time ISO8601)
data[].faults	Array

Write

Preview

Describe this action in markdown

Returns a list of computers with agents deployed on them. You can use parameters to narrow the search by IP address or hostname.

### Query Parameters

|Name|Type|Example Values|Description|
|----|----|----|----|
|`internal_ip`|String|202.146.2.246||
|`limit`|Integer|10||
|`offset`|Integer|20||
|`external_ip`|String|226.13.104.250||
|`group_guid[]`|GUID|6c3c2005-4c74-4ba7-8dbb-c4d5b6bafe03||
|`hostname[]`|String|Demo_AMP||
[Show Response Fields](response-fields)

|Name|Type|Description|
|---|---|---|
|version|String||
|metadata.links.self|String||
|metadata.results.total|Integer||
|metadata.results.current_item_count|Integer||
|metadata.results.index|Integer||
|metadata.results.items_per_page|Integer||
|data|Array||
|data[].connector_guid|GUID||
|data[].hostname|String||
|data[].active|Boolean||
|data[].links.computer|String||
|data[].links.trajectory|String||
|data[].links.group|String||
|data[].connector_version|String||
|data[].operating_system|String||
|data[].internal_ips|Array||
|data[].internal_ips[]|String||
|data[].external_ip|String||
|data[].group_guid|GUID||
|data[].install_date|String (Time ISO8601)||
|data[].network_addresses|Array||
|data[].network_addresses[].mac|String||
|data[].network_addresses[].ip|String||
|data[].policy.guid|GUID||
|data[].policy.name|String||
|data[].last_seen|String (Time ISO8601)||
|data[].faults|Array||

Auto Generate

Examples

Fetch list of computers

Fetch list of computers filtered by hostname

Fetch list of computers filtered by internal_ip

Fetch list of computers filtered by external_ip

Fetch list of computers filtered by group_guid

Fetch list of computers

Request

Requires Authorization

GET /v0/computers

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/v0/computers'

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: 3597
x-ratelimit-remaining: 2990
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-06-07T18:07:58Z
transfer-encoding: chunked

{
  "version": "v0.2.2",
  "metadata": {
    "links": {
      "self": "https://api.eu.amp.cisco.com/v0/computers"
    },
    "results": {
      "total": 33,
      "current_item_count": 33,
      "index": 0,
      "items_per_page": 500
    }
  },
  "data": [
    {
      "connector_guid": "0e37a552-2cdd-4178-b29e-1be15598d730",
      "hostname": "Demo_AMP",
      "active": true,
      "links": {
        "computer": "https://api.eu.amp.cisco.com/v0/computers/0e37a552-2cdd-4178-b29e-1be15598d730",
        "trajectory": "https://api.eu.amp.cisco.com/v0/computers/0e37a552-2cdd-4178-b29e-1be15598d730/trajectory",
        "group": "https://api.eu.amp.cisco.com/v0/groups/6c3c2005-4c74-4ba7-8dbb-c4d5b6bafe03"
      },
      "connector_version": "6.4.1.11083",
      "operating_system": "Windows 7, SP 1.0",
      "internal_ips": [
        "202.146.2.246"
      ],
      "external_ip": "226.13.104.250",
      "group_guid": "6c3c2005-4c74-4ba7-8dbb-c4d5b6bafe03",
      "install_date": "2019-06-05T14:00:07Z",
      "network_addresses": [
        {
          "mac": "36:28:59:a9:f8:df",
          "ip": "202.146.2.246"
        }
      ],
      "policy": {
        "guid": "520c7c68-a637-43b1-b851-7830b0b336b6",
        "name": "Protect Policy"
      },
      "last_seen": "2019-06-07T14:51:20Z",
      "faults": [

      ]
    },
    {
      "connector_guid": "544b38c6-f312-40c3-be8a-6241c0ac38da",
      "hostname": "Demo_AMP_Exploit_Prevention",
      "active": true,
      "links": {
        "computer": "https://api.eu.amp.cisco.com/v0/computers/544b38c6-f312-40c3-be8a-6241c0ac38da",
        "trajectory": "https://api.eu.amp.cisco.com/v0/computers/544b38c6-f312-40c3-be8a-6241c0ac38da/trajectory",
        "group": "https://api.eu.amp.cisco.com/v0/groups/b077d6bc-bbdf-42f7-8838-a06053fbd98a"
      },
      "connector_version": "6.4.1.11083",
      "operating_system": "Windows 7, SP 1.0",
      "internal_ips": [
        "200.11.61.187"
      ],
      "external_ip": "112.252.246.248",
      "group_guid": "b077d6bc-bbdf-42f7-8838-a06053fbd98a",
      "install_date": "2019-06-07T14:51:20Z",
      "network_addresses": [
        {
          "mac": "ef:0d:93:35:49:7a",
          "ip": "200.11.61.187"
        }
      ],
      "policy": {
        "guid": "89912c9e-8dbd-4c2b-a1d8-dee8a0c2bb29",
        "name": "Audit Policy"
      },
      "last_seen": "2019-06-07T14:51:20Z",
      "faults": [

      ]
    }
  ]
}

Fetch list of computers filtered by hostname

Request

Requires Authorization

GET /v0/computers?hostname[]=Demo_AMP&limit=10&offset=20

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/v0/computers?hostname[]=Demo_AMP&limit=10&offset=20'

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: 3596
x-ratelimit-remaining: 2988
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-06-07T18:07:58Z
transfer-encoding: chunked

{
  "version": "v0.2.2",
  "metadata": {
    "links": {
      "self": "https://api.eu.amp.cisco.com/v0/computers?hostname[]=Demo_AMP&limit=10&offset=20",
      "prev": "https://api.eu.amp.cisco.com/v0/computers?hostname%5B%5D=Demo_AMP&limit=10&offset=0"
    },
    "results": {
      "total": 7,
      "current_item_count": 0,
      "index": 20,
      "items_per_page": 10
    }
  },
  "data": [

  ]
}

Fetch list of computers filtered by internal_ip

Request

Requires Authorization

GET /v0/computers?internal_ip=202.146.2.246&limit=10&offset=20

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/v0/computers?internal_ip=202.146.2.246&limit=10&offset=20'

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: 3595
x-ratelimit-remaining: 2986
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-06-07T18:07:58Z
transfer-encoding: chunked

{
  "version": "v0.2.2",
  "metadata": {
    "links": {
      "self": "https://api.eu.amp.cisco.com/v0/computers?internal_ip=202.146.2.246&limit=10&offset=20",
      "prev": "https://api.eu.amp.cisco.com/v0/computers?internal_ip=202.146.2.246&limit=10&offset=0"
    },
    "results": {
      "total": 1,
      "current_item_count": 0,
      "index": 20,
      "items_per_page": 10
    }
  },
  "data": [

  ]
}

Fetch list of computers filtered by external_ip

Request

Requires Authorization

GET /v0/computers?external_ip=226.13.104.250&limit=10&offset=20

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/v0/computers?external_ip=226.13.104.250&limit=10&offset=20'

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: 3595
x-ratelimit-remaining: 2984
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-06-07T18:07:58Z
transfer-encoding: chunked

{
  "version": "v0.2.2",
  "metadata": {
    "links": {
      "self": "https://api.eu.amp.cisco.com/v0/computers?external_ip=226.13.104.250&limit=10&offset=20",
      "prev": "https://api.eu.amp.cisco.com/v0/computers?external_ip=226.13.104.250&limit=10&offset=0"
    },
    "results": {
      "total": 1,
      "current_item_count": 0,
      "index": 20,
      "items_per_page": 10
    }
  },
  "data": [

  ]
}

Fetch list of computers filtered by group_guid

Request

Requires Authorization

GET /v0/computers?group_guid[]=6c3c2005-4c74-4ba7-8dbb-c4d5b6bafe03&limit=10&offset=20

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/v0/computers?group_guid[]=6c3c2005-4c74-4ba7-8dbb-c4d5b6bafe03&limit=10&offset=20'

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: 3594
x-ratelimit-remaining: 2982
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2019-06-07T18:07:58Z
transfer-encoding: chunked

{
  "version": "v0.2.2",
  "metadata": {
    "links": {
      "self": "https://api.eu.amp.cisco.com/v0/computers?group_guid[]=6c3c2005-4c74-4ba7-8dbb-c4d5b6bafe03&limit=10&offset=20",
      "prev": "https://api.eu.amp.cisco.com/v0/computers?group_guid%5B%5D=6c3c2005-4c74-4ba7-8dbb-c4d5b6bafe03&limit=10&offset=7"
    },
    "results": {
      "total": 17,
      "current_item_count": 0,
      "index": 20,
      "items_per_page": 10
    }
  },
  "data": [

  ]
}