Devices API Migration

The integrationServices/v3/Devices API will be deactivated on September 5, 2024.

Overview

This is to assist in migrating integrations from integrationServices/v3/Devices API to appServices v6 - Devices API

In this document, you will find

  • A mapping of deprecated v3 Devices API endpoints to new v6 Devices API endpoints
  • Access to the full schema definition for the v6 Devices API
  • Example payloads for some of the new endpoints

Guides and Resources

Key Differences

  • 10k records returned for Device Search with the ability to return 200k with pagination
  • CSV Export
  • Moving from a limited search endpoint with query parameters to a new POST endpoint with search criteria in the request body
  • Policy can be updated for many devices per request
  • Manage your devices using a single CUSTOM API key, allowing for more granular permission controls when creating API keys

API Endpoints

Operation Legacy v3 Devices API Endpoint New v6 Devices API Endpoint
Bulk Search/Export Devices GET /integrationServices/v3/device/all?fileFormat={option} POST /appservices/v6/orgs/{org_key}/devices/_search
POST /appservices/v6/orgs/{org_key}/devices/_search/download
Device Status GET /integrationServices/v3/device POST /appservices/v6/orgs/{org_key}/devices/_search
POST /appservices/v6/orgs/{org_key}/devices/_search/download
Get By Device ID GET /integrationServices/v3/device/{id} GET /appservices/v6/orgs/{org_key}/devices/{device_id}
Change Status of Individual Device - Update Policy PATCH /integrationServices/v3/device/{id} POST /appservices/v6/orgs/{org_key}/device_actions - Update Policy

New Endpoints and Device Actions

Check out the full Schema Definition for the new v6 Devices API

Examples

Search Devices


Examples

Request 
POST https://defense.conferdeploy.net/appservices/v6/orgs/ABCD1234/devices/_search
Request Headers 
X-AUTH-TOKEN: "ABCDEFGHIJKLMNO123456789/ABCD123456"
Content-Type: "application/json"
Request Body 
{
	"criteria": {
        "deployment_type": ["ENDPOINT"],
        "target_priority": ["MEDIUM"],
        "last_contact_time": {
            "start": "2022-07-12T22:04:42.993Z",
            "end": "2022-07-10T22:04:42.993ZZ"
        }
    },
	"rows": 5,
	"start": 0,
	"sort": [
		{
			"field": "av_pack_version",
			"order": "ASC"
		}
	]
}
To download or review the Carbon Black Cloud Postman collection, click here.

Device Actions - Update Policy


Examples

Request 
POST https://defense.conferdeploy.net/appservices/v6/orgs/ABCD1234/device_actions
Request Headers 
X-AUTH-TOKEN: "ABCDEFGHIJKLMNO123456789/ABCD123456"
Content-Type: "application/json"
Request Body 
{
    "action_type": "UPDATE_POLICY",
    "device_id": ["1777009", "1777303"],
    "options": {
        "policy_id": "12436"
    }
}
To download or review the Carbon Black Cloud Postman collection, click here.

Carbon Black Cloud Python SDK Migration

If you are using the Carbon Black Cloud Python SDK (lovingly known as the CBC SDK), then you are already using the latest API.

If you are still using CBAPI, it’s time to upgrade and get all the benefits of the new Carbon Black Cloud features and improvements in the SDK.


Last modified on June 3, 2023