Secure Endpoint API - Getting Started

Getting Started

In this getting started section, you learn how to set up a request, obtain an API bearer token, and retrieve resources.

Base URI

North America

https://api.amp.cisco.com/v3

Asia Pacific, Japan, and China

https://api.apjc.amp.cisco.com/v3

Europe

https://api.eu.amp.cisco.com/v3

1. Authentication

For v3, the Secure Endpoint API requires a header parameter of Authorization to provide authentication for each request.

{
  "Authorization": "Bearer Token <bearer token>"
}

Read more about generating a bearer token under the Authentication section.

Note: Currently, there is no role or scope needed to access the Secure Endpoint API.

2. Obtaining a List of Organization Identifiers

You will need to know your organization identifier. This is required for all v3 endpoints.

Note: A user may have access to multiple organizations. All results returned will only be for organizations you have access to based on your generated bearer token.

Request

curl --request GET \
  --url 'https://api.amp.cisco.com/v3/organizations' \
  --header 'Authorization: Bearer {BEARER_TOKEN}'

Response

{
  "name": "Example Organization #1",
  "organizationIdentifier": "4baasceazofqpxidpinxtt5l"
}

Full response and examples on obtaining a list of organization identifiers can be found under v3 References section.

3. Obtaining a List of Policies

Using the response from the previous step of obtaining a list of organization identifiers, you can retrieve a list of policies belonging to an organization.

Request

curl --request GET \
  --url https://api.amp.cisco.com/v3/organizations/4baasceazofqpxidpinxtt5l/policies/ \
  --header 'Authorization: Bearer {BEARER_TOKEN}'

Response

{
  "name": "Example Policy",
  "guid": "31c0d995-9bdd-403e-a4dd-092bf94aa0f0",
  "description": "An example policy",
  "createdAt": "2021-09-21T16:15:58.000Z",
  "updatedAt": "2021-10-28T17:50:54.000Z",
  "serialNumber": 1,
  "operatingSystem": "windows",
  "policyType": "workstation"
}

Full response and examples on obtaining a list of policies can be found under Policies section.

4. Obtaining Information on a Specific Policy

Using the response from the previous step of obtaining a list of policies, you can retrieve more information specific to a singular policy.

Request

curl --request GET \
  --url https://api.amp.cisco.com/v3/organizations/4baasceazofqpxidpinxtt5l/policies/31c0d995-9bdd-403e-a4dd-092bf94aa0f0 \
  --header 'Authorization: Bearer {BEARER_TOKEN}'

Response

{
  "name": "Example Policy",
  "guid": "31c0d995-9bdd-403e-a4dd-092bf94aa0f0",
  "description": "Example Description for an Example Policy.",
  "createdAt": "2021-09-13T21:03:38.000Z",
  "updatedAt": "2022-02-02T21:29:48.000Z",
  "serialNumber": 1,
  "orbital": {
    "enabled": false
  },
  "operatingSystem": "windows",
  "policyType": "workstation",
  "default": true,
  "protectionSettings": {
    "files": "audit",
    "network": "audit",
    "maliciousActivityProtection": "audit",
    "systemProcessProtection": "disabled",
    "scriptProtection": "audit",
    "exploitPrevention": "audit",
    "behavioralProtection": "audit",
    "eventTracing": "disabled",
    "offlineEngine": {
      "name": "TETRA",
      "enabled": true
    }
  },
  "customDetectionSimple": {
    "name": "Example Simple Custom Detection List",
    "guid": "48abb7cd-0cc3-4eb4-a2f0-28476ee9eb84",
    "permitted": true
  },
  "customDetectionAdvanced": {},
  "applicationControl": {
    "allowed": {
      "name": "Example Allowed Application List",
      "guid": "c51586d0-5a3c-4599-aef3-dd269430fd87",
      "permitted": true
    },
    "blocked": {
      "name": "Example Blocked Application List",
      "guid": "d97e45ce-001c-4957-b389-45c884a11e00",
      "permitted": true
    }
  }
}

Resources