### Example Policies Data Section

Source: https://developer.cisco.com/docs/secure-endpoint/json-envelope-format

This snippet shows the structure of the 'data' section when retrieving policies. It includes details like policy name, GUID, description, and creation/update timestamps.

```json
"data": [
          {
            "name": "Audit",
            "guid": "c404a4ba-e953-4468-98d0-123456789123",
            "description": "This policy puts the Secure Endpoint Connector in audit mode.",
            "createdAt": "2020-01-18T23:58:21.000Z",
            "updatedAt": "2020-01-18T23:58:21.000Z",
            "serialNumber": 169,
            "orbital": {
                "enabled": false
            },
            "operatingSystem": "linux",
            "policyType": "workstation"
          }
        ]
```

--------------------------------

### Example Meta Section with Pagination Info

Source: https://developer.cisco.com/docs/secure-endpoint/json-envelope-format

Illustrates the 'meta' section containing pagination details, including the start index, size of the current result set, and the total number of available results.

```json
"meta": {
        "start": 0,
        "size": 1,
        "total": 149,
        "create": "/services/organizations/OrgIdentifierHere/policies"
    }
```

```json
"meta": {
        "start": 0,
        "size": 50,
        "total": 149,
        "create": "/services/organizations/OrgIdentifierHere/policies"
    }
```

```json
"meta": {
        "start": 50,
        "size": 50,
        "total": 149
    }
```

--------------------------------

### Trajectory Endpoint Examples

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Examples of events with `command_line` and `network_info` data have been added for trajectory endpoints.

```APIDOC
## GET /v0/computers/{connector_guid}/trajectory

### Description
Retrieves trajectory information for a computer, with examples including command line and network info.

### Method
GET

### Endpoint
/v0/computers/{connector_guid}/trajectory
```

```APIDOC
## GET /v1/computers/{connector_guid}/user_trajectory

### Description
Retrieves user trajectory information for a computer, with examples including command line and network info.

### Method
GET

### Endpoint
/v1/computers/{connector_guid}/user_trajectory
```

```APIDOC
## GET /v1/computers/{connector_guid}/trajectory

### Description
Retrieves trajectory information for a computer, with examples including command line and network info.

### Method
GET

### Endpoint
/v1/computers/{connector_guid}/trajectory
```

--------------------------------

### Example Policy Response

Source: https://developer.cisco.com/docs/secure-endpoint/getting-started

This is an example of the JSON response when successfully retrieving policy information.

```json
{
  "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"
}
```

--------------------------------

### Example Policy Response (JSON)

Source: https://developer.cisco.com/docs/secure-endpoint/getting-started

This JSON object represents an example policy configuration within Cisco Secure Endpoint. It details protection settings, custom detections, and application control rules.

```json
{
  "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
    }
  }
}
```

--------------------------------

### Example Meta Section with Links

Source: https://developer.cisco.com/docs/secure-endpoint/json-envelope-format

Demonstrates the 'meta' section providing convenience links for related API queries, such as proxy, network control lists, and exclusion sets for a specific policy.

```json
"meta": {
        "proxy": "/services/organizations/OrgIdentifierHere/policies/c404a4ba-e953-4468-98d0-123456789123/proxy",
        "networkControlLists": "/services/organizations/OrgIdentifierHere/policies/c404a4ba-e953-4468-98d0-123456789123/network_control_lists",
        "exclusionSets": "/services/organizations/OrgIdentifierHere/policies/c404a4ba-e953-4468-98d0-123456789123/exclusion_sets"
    }
```

--------------------------------

### Example Organization Identifier Response

Source: https://developer.cisco.com/docs/secure-endpoint/getting-started

This is an example of the JSON response when successfully retrieving organization identifiers.

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

--------------------------------

### Install Packages Endpoint Updates

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Updates to the install packages endpoint regarding ARM architecture support.

```APIDOC
## POST /v1/install_packages

### Description
Creates an install package. Request and response now include ARM architecture options.

### Method
POST

### Endpoint
/v1/install_packages
```

--------------------------------

### Download Windows ARM Connectors (v1)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Download Windows ARM connectors using the install packages endpoint. Available in API v1.

```bash
POST /v1/install_packages
```

--------------------------------

### Secure Endpoint API Response Example

Source: https://developer.cisco.com/docs/secure-endpoint/authentication

Example JSON response from a Secure Endpoint API endpoint, showing organization data.

```json
Copy{
  "meta": {
    "start": 0,
    "size": 10,
    "total": 2
  },
  "data": [
    {
      "name": "Example Organization #1",
      "organizationIdentifier": "4baascfeaofqpxidpinxtt5l"
    },
    {
      "name": "Example Organization #2",
      "organizationIdentifier": "nxtf3phj4w0z41pim3vqarzk"
    }
  ]
}


```

--------------------------------

### Host Firewall Configuration Updates

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Documentation updates for Host Firewall configurations, including GET and POST operations.

```APIDOC
## GET /v3/organizations/{organizationIdentifier}/host_firewall/configurations/{configurationGuid}

### Description
Retrieves the configuration for a specific Host Firewall.

### Method
GET

### Endpoint
/v3/organizations/{organizationIdentifier}/host_firewall/configurations/{configurationGuid}
```

```APIDOC
## POST /v3/organizations/{organizationIdentifier}/host_firewall/configurations/{configurationGuid}/rules

### Description
Adds or updates rules for a specific Host Firewall configuration.

### Method
POST

### Endpoint
/v3/organizations/{organizationIdentifier}/host_firewall/configurations/{configurationGuid}/rules
```

--------------------------------

### Base URI Examples

Source: https://developer.cisco.com/docs/secure-endpoint/getting-started

The base URI for the Secure Endpoint API v3 varies by region.

```APIDOC
## 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
```
```

--------------------------------

### Trajectory Filtering

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

The `GET /v1/computers/{connector_guid}/trajectory` and `GET /v1/computers/{connector_guid}/user_trajectory` endpoints now accept optional `start_time` and `end_time` parameters to filter activities within a specified date-time range.

```APIDOC
## GET /v1/computers/{connector_guid}/trajectory

### Description
Retrieves the trajectory of a computer, with optional filtering by date-time range.

### Method
GET

### Endpoint
/v1/computers/{connector_guid}/trajectory

### Parameters
#### Query Parameters
- **start_time** (string) - Optional - The start of the date-time range for filtering activities.
- **end_time** (string) - Optional - The end of the date-time range for filtering activities.

## GET /v1/computers/{connector_guid}/user_trajectory

### Description
Retrieves the user trajectory of a computer, with optional filtering by date-time range.

### Method
GET

### Endpoint
/v1/computers/{connector_guid}/user_trajectory

### Parameters
#### Query Parameters
- **start_time** (string) - Optional - The start of the date-time range for filtering activities.
- **end_time** (string) - Optional - The end of the date-time range for filtering activities.
```

--------------------------------

### Request a connector uninstallation

Source: https://developer.cisco.com/docs/secure-endpoint/computers

Requests a connector uninstallation for a specific computer using its GUID.

```APIDOC
## PUT /organizations/{organizationIdentifier}/computers/{computer_guid}/uninstall_request

### Description
Requests a connector uninstallation with given computer_guid.

### Method
PUT

### Endpoint
/organizations/{organizationIdentifier}/computers/{computer_guid}/uninstall_request

### Parameters
#### Path Parameters
- **organizationIdentifier** (string) - Required - The identifier of the organization.
- **computer_guid** (string) - Required - The GUID of the computer for which to request uninstallation.
```

--------------------------------

### Indicator Details Update

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

The response for `GET /v1/indicators/{indicator_guid}` now includes an additional field `extended_name` for techniques.

```APIDOC
## GET /v1/indicators/{indicator_guid}

### Description
Retrieves details for a specific indicator.

### Method
GET

### Endpoint
/v1/indicators/{indicator_guid}

### Response
#### Success Response (200)
- **extended_name** (string) - The extended name of the technique associated with the indicator.
```

--------------------------------

### Device Control Configuration Error Handling

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

The `GET /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration` endpoint now returns a descriptive error message for bad requests.

```APIDOC
## GET /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration

### Description
Retrieves the device control configuration for a policy.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration

### Response
#### Error Response (400)
Bad Request - Returns a descriptive error message.
```

--------------------------------

### Generate API Access Token using OAuth2

Source: https://developer.cisco.com/docs/secure-endpoint/authentication

Use this bash script to obtain an API access token from the OAuth2 token endpoint. It reads client credentials, makes a POST request, and extracts the Bearer token. Ensure jq is installed for JSON parsing.

```bash
Copy# Read in the client_id and client_secret if they are not already set.
[ -z "$client_id" ] && read -p "client_id: " client_id
[ -z "$client_secret" ] && read -p "client_secret: " client_secret

# Call the token endpoint and store the result in a variable.
result=$(curl -s 'https://visibility.amp.cisco.com/iroh/oauth2/token' \
     --user "${client_id}:${client_secret}" \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --header 'Accept: application/json' \
     -d 'grant_type=client_credentials')

# Extract the access_token from the result.
export BEARER_TOKEN=$(echo "$result" | jq -r .access_token)

# Print the result.
[ -x "$(command -v jq)" ] && echo "$result" | jq . || echo "$result"

```

--------------------------------

### Example Error Response Structure

Source: https://developer.cisco.com/docs/secure-endpoint/json-envelope-format

Shows the structure for API responses that contain errors. Errors are listed within the 'meta' object, detailing the attribute and the specific error message.

```json
{
  "data":{},
  "meta":{
    "errors": [
      {
        "attribute": "size",
        "message": "size is a required parameter"
      }
    ]
  }
}
```

--------------------------------

### Obtain Specific Policy Information (curl)

Source: https://developer.cisco.com/docs/secure-endpoint/getting-started

Use this curl command to retrieve detailed information about a specific policy. Replace the organization identifier, policy GUID, and '{BEARER_TOKEN}' with your actual values.

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

--------------------------------

### InstallPackage API Reference (v1)

Source: https://developer.cisco.com/docs/secure-endpoint/installpackage

Documentation for the InstallPackage resource within the Secure Endpoint API v1.

```APIDOC
## InstallPackage

### Description
Provides information and management capabilities for install packages within Secure Endpoint.

### Endpoint
`/v1/installpackage`

### Method
GET
```

--------------------------------

### Computer Activity

Source: https://developer.cisco.com/docs/secure-endpoint/computer-activity

Fetches a list of computers that have observed files with a given file name.

```APIDOC
## GET /v0/computers/activity

### Description
Fetch list of computers that have observed files with given file name

### Method
GET

### Endpoint
/v0/computers/activity

### Schemas
Metadata
Error
Next
```

--------------------------------

### Policy Sorting Documentation

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Documentation is now available for sorting policies by name and direction.

```APIDOC
## GET /organizations/{organizationIdentifier}/policies

### Description
Retrieves a list of policies, with options for sorting by name and direction.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/policies

### Parameters
#### Query Parameters
- **sort_by** (string) - Optional - Field to sort policies by (e.g., 'name').
- **sort_direction** (string) - Optional - Direction of sorting ('asc' or 'desc').
```

--------------------------------

### API Changelog - 2025-06-12 (v1)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Endpoint updated for downloading Windows ARM connectors.

```APIDOC
## 2025-06-12 (v1)
### Updated
  * Windows ARM connectors can be downloaded using the following endpoint:
    * `POST /v1/install_packages`
```

--------------------------------

### Generate all policy types and operating systems available for a specified organization

Source: https://developer.cisco.com/docs/secure-endpoint

This endpoint retrieves a list of all available policy types and operating systems that can be configured for a specified organization. This is useful for understanding the range of policy options.

```APIDOC
## GET /organizations/{organization_id}/policy_types

### Description
Generate all policy types and operating systems available for a specified organization.

### Method
GET

### Endpoint
/organizations/{organization_id}/policy_types

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The unique identifier for the organization.
```

--------------------------------

### Policy Filtering Documentation

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Documentation is now available for filtering policies by their assigned device control configuration.

```APIDOC
## GET /organizations/{organizationIdentifier}/policies

### Description
Retrieves a list of policies, with the ability to filter by assigned device control configuration.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/policies

### Parameters
#### Query Parameters
- **device_control_configuration_id** (string) - Optional - Filters policies by the ID of their assigned device control configuration.
```

--------------------------------

### Obtain Specific Policy Information

Source: https://developer.cisco.com/docs/secure-endpoint/getting-started

Retrieve detailed information for a specific policy using its GUID and the organization identifier.

```APIDOC
## 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
curl --request GET \
  --url https://api.amp.cisco.com/v3/organizations/4baasceazofqpxidpinxtt5l/policies/31c0d995-9bdd-403e-a4dd-092bf94aa0f0 \
  --header 'Authorization: Bearer {BEARER_TOKEN}'
```
```

--------------------------------

### Device Control Configurations

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Manage device control configurations, including creating new ones and retrieving existing ones.

```APIDOC
## POST /organizations/{organizationIdentifier}/device_control/configurations

### Description
Allows an extra attribute `deviceClass`, with the supported values being either 'usb_mass_storage' or 'windows_portable_device'.

### Method
POST

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations
```

```APIDOC
## GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}

### Description
Returns an extra attribute `deviceClass`, with the default value as 'usb_mass_storage'.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}
```

```APIDOC
## GET /organizations/{organizationIdentifier}/device_control/configurations

### Description
Returns an extra attribute `deviceClass`, with the default value as 'usb_mass_storage'.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations
```

```APIDOC
## POST /organizations/{organizationIdentifier}/device_control/configurations

### Description
Returns an extra attribute `deviceClass`, with the default value as 'usb_mass_storage'.

### Method
POST

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations
```

```APIDOC
## GET /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration

### Description
Returns an extra attribute `permitted` which could be false when a non-admin doesn't have access to the configuration.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration
```

```APIDOC
## GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}

### Description
Returns an extra attribute `guid` on the `baseRule` which uniquely identifies the base rule.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}
```

```APIDOC
## GET /organizations/{organizationIdentifier}/device_control/configurations

### Description
Returns an extra attribute `guid` on the `baseRule` which uniquely identifies the base rule for each configuration.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations
```

```APIDOC
## POST /organizations/{organizationIdentifier}/device_control/configurations

### Description
Returns an extra attribute `guid` on the `baseRule` which uniquely identifies the base rule for the newly created configuration.

### Method
POST

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations
```

```APIDOC
## POST /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rule_composer

### Description
Allows changes to be applied to multiple rules of the specified device control configuration with one request.

### Method
POST

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rule_composer
```

--------------------------------

### Get Audit Logs (v3)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Retrieve audit logs for an organization using specified filters. Available in API v3.

```bash
GET /v3/organizations/{organizationIdentifier}/audit_logs
```

--------------------------------

### Device Control API Documentation

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Comprehensive documentation has been added for various Device Control APIs, including listing, creating, updating, showing, and deleting configurations and rules, as well as assigning and un-assigning configurations to policies.

```APIDOC
## Device Control APIs

### List Device Control Configurations
#### GET /organizations/{organizationIdentifier}/device_control/configurations
Lists device control configurations within an organization, supporting sort and search.

### Create Device Control Configuration
#### POST /organizations/{organizationIdentifier}/device_control/configurations
Creates a new device control configuration.

### Update Device Control Configuration Properties
#### PUT /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}
Updates properties of an existing device control configuration.

### Show Device Control Configuration Details
#### GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}
Retrieves details of a specific device control configuration.

### Delete Device Control Configuration
#### DELETE /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}
Deletes a device control configuration from an organization.

### List Device Control Rules
#### GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules
Lists rules belonging to a specific device control configuration.

### Add Rule to Device Control Configuration
#### POST /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules
Adds a new rule to a device control configuration.

### Update Device Control Rule
#### PUT /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules/{ruleGuid}
Updates an existing rule within a device control configuration.

### Delete Device Control Rule
#### DELETE /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules/{ruleGuid}
Deletes a rule from a device control configuration.

### Assign Device Control Configuration to Policy
#### PUT /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration
Assigns a device control configuration to a policy.

### Un-assign Device Control Configuration from Policy
#### DELETE /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration
Un-assigns a device control configuration from a policy.
```

--------------------------------

### Get Audit Log Types (v3)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Retrieve a list of supported audit log types for the API. Available in API v3.

```bash
GET /v3/organizations/{organizationIdentifier}/audit_log_types
```

--------------------------------

### Secure Endpoint API Access Token Response

Source: https://developer.cisco.com/docs/secure-endpoint/authentication

Example JSON response from the Secure Endpoint token endpoint, containing the generated access token.

```json
Copy{
  "access_token": "eyJhbGciO..."
}


```

--------------------------------

### Secure Endpoint API v0 - Computer

Source: https://developer.cisco.com/docs/secure-endpoint/computer

Reference for managing computer resources within the Secure Endpoint API v0.

```APIDOC
## Computer API Reference (v0)

This section details the operations available for managing computer resources via the Secure Endpoint API v0.

### Operations

- **Get Computer**: Retrieves information about a specific computer.

### Parameters

- **Computer ID**: Unique identifier for a computer (Path Parameter, Required).

### Response

- **Success Response (200 OK)**: Returns computer details.
- **Error Responses**: Standard error codes.

### Example Usage (Conceptual)

```http
GET /v0/computer/{computer_id}
```
```

--------------------------------

### API Access Token Response

Source: https://developer.cisco.com/docs/secure-endpoint/authentication

This is an example JSON response from the OAuth2 token endpoint, containing the access token, token type, expiration time, and granted scopes.

```json
Copy{
  "access_token": "eyJhbGciO...",
  "token_type": "bearer",
  "expires_in": 600,
  "scope": "enrich:read casebook inspect:read"
}


```

--------------------------------

### Computer Uninstall Request

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Request uninstallation for a connector on a computer.

```APIDOC
## PUT /organizations/{organizationIdentifier}/computers/{computer_guid}/uninstall_request

### Description
Requests uninstallation for the connector with the given computer_guid.

### Method
PUT

### Endpoint
/organizations/{organizationIdentifier}/computers/{computer_guid}/uninstall_request
```

```APIDOC
## PUT /organizations/{organizationIdentifier}/computers/{computer_guid}/uninstall_request

### Description
Bad request response with a descriptive error message for this endpoint.

### Method
PUT

### Endpoint
/organizations/{organizationIdentifier}/computers/{computer_guid}/uninstall_request
```

--------------------------------

### Secure Endpoint API v1 - Computer

Source: https://developer.cisco.com/docs/secure-endpoint/computer

Reference for managing computer resources within the Secure Endpoint API v1.

```APIDOC
## Computer API Reference (v1)

This section details the operations available for managing computer resources via the Secure Endpoint API v1.

### Operations

- **Get Computer**: Retrieves information about a specific computer.

### Parameters

- **Computer ID**: Unique identifier for a computer (Path Parameter, Required).

### Response

- **Success Response (200 OK)**: Returns computer details.
- **Error Responses**: Standard error codes.

### Example Usage (Conceptual)

```http
GET /v1/computer/{computer_id}
```
```

--------------------------------

### Device Control Configurations

Source: https://developer.cisco.com/docs/secure-endpoint/device-control

Routes related to device control configurations.

```APIDOC
## GET /organizations/{organizationIdentifier}/device_control/configurations

### Description
List/search for configurations

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations

## POST /organizations/{organizationIdentifier}/device_control/configurations

### Description
Create configuration

### Method
POST

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations
```

--------------------------------

### Update MSSP Customer Status (v3)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Update the status of an MSSP customer, including changing response codes for PUT/DELETE operations and modifying request parameters for POST/PUT. Also, the 'businessGuid' field in the response for POST operations has been changed to 'guid'. Available in API v3.

```bash
PUT /v3/organizations/{organizationIdentifier}/mssp/customers/{customerGuid}
```

```bash
DELETE /v3/organizations/{organizationIdentifier}/mssp/customers/{customerGuid}
```

```bash
POST /v3/organizations/{organizationIdentifier}/mssp/customers
```

```bash
GET /v3/organizations/{organizationIdentifier}/mssp/customers
```

--------------------------------

### Secure Endpoint API v3 - Computers

Source: https://developer.cisco.com/docs/secure-endpoint/computer

Reference for managing computer-related resources within the Secure Endpoint API v3.

```APIDOC
## Computers API Reference (v3)

This section details the operations available for managing computer resources via the Secure Endpoint API v3.

### Operations

- **List Computers**: Retrieves a list of computers.
- **Get Computer Details**: Retrieves detailed information about a specific computer.
- **Update Computer**: Modifies the details of an existing computer.
- **Delete Computer**: Removes a computer from the system.

### Parameters

- **Computer ID**: Unique identifier for a computer (Path Parameter, Required).
- **Query Parameters**: Various parameters may be available for filtering and pagination (e.g., `filter`, `sort`, `limit`, `offset`).

### Request Body (for Update/Create operations)

- **field_name** (type) - Required/Optional - Description of the field.

### Response

- **Success Response (200 OK)**: Returns a list of computers or a single computer object with details.
- **Error Responses**: Standard error codes for authentication, authorization, and resource not found.

### Example Usage (Conceptual)

```http
GET /v3/computers?filter=online
GET /v3/computers/{computer_id}
```
```

--------------------------------

### Windows Portable Device (WPD) Control Configuration

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Manage Windows portable device control configurations for policies.

```APIDOC
## GET /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/windows_portable_device

### Description
Returns the information about the Windows portable device (WPD) device control configuration attached to the specified policy, if any.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/windows_portable_device
```

```APIDOC
## PUT /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/windows_portable_device

### Description
Assigns a Windows portable device (WPD) device control configuration to the specified policy.

### Method
PUT

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/windows_portable_device
```

```APIDOC
## DELETE /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/windows_portable_device

### Description
Removes the Windows portable device (WPD) device control configuration from the specified policy, if any.

### Method
DELETE

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/windows_portable_device
```

--------------------------------

### New Rule Creation Response

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

The successful response for `POST /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules` will no longer return a response body. The URL of the newly created rule can be obtained from the `Location` header.

```APIDOC
## POST /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules

### Description
Adds a new rule to a device control configuration.

### Method
POST

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules

### Response
#### Success Response (201)
- **Location** (string) - The URL of the newly created rule.
```

--------------------------------

### Exclusion Sets API Documentation

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Comprehensive documentation has been added for Exclusion Sets APIs, including listing Cisco-Maintained sets, creating, listing, and showing organization-specific sets, managing sets applied to policies, and managing individual exclusions within sets.

```APIDOC
## Exclusion Sets APIs

### List Cisco-Maintained Exclusion Sets
#### GET /organizations/{organizationIdentifier}/exclusion_sets/cisco_maintained
Lists Cisco-Maintained exclusion sets available to all organizations.

### Create Exclusion Set
#### POST /organizations/{organizationIdentifier}/exclusion_sets
Creates a new exclusion set within an organization.

### List Organization Exclusion Sets
#### GET /organizations/{organizationIdentifier}/exclusion_sets
Lists exclusion sets available to the user within an organization.

### List Exclusion Sets Applied to Policy
#### GET /organizations/{organizationIdentifier}/policies/{policyGuid}/exclusion_sets
Lists exclusion sets applied to a specific policy.

### Show Exclusion Set Details
#### GET /organizations/{organizationIdentifier}/exclusion_sets/{exclusionSetGuid}
Retrieves details of a specific exclusion set.

### Delete Exclusion Set
#### DELETE /organizations/{organizationIdentifier}/exclusion_sets/{exclusionSetGuid}
Deletes an exclusion set from an organization.

### Add Exclusion Set to Policy
#### POST /organizations/{organizationIdentifier}/policies/{policyGuid}/exclusion_sets/{exclusionSetGuid}
Adds an exclusion set to a policy.

### Remove Exclusion Set from Policy
#### DELETE /organizations/{organizationIdentifier}/policies/{policyGuid}/exclusion_sets/{exclusionSetGuid}
Removes an exclusion set from a policy.

### List Exclusions in Exclusion Set
#### GET /organizations/{organizationIdentifier}/exclusion_sets/{exclusionSetGuid}/exclusions
Gets a list of exclusions for any exclusion set (that the user has access to) found in their organization.

### Remove Exclusion from Exclusion Set
#### DELETE /organizations/{organizationIdentifier}/exclusion_sets/{exclusionSetGuid}/exclusions/{exclusionGuid}
Removes an exclusion from an exclusion set.

### Show Exclusion Details
#### GET /organizations/{organizationIdentifier}/exclusion_sets/{exclusionSetGuid}/exclusions/{exclusionGuid}
Retrieves details of a specific exclusion.

### Create Exclusion
#### POST /organizations/{organizationIdentifier}/exclusion_sets/{exclusionSetGuid}/exclusions
Creates a new exclusion within an organization for a specific exclusion set.
```

--------------------------------

### Computers Options Endpoint

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

New OPTIONS endpoint for computers.

```APIDOC
## OPTIONS /v1/computers/

### Description
Provides options for the computers endpoint.

### Method
OPTIONS

### Endpoint
/v1/computers/
```

--------------------------------

### Host Firewall Endpoints Added

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

New Host Firewall endpoints have been added for managing firewall configurations.

```APIDOC
## GET /v3/organizations/{organizationIdentifier}/host_firewall/

### Description
Retrieves Host Firewall configurations.

### Method
GET

### Endpoint
/v3/organizations/{organizationIdentifier}/host_firewall/
```

--------------------------------

### USB Mass Storage Device Control Configuration

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Manage USB mass storage device control configurations for policies.

```APIDOC
## GET /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/usb_mass_storage

### Description
Returns the information about the USB mass storage device control configuration attached to the specified policy, if any.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/usb_mass_storage
```

```APIDOC
## PUT /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/usb_mass_storage

### Description
Assigns a USB mass storage device control configuration to the specified policy.

### Method
PUT

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/usb_mass_storage
```

```APIDOC
## DELETE /organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/usb_mass_storage

### Description
Removes the USB mass storage device control configuration from the specified policy, if any.

### Method
DELETE

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}/device_control_configuration/usb_mass_storage
```

--------------------------------

### Uninstall Request Endpoint Error Handling

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Improved error handling for the uninstall request endpoint, providing descriptive error messages for bad requests.

```APIDOC
## PUT /organizations/{organizationIdentifier}/computers/{computer_guid}/uninstall_request

### Description
Requests the uninstallation of a computer. Now provides descriptive error messages for bad requests.

### Method
PUT

### Endpoint
/organizations/{organizationIdentifier}/computers/{computer_guid}/uninstall_request
```

--------------------------------

### API Changelog - 2025-03-03 (v3)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

New MSSP API endpoints for customer management.

```APIDOC
## 2025-03-03 (v3)
### Added
  * Added MSSP API endpoints for fetching customers, customer creation, customer status, update customer, and disable customer:
    * `GET /v3/organizations/{organizationIdentifier}/mssp/customers`
    * `POST /v3/organizations/{organizationIdentifier}/mssp/customers`
    * `PUT /v3/organizations/{organizationIdentifier}/mssp/customers/{customerGuid}`
    * `DELETE /v3/organizations/{organizationIdentifier}/mssp/customers/{customerGuid}`
    * `GET /v3/organizations/{organizationIdentifier}/mssp/customers/{customerGuid}/status`
```

--------------------------------

### Obtain List of Policies (curl)

Source: https://developer.cisco.com/docs/secure-endpoint/getting-started

Use this curl command to retrieve a list of policies for a specific organization. Replace the organization identifier and '{BEARER_TOKEN}' with your actual values.

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

--------------------------------

### Computer Endpoints with Host Firewall Information

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Computer endpoints now include host firewall status and configuration in their responses.

```APIDOC
## GET /v0/computers

### Description
Retrieves a list of computers, including host firewall information.

### Method
GET

### Endpoint
/v0/computers
```

```APIDOC
## GET /v0/computers/{connectorGUID}

### Description
Retrieves details for a specific computer, including host firewall information.

### Method
GET

### Endpoint
/v0/computers/{connectorGUID}
```

```APIDOC
## GET /v1/computers

### Description
Retrieves a list of computers, including host firewall information.

### Method
GET

### Endpoint
/v1/computers
```

```APIDOC
## GET /v1/computers/{connectorGUID}

### Description
Retrieves details for a specific computer, including host firewall information.

### Method
GET

### Endpoint
/v1/computers/{connectorGUID}
```

--------------------------------

### Policy Links Update

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Links for policy delete and device_control_configuration have been added to the meta section for `/organizations/{organizationIdentifier}/policies/{policyGuid}`.

```APIDOC
## GET /organizations/{organizationIdentifier}/policies/{policyGuid}

### Description
Retrieves details for a specific policy.

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/policies/{policyGuid}

### Response
#### Success Response (200)
- **meta** (object) - Contains links for policy delete and device_control_configuration.
```

--------------------------------

### Manage MSSP Customers (v3)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Endpoints for fetching, creating, updating, deleting, and retrieving the status of MSSP customers. Available in API v3.

```bash
GET /v3/organizations/{organizationIdentifier}/mssp/customers
```

```bash
POST /v3/organizations/{organizationIdentifier}/mssp/customers
```

```bash
PUT /v3/organizations/{organizationIdentifier}/mssp/customers/{customerGuid}
```

```bash
DELETE /v3/organizations/{organizationIdentifier}/mssp/customers/{customerGuid}
```

```bash
GET /v3/organizations/{organizationIdentifier}/mssp/customers/{customerGuid}/status
```

--------------------------------

### Device Control Configuration

Source: https://developer.cisco.com/docs/secure-endpoint/device-control

Routes related to a single device control configuration.

```APIDOC
## GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}

### Description
Find configuration by ID

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}

## DELETE /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}

### Description
Delete configuration by ID

### Method
DELETE

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}

## PUT /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}

### Description
Update configuration by ID

### Method
PUT

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}

## GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/computer_count

### Description
Get configuration computer count

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/computer_count

## GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/group_count

### Description
Get configuration group count

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/group_count

## GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/unsupported_connector_count

### Description
Get configuration unsupported connector count

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/unsupported_connector_count
```

--------------------------------

### Fetch Devices (v3)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Retrieve information about devices within an organization, including specific device details and associated vulnerabilities. Available in API v3.

```bash
GET /v3/organizations/{organizationIdentifier}/devices
```

```bash
GET /v3/organizations/{organizationIdentifier}/devices/{device_guid}
```

```bash
GET /v3/organizations/{organizationIdentifier}/devices/{device_guid}/vulnerabilities
```

--------------------------------

### Connector Upgrade Policy

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

Manage connector versions for policies.

```APIDOC
## GET /v1/policies/{policy_guid}/connector_upgrade

### Description
Shows connector version for a policy.

### Method
GET

### Endpoint
/v1/policies/{policy_guid}/connector_upgrade
```

```APIDOC
## PUT /v1/policies/{policy_guid}/connector_upgrade

### Description
Assigns connector version to a policy. Response changed from `202 Accepted` to `200 Successful response`.

### Method
PUT

### Endpoint
/v1/policies/{policy_guid}/connector_upgrade
```

```APIDOC
## DELETE /v1/policies/{policy_guid}/connector_upgrade

### Description
Unassigns connector version from a policy.

### Method
DELETE

### Endpoint
/v1/policies/{policy_guid}/connector_upgrade
```

--------------------------------

### API Changelog - 2025-05-08 (v3)

Source: https://developer.cisco.com/docs/secure-endpoint/whats-new

New Devices API endpoints added, and some v1 endpoints deprecated.

```APIDOC
## 2025-05-08 (v3)
### Added
  * Added Devices API endpoints for fetching devices:
    * `GET /v3/organizations/{organizationIdentifier}/devices`
    * `GET /v3/organizations/{organizationIdentifier}/devices/{device_guid}`
    * `GET /v3/organizations/{organizationIdentifier}/devices/{device_guid}/vulnerabilities`

### Deprecated
  * `GET /v1/computers/{connector_guid}/vulnerabilities`
  * `GET /v1/computers/{connector_guid}/os_vulnerabilities`
```

--------------------------------

### Generate a list of policies for a specified organization

Source: https://developer.cisco.com/docs/secure-endpoint

This endpoint retrieves a list of all policies associated with a specific organization. It allows users to see the policy landscape within a given organizational context.

```APIDOC
## GET /organizations/{organization_id}/policies

### Description
Generate a list of policies for a specified organization.

### Method
GET

### Endpoint
/organizations/{organization_id}/policies

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The unique identifier for the organization.
```

--------------------------------

### Device Control Rules

Source: https://developer.cisco.com/docs/secure-endpoint/device-control

Routes related to device control rules of a specific device control configuration.

```APIDOC
## GET /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules

### Description
Get configuration rules

### Method
GET

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules

## POST /organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules

### Description
Create a configuration rule

### Method
POST

### Endpoint
/organizations/{organizationIdentifier}/device_control/configurations/{configurationGuid}/rules
```

--------------------------------

### Generate a list of organizations a user has access to

Source: https://developer.cisco.com/docs/secure-endpoint

This endpoint retrieves a list of organizations that the authenticated user has access to. This is useful for understanding the scope of management within the Secure Endpoint system.

```APIDOC
## GET /organizations

### Description
Generate a list of organizations a user has access to.

### Method
GET

### Endpoint
/organizations
```

--------------------------------

### Generate specific information about a specified policy

Source: https://developer.cisco.com/docs/secure-endpoint

This endpoint provides detailed information about a specific policy, including general data, associated network control lists, computers, groups, proxy settings, and the policy's XML representation.

```APIDOC
## GET /organizations/{organization_id}/policies/{policy_id}

### Description
Generate specific information about a specified policy.

### Method
GET

### Endpoint
/organizations/{organization_id}/policies/{policy_id}

### Parameters
#### Path Parameters
- **organization_id** (string) - Required - The unique identifier for the organization.
- **policy_id** (string) - Required - The unique identifier for the policy.
```