Device Control Policies

Using the Device Control Policies service collection

Table of Contents

Operation ID	Description
queryCombinedDeviceControlPolicyMembers PEP 8 query_combined_policy_members	Search for members of a Device Control Policy in your environment by providing a FQL filter and paging details. Returns a set of host details which match the filter criteria
queryCombinedDeviceControlPolicies PEP 8 query_combined_policies	Search for Device Control Policies in your environment by providing a FQL filter and paging details. Returns a set of Device Control Policies which match the filter criteria
performDeviceControlPoliciesAction PEP 8 perform_action	Perform the specified action on the Device Control Policies specified in the request
setDeviceControlPoliciesPrecedence PEP 8 set_precedence	Sets the precedence of Device Control Policies based on the order of IDs specified in the request. The first ID specified will have the highest precedence and the last ID specified will have the lowest. You must specify all non-Default Policies for a platform when updating precedence
getDeviceControlPolicies PEP 8 get_policies	Retrieve a set of Device Control Policies by specifying their IDs
createDeviceControlPolicies PEP 8 create_policies	Create Device Control Policies by specifying details about the policy to create
deleteDeviceControlPolicies PEP 8 delete_policies	Delete a set of Device Control Policies by specifying their IDs
updateDeviceControlPolicies PEP 8 update_policies	Update Device Control Policies by specifying the ID of the policy and details to update
queryDeviceControlPolicyMembers PEP 8 query_policy_members	Search for members of a Device Control Policy in your environment by providing a FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria
queryDeviceControlPolicies PEP 8 query_policies	Search for Device Control Policies in your environment by providing a FQL filter and paging details. Returns a set of Device Control Policy IDs which match the filter criteria

queryCombinedDeviceControlPolicyMembers

Search for members of a Device Control Policy in your environment by providing a FQL filter and paging details. Returns a set of host details which match the filter criteria

PEP8 method name

query_combined_policy_members

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
filter			query	string	FQL Syntax formatted string used to limit the results.
id			query	integer	The ID of the Device Control Policy to search for members of.
limit			query	integer	Maximum number of records to return. (Max: 5000)
offset			query	integer	Starting index of overall result set from which to return ids.
sort			query	string	The property to sort by. (Ex: modified_timestamp.desc)
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.query_combined_policy_members(id="string",
                                                filter="string",
                                                offset=integer,
                                                limit=integer,
                                                sort="string"
                                                )
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.queryCombinedDeviceControlPolicyMembers(id="string",
                                                          filter="string",
                                                          offset=integer,
                                                          limit=integer,
                                                          sort="string"
                                                          )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("queryCombinedDeviceControlPolicyMembers",
                          id="string",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)

queryCombinedDeviceControlPolicies

Search for Device Control Policies in your environment by providing a FQL filter and paging details. Returns a set of Device Control Policies which match the filter criteria

PEP8 method name

query_combined_policies

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
filter			query	string	FQL Syntax formatted string used to limit the results.
limit			query	integer	Maximum number of records to return. (Max: 5000)
offset			query	integer	Starting index of overall result set from which to return ids.
sort			query	string	The property to sort by. (Ex: modified_timestamp.desc)
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.query_combined_policies(filter="string",
                                          offset=integer,
                                          limit=integer,
                                          sort="string"
                                          )
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.queryCombinedDeviceControlPolicies(filter="string",
                                                     offset=integer,
                                                     limit=integer,
                                                     sort="string"
                                                     )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("queryCombinedDeviceControlPolicies",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)

performDeviceControlPoliciesAction

Perform the specified action on the Device Control Policies specified in the request

PEP8 method name

perform_action

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
action_name			query	string	The action to perform. Allowed values: add-host-group disable enable remove-host-group
action_parameters			body	list of dictionaries	List of name / value pairs in JSON format.
body			body	string	Full body payload in JSON format.
ids			body	string or list of strings	Device Control Policy ID(s) to perform actions against.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

act_params = [{
    "name": "string",
    "value": "string"
}]

id_list = "ID1,ID2,ID3"  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.perform_action(action_name="string",
                                 action_parameters=act_params,
                                 ids=id_list
                                 )
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

act_params = [{
    "name": "string",
    "value": "string"
}]

id_list = "ID1,ID2,ID3"  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.performDeviceControlPoliciesAction(action_name="string",
                                                     action_parameters=act_params,
                                                     ids=id_list
                                                     )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

act_params = [{
    "name": "string",
    "value": "string"
}]

id_list = "ID1,ID2,ID3"  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

PARAMS = {
    "action_name": "string"  # Can also provide this using the `action_name` keyword
}

BODY = {
    "action_parameters": act_params,
    "ids": id_list
}

response = falcon.command("performDeviceControlPoliciesAction", parameters=PARAMS, body=BODY)
print(response)

setDeviceControlPoliciesPrecedence

Sets the precedence of Device Control Policies based on the order of IDs specified in the request. The first ID specified will have the highest precedence and the last ID specified will have the lowest. You must specify all non-Default Policies for a platform when updating precedence

PEP8 method name

set_precedence

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	string	Full body payload in JSON format.
ids			body	string or list of strings	Device Control Policy ID(s) to adjust precedence.
platform_name			body	string	OS platform name. (Linux, Mac, Windows)

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.set_precedence(ids=id_list, platform_name="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.setDeviceControlPoliciesPrecedence(ids=id_list, platform_name="string")
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

BODY = {
    "ids": id_list,
    "platform_name": "string"
}

response = falcon.command("setDeviceControlPoliciesPrecedence", body=BODY)
print(response)

getDeviceControlPolicies

Retrieve a set of Device Control Policies by specifying their IDs

PEP8 method name

get_policies

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
ids			query	string or list of strings	The ID(s) of the Device Control Policies to return.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_policies(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.getDeviceControlPolicies(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("getDeviceControlPolicies", ids=id_list)
print(response)

createDeviceControlPolicies

Create Device Control Policies by specifying details about the policy to create

PEP8 method name

create_policies

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	string	Full body payload in JSON format.
description			body	string	Device Control Policy description.
clone_id			body	string	Device Control Policy ID to clone.
name			body	string	Device Control Policy name.
platform_name			body	string	Device Control Policy platform.
settings			body	dictionary	Device Control specific settings.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

dc_settings = {
    "classes": [
    {
        "action": "FULL_ACCESS",
        "exceptions": [
        {
            "action": "string",
            "class": "string",
            "combined_id": "string",
            "id": "string",
            "match_method": "string",
            "product_id": "string",
            "product_id_decimal": "string",
            "product_name": "string",
            "serial_number": "string",
            "vendor_id": "string",
            "vendor_id_decimal": "string",
            "vendor_name": "string"
        }
        ],
        "id": "string"
    }
    ],
    "end_user_notification": "TRUE",
    "enforcement_mode": "string",
    "id": "string"
}

response = falcon.create_policies(clone_id="string",
                                  description="string",
                                  name="string",
                                  platform_name="string",
                                  settings=dc_settings
                                  )
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

dc_settings = {
    "classes": [
    {
        "action": "FULL_ACCESS",
        "exceptions": [
        {
            "action": "string",
            "class": "string",
            "combined_id": "string",
            "id": "string",
            "match_method": "string",
            "product_id": "string",
            "product_id_decimal": "string",
            "product_name": "string",
            "serial_number": "string",
            "vendor_id": "string",
            "vendor_id_decimal": "string",
            "vendor_name": "string"
        }
        ],
        "id": "string"
    }
    ],
    "end_user_notification": "TRUE",
    "enforcement_mode": "string",
    "id": "string"
}


response = falcon.createDeviceControlPolicies(clone_id="string",
                                              description="string",
                                              name="string",
                                              platform_name="string",
                                              settings=dc_settings
                                              )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "resources": [
        {
            "clone_id": "string",
            "description": "string",
            "name": "string",
            "platform_name": "Windows",
            "settings": {
                "classes": [
                {
                    "action": "FULL_ACCESS",
                    "exceptions": [
                    {
                        "action": "string",
                        "class": "string",
                        "combined_id": "string",
                        "id": "string",
                        "match_method": "string",
                        "product_id": "string",
                        "product_id_decimal": "string",
                        "product_name": "string",
                        "serial_number": "string",
                        "vendor_id": "string",
                        "vendor_id_decimal": "string",
                        "vendor_name": "string"
                    }
                    ],
                    "id": "string"
                }
                ],
                "end_user_notification": "TRUE",
                "enforcement_mode": "string",
                "id": "string"
            }
        }
    ]
}

response = falcon.command("createDeviceControlPolicies", body=BODY)
print(response)

deleteDeviceControlPolicies

Delete a set of Device Control Policies by specifying their IDs

PEP8 method name

delete_policies

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
ids			query	string or list of strings	The ID(s) of the Device Control Policies to delete.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.delete_policies(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.deleteDeviceControlPolicies(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("deleteDeviceControlPolicies", ids=id_list)
print(response)

updateDeviceControlPolicies

Update Device Control Policies by specifying the ID of the policy and details to update

PEP8 method name

update_policies

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	string	Full body payload in JSON format.
description			body	string	Device Control Policy description.
id			body	string	Device Control Policy ID to update.
name			body	string	Device Control Policy name.
settings			body	dictionary	Device control specific policy settings.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.update_policies(description="string",
                                  id="string",
                                  name="string",
                                  platform_name="string"
                                  )
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.updateDeviceControlPolicies(description="string",
                                              id="string",
                                              name="string",
                                              platform_name="string"
                                              )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "resources": [
        {
            "clone_id": "string",
            "description": "string",
            "name": "string",
            "platform_name": "Windows",
            "settings": {
                "classes": [
                {
                    "action": "FULL_ACCESS",
                    "exceptions": [
                    {
                        "action": "string",
                        "class": "string",
                        "combined_id": "string",
                        "id": "string",
                        "match_method": "string",
                        "product_id": "string",
                        "product_id_decimal": "string",
                        "product_name": "string",
                        "serial_number": "string",
                        "vendor_id": "string",
                        "vendor_id_decimal": "string",
                        "vendor_name": "string"
                    }
                    ],
                    "id": "string"
                }
                ],
                "end_user_notification": "TRUE",
                "enforcement_mode": "string",
                "id": "string"
            }
        }
    ]
}

response = falcon.command("updateDeviceControlPolicies", body=BODY)
print(response)

queryDeviceControlPolicyMembers

Search for members of a Device Control Policy in your environment by providing a FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria

PEP8 method name

query_policy_members

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
filter			query	string	FQL Syntax formatted string used to limit the results.
id			query	integer	The ID of the Device Control Policy to search for members of.
limit			query	integer	Maximum number of records to return. (Max: 5000)
offset			query	integer	Starting index of overall result set from which to return ids.
sort			query	string	The property to sort by. (Ex: modified_timestamp.desc)
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.query_policy_members(id="string",
                                       filter="string",
                                       offset=integer,
                                       limit=integer,
                                       sort="string"
                                       )
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.queryDeviceControlPolicyMembers(id="string",
                                                  filter="string",
                                                  offset=integer,
                                                  limit=integer,
                                                  sort="string"
                                                  )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("queryDeviceControlPolicyMembers",
                          id="string",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)

queryDeviceControlPolicies

Search for Device Control Policies in your environment by providing a FQL filter and paging details. Returns a set of Device Control Policy IDs which match the filter criteria

PEP8 method name

query_policies

Content-Type

• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
filter			query	string	FQL Syntax formatted string used to limit the results.
limit			query	integer	Maximum number of records to return. (Max: 5000)
offset			query	integer	Starting index of overall result set from which to return ids.
sort			query	string	The property to sort by. (Ex: modified_timestamp.desc)
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.query_policies(filter="string",
                                 offset=integer,
                                 limit=integer,
                                 sort="string"
                                 )
print(response)

Service class example (Operation ID syntax)

from falconpy import DeviceControlPolicies

falcon = DeviceControlPolicies(client_id="API_CLIENT_ID_HERE",
                               client_secret="API_CLIENT_SECRET_HERE"
                               )

response = falcon.queryDeviceControlPolicies(filter="string",
                                             offset=integer,
                                             limit=integer,
                                             sort="string"
                                             )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("queryDeviceControlPolicies",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)