Skip to content

Device Control Policies

Jump to bottom
Joshua Hiller edited this page Apr 11, 2021 · 21 revisions

CrowdStrike Falcon Twitter URL

Using the Device Control Policies service collection

Uber class support Uber class support

Table of Contents

API Function Description
queryCombinedDeviceControlPolicyMembers Search for members of a Device Control Policy in your environment by providing an FQL filter and paging details. Returns a set of host details which match the filter criteria
queryCombinedDeviceControlPolicies Search for Device Control Policies in your environment by providing an FQL filter and paging details. Returns a set of Device Control Policies which match the filter criteria
performDeviceControlPoliciesAction Perform the specified action on the Device Control Policies specified in the request
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
getDeviceControlPolicies Retrieve a set of Device Control Policies by specifying their IDs
createDeviceControlPolicies Create Device Control Policies by specifying details about the policy to create
deleteDeviceControlPolicies Delete a set of Device Control Policies by specifying their IDs
updateDeviceControlPolicies Update Device Control Policies by specifying the ID of the policy and details to update
queryDeviceControlPolicyMembers Search for members of a Device Control Policy in your environment by providing an FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria
queryDeviceControlPolicies Search for Device Control Policies in your environment by providing an 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 an FQL filter and paging details. Returns a set of host details which match the filter criteria

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
id query string The ID of the Device Control Policy to search for members of
filter query string The filter expression that should be used to limit the results
offset query integer The offset to start retrieving records from
limit query integer The maximum records to return. [1-5000]
sort query string The property to sort by

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'id': 'string',
    'filter': 'string',
    'offset': integer,
    'limit': integer,
    'sort': 'string'
}

response = falcon.queryCombinedDeviceControlPolicyMembers(parameters=PARAMS)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'id': 'string',
    'filter': 'string',
    'offset': integer,
    'limit': integer,
    'sort': 'string'
}

response = falcon.command('queryCombinedDeviceControlPolicyMembers', parameters=PARAMS)
print(response)
falcon.deauthenticate()

queryCombinedDeviceControlPolicies

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

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
filter query string The filter expression that should be used to limit the results
offset query integer The offset to start retrieving records from
limit query integer The maximum records to return. [1-5000]
sort query string The property to sort by

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'filter': 'string',
    'offset': integer,
    'limit': integer,
    'sort': 'string'
}

response = falcon.queryCombinedDeviceControlPolicies(parameters=PARAMS)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'filter': 'string',
    'offset': integer,
    'limit': integer,
    'sort': 'string'
}

response = falcon.command('queryCombinedDeviceControlPolicies', parameters=PARAMS)
print(response)
falcon.deauthenticate()

performDeviceControlPoliciesAction

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

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
✅ action_name query string The action to perform
✅ body body string

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'action_name': 'string'
}

BODY = {
    'Body Payload': 'See body description above'
}

response = falcon.performDeviceControlPoliciesAction(parameters=PARAMS, body=BODY)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'action_name': 'string'
}

BODY = {
    'Body Payload': 'See body description above'
}

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

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

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
✅ body body string

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

BODY = {
    'Body Payload': 'See body description above'
}

response = falcon.setDeviceControlPoliciesPrecedence(body=BODY)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

BODY = {
    'Body Payload': 'See body description above'
}

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

getDeviceControlPolicies

Retrieve a set of Device Control Policies by specifying their IDs

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
✅ ids query array (string) The IDs of the Device Control Policies to return

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

IDS = 'ID1,ID2,ID3'

response = falcon.getDeviceControlPolicies(ids=IDS)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

IDS = 'ID1,ID2,ID3'

response = falcon.command('getDeviceControlPolicies', ids=IDS)
print(response)
falcon.deauthenticate()

createDeviceControlPolicies

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

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
✅ body body string

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

BODY = {
    'Body Payload': 'See body description above'
}

response = falcon.createDeviceControlPolicies(body=BODY)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

BODY = {
    'Body Payload': 'See body description above'
}

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

deleteDeviceControlPolicies

Delete a set of Device Control Policies by specifying their IDs

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
✅ ids query array (string) The IDs of the Device Control Policies to delete

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

IDS = 'ID1,ID2,ID3'

response = falcon.deleteDeviceControlPolicies(ids=IDS)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

IDS = 'ID1,ID2,ID3'

response = falcon.command('deleteDeviceControlPolicies', ids=IDS)
print(response)
falcon.deauthenticate()

updateDeviceControlPolicies

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

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
✅ body body string

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

BODY = {
    'Body Payload': 'See body description above'
}

response = falcon.updateDeviceControlPolicies(body=BODY)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

BODY = {
    'Body Payload': 'See body description above'
}

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

queryDeviceControlPolicyMembers

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

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
id query string The ID of the Device Control Policy to search for members of
filter query string The filter expression that should be used to limit the results
offset query integer The offset to start retrieving records from
limit query integer The maximum records to return. [1-5000]
sort query string The property to sort by

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'id': 'string',
    'filter': 'string',
    'offset': integer,
    'limit': integer,
    'sort': 'string'
}

response = falcon.queryDeviceControlPolicyMembers(parameters=PARAMS)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'id': 'string',
    'filter': 'string',
    'offset': integer,
    'limit': integer,
    'sort': 'string'
}

response = falcon.command('queryDeviceControlPolicyMembers', parameters=PARAMS)
print(response)
falcon.deauthenticate()

queryDeviceControlPolicies

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

Content-Type

  • Produces: application/json

Parameters

Required Name Type Datatype Description
filter query string The filter expression that should be used to limit the results
offset query integer The offset to start retrieving records from
limit query integer The maximum records to return. [1-5000]
sort query string The property to sort by

Usage

Service class example
from falconpy import device_control_policies as FalconDCP

falcon = FalconDCP.Device_Control_Policies(creds={
     'client_id': falcon_client_id,
     'client_secret': falcon_client_secret
})

PARAMS = {
    'filter': 'string',
    'offset': integer,
    'limit': integer,
    'sort': 'string'
}

response = falcon.queryDeviceControlPolicies(parameters=PARAMS)
print(response)
Uber class example
from falconpy import api_complete as FalconSDK

falcon = FalconSDK.APIHarness(creds={
      'client_id': falcon_client_id,
      'client_secret': falcon_client_secret
   }
)

PARAMS = {
    'filter': 'string',
    'offset': integer,
    'limit': integer,
    'sort': 'string'
}

response = falcon.command('queryDeviceControlPolicies', parameters=PARAMS)
print(response)
falcon.deauthenticate()

CrowdStrike Falcon

Clone this wiki locally