File Metadata Collection exclusions via API

Step 1: Find your top-level OrgID

To view and edit exclusions, you must first identify your top-level organization's numeric ID. 

Step 2: View existing exclusions

Use the GET method to view existing exclusions. The OrgSettings resource also contains keys for numerous other Code42 settings. Therefore, to view only the exclusions, you must include the appropriate key as a query parameter.

The example below assumes basic familiarity with curl commands. Use this as a template to create a command specific to your Code42 environment:

Copy to clipboardCopied!

curl -X GET \
  '<request_url>/api/v1/OrgSettings/<OrgID>?keys=device_fileForensics_fileExclusions_org' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <auth_token>'

1. Replace <request_url> with the address of your Code42 environment (do not include the brackets in your request).
2. Replace <OrgID> with the number identified in Step 1 above (do not include the brackets in your request).
3. Replace <auth_token> with an authentication token.
4. For Incydr Professional, Enterprise, Horizon, and Gov F2, change the key from device_fileForensics_fileExclusions_org to artemis_device_fileForensics_fileExclusions_org.
5. Execute the curl command in your command-line tool of choice. When prompted, enter your password.
   The Code42 API returns the existing exclusions. If no exclusions exist yet, the data object in the response is empty.

Step 3: Update or add new exclusions

Use the PUT method to add or modify exclusions. Before sending any updates, make sure to complete Step 2 above to obtain the list of existing exclusions.

The steps below assume basic familiarity with curl commands. Use the following example as a template to create a command specific to your Code42 environment.

Copy to clipboardCopied!

curl -X PUT \
  '<request_url>/api/v1/OrgSettings/<OrgID>' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <auth_token>' \
  -d '{ 
    "packets": [
        {
            "key": "device_fileForensics_fileExclusions_org",
            "value": {
                "all":[ "'.*cache.*'" ], 
                "macintosh":[ "'.*.db'" ], 
                "windows":[ "'.*.etl'", "'.*.tmp'" ], 
                "linux": [ "'/sys/.*'", "'/proc/.*'" ]
            },
            "locked": true
        }
    ]
}'

1. Replace <request_url> with the address of your Code42 environment (do not include the brackets in your request).
2. Replace <OrgID> with the number identified in Step 1 above (do not include the brackets in your request).
3. Replace <auth_token> with an authentication token.
4. For Incydr Professional, Enterprise, Horizon, and Gov F2, change the key from device_fileForensics_fileExclusions_org to artemis_device_fileForensics_fileExclusions_org.
5. Define exclusions with regex for each operating system in use in your Code42 environment. Defining specific exclusions for each operating system minimizes the resources required on user devices. In this example:
   • All devices will exclude files with the .cache extension
   • Mac devices will exclude files with the .db extension
   • Windows devices will exclude files with the .etl and .tmp extension
   • Linux devices will exclude files in the sys and proc directories
6. Execute the curl command in your command-line tool of choice. When prompted, enter your password.
   A 204 No Content response indicates the Code42 cloud received the request and applied the exclusions to user devices.