Cisco AMP for Endpoints API

POST /v1/install_packages

Description

JSON Body Parameters

Name Type Description
group_guid GUID Required.
product_name String Required. Allowed values: windows, mac, linux, or android.
scan_on_install Boolean Required for windows, mac, and linux. Ignored for android.
redistributable Boolean Required for windows. Ignored for mac, linux, and android.
product_variant_attributes.name, product_variant_attributes.version String Required for linux. Ignored for windows, mac, and android. Allowed values correspond to the Linux product variants seen on the "Download Connector" page.

Response

On success, the response body contains information pertaining to the created install package and the response header is 200 OK. The data.download_url field of the response body is a link that can be used to download a new connector based off of the created install package.

On error, the response header is 400 Bad Request and contains an errors object with details of the failure.

Write
Preview

Examples

creates a windows install package
creates a mac install package
creates a linux install package
creates an android install package

creates a windows install package

Request

Requires Authorization
POST /v1/install_packages
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 124

cURL Edit, then copy and paste on your terminal

curl -X POST \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 124' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df","product_name":"windows","scan_on_install":true,"redistributable":true}' \
-u YOUR_API_CLIENT_ID \
'https://api.consumer.amp.cisco.com/v1/install_packages'
Body
{"group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df","product_name":"windows","scan_on_install":true,"redistributable":true}
      

Response

Shortened for readability

content-type: application/json
transfer-encoding: chunked
status: 200 OK
x-ratelimit-limit: 3000
x-ratelimit-reset: 870
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2783
x-permitted-cross-domain-policies: none
x-download-options: noopen
etag: W/"daa1fe9c8cdeff5be0aad2a7230f347c"
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z
{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.consumer.amp.cisco.com/v1/install_packages"
    }
  },
  "data": {
    "download_url": "https://console.qa1.immunet.com/install_packages/a331ff2f-31e2-4f98-b006-5c2ccb7792ff/download?product=WindowsProduct",
    "group_guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "install_token": "a331ff2f-31e2-4f98-b006-5c2ccb7792ff",
    "installer_version": "7.4.5.20701",
    "product": "windows",
    "redistributable": true,
    "scan_on_install": true
  }
}

creates a mac install package

Request

Requires Authorization
POST /v1/install_packages
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 97

cURL Edit, then copy and paste on your terminal

curl -X POST \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 97' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df","product_name":"mac","scan_on_install":true}' \
-u YOUR_API_CLIENT_ID \
'https://api.consumer.amp.cisco.com/v1/install_packages'
Body
{"group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df","product_name":"mac","scan_on_install":true}
      

Response

Shortened for readability

content-type: application/json
transfer-encoding: chunked
status: 200 OK
x-ratelimit-limit: 3000
x-ratelimit-reset: 870
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2782
x-permitted-cross-domain-policies: none
x-download-options: noopen
etag: W/"7465b9537dc75a99dfc7e5e7f6a8394d"
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z
{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.consumer.amp.cisco.com/v1/install_packages"
    }
  },
  "data": {
    "download_url": "https://console.qa1.immunet.com/install_packages/d2d4caae-7378-4f1a-adb0-067bf4e00be3/download?product=MacProduct",
    "group_guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "install_token": "d2d4caae-7378-4f1a-adb0-067bf4e00be3",
    "installer_version": "1.18.0.862",
    "product": "mac",
    "scan_on_install": true
  }
}

creates a linux install package

Request

Requires Authorization
POST /v1/install_packages
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 166

cURL Edit, then copy and paste on your terminal

curl -X POST \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 166' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df","product_name":"linux","scan_on_install":false,"product_variant_attributes":{"name":"RHEL/CentOS","version":"7"}}' \
-u YOUR_API_CLIENT_ID \
'https://api.consumer.amp.cisco.com/v1/install_packages'
Body
{"group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df","product_name":"linux","scan_on_install":false,"product_variant_attributes":{"name":"RHEL/CentOS","version":"7"}}
      

Response

Shortened for readability

content-type: application/json
transfer-encoding: chunked
status: 200 OK
x-ratelimit-limit: 3000
x-ratelimit-reset: 869
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2781
x-permitted-cross-domain-policies: none
x-download-options: noopen
etag: W/"c8e426773414583f50828c73739a0f68"
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z
{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.consumer.amp.cisco.com/v1/install_packages"
    }
  },
  "data": {
    "download_url": "https://console.qa1.immunet.com/install_packages/c06c4fe4-f179-40b7-ad81-a176371939d4/download?product=LinuxProduct&product_variant_id=d2db2d9b-6c06-4cca-951a-e25489d19b5c",
    "group_guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "install_token": "c06c4fe4-f179-40b7-ad81-a176371939d4",
    "installer_version": "1.19.0.826",
    "product": "linux",
    "product_variant": "RHEL/CentOS 7",
    "scan_on_install": false
  }
}

creates an android install package

Request

Requires Authorization
POST /v1/install_packages
Headers
accept: application/json
content-type: application/json
accept-encoding: identity
authorization: Basic FILTERED
content-length: 78

cURL Edit, then copy and paste on your terminal

curl -X POST \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'accept-encoding: identity' \
-H 'content-length: 78' \
--compressed -H 'Accept-Encoding: gzip, deflate' \
-d '{"group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df","product_name":"android"}' \
-u YOUR_API_CLIENT_ID \
'https://api.consumer.amp.cisco.com/v1/install_packages'
Body
{"group_guid":"a4a983ef-91df-428f-9b08-1e88ec5357df","product_name":"android"}
      

Response

Shortened for readability

content-type: application/json
transfer-encoding: chunked
status: 200 OK
x-ratelimit-limit: 3000
x-ratelimit-reset: 869
strict-transport-security: max-age=31536000; includeSubDomains, max-age=31536000
referrer-policy: strict-origin-when-cross-origin
x-ratelimit-remaining: 2780
x-permitted-cross-domain-policies: none
x-download-options: noopen
etag: W/"29ccb3c4643e22a55a316213eaacabd0"
x-frame-options: SAMEORIGIN
x-ratelimit-resetdate: 2022-03-18T11:55:11Z
{
  "version": "v1.2.0",
  "metadata": {
    "links": {
      "self": "https://api.consumer.amp.cisco.com/v1/install_packages"
    }
  },
  "data": {
    "download_url": "https://console.qa1.immunet.com/install_packages/125503ba-2d73-47af-9409-ed7ad79b99ef/download?product=AndroidProduct",
    "group_guid": "a4a983ef-91df-428f-9b08-1e88ec5357df",
    "install_token": "125503ba-2d73-47af-9409-ed7ad79b99ef",
    "installer_version": "2.3.0.10",
    "product": "android",
    "scan_on_install": false
  }
}