Skip to content

Sensor Update Policy

Joshua Hiller edited this page Nov 2, 2021 · 24 revisions

CrowdStrike Falcon Twitter URL

Using the Sensor Update Policy service collection

Uber class support Service class support Documentation Version

Table of Contents

Operation ID Description
revealUninstallToken
PEP 8 reveal_uninstall_token
Reveals an uninstall token for a specific device. To retrieve the bulk maintenance token pass the value 'MAINTENANCE' as the value for 'device_id'
queryCombinedSensorUpdateBuilds
PEP 8 query_combined_builds
Retrieve available builds for use with Sensor Update Policies
queryCombinedSensorUpdatePolicyMembers
PEP 8 query_combined_policy_members
Search for members of a Sensor Update Policy in your environment by providing an FQL filter and paging details. Returns a set of host details which match the filter criteria
queryCombinedSensorUpdatePolicies
PEP 8 query_combined_policies
Search for Sensor Update Policies in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria
queryCombinedSensorUpdatePoliciesV2
PEP 8 query_combined_policies_v2
Search for Sensor Update Policies with additional support for uninstall protection in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria
performSensorUpdatePoliciesAction
PEP 8 perform_policies_action
Perform the specified action on the Sensor Update Policies specified in the request
setSensorUpdatePoliciesPrecedence
PEP 8 set_policies_precedence
Sets the precedence of Sensor Update 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
getSensorUpdatePolicies
PEP 8 get_policies
Retrieve a set of Sensor Update Policies by specifying their IDs
createSensorUpdatePolicies
PEP 8 create_policies
Create Sensor Update Policies by specifying details about the policy to create
deleteSensorUpdatePolicies
PEP 8 delete_policies
Delete a set of Sensor Update Policies by specifying their IDs
updateSensorUpdatePolicies
PEP 8 update_policies
Update Sensor Update Policies by specifying the ID of the policy and details to update
getSensorUpdatePoliciesV2
PEP 8 get_policies_v2
Retrieve a set of Sensor Update Policies with additional support for uninstall protection by specifying their IDs
createSensorUpdatePoliciesV2
PEP 8 create_policies_v2
Create Sensor Update Policies by specifying details about the policy to create with additional support for uninstall protection
updateSensorUpdatePoliciesV2
PEP 8 update_policies_v2
Update Sensor Update Policies by specifying the ID of the policy and details to update with additional support for uninstall protection
querySensorUpdatePolicyMembers
PEP 8 query_policy_members
Search for members of a Sensor Update Policy in your environment by providing an FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria
querySensorUpdatePolicies
PEP 8 query_policies
Search for Sensor Update Policies in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policy IDs which match the filter criteria

revealUninstallToken

Reveals an uninstall token for a specific device or the bulk maintenace token.

To retrieve the bulk maintenance token pass the value MAINTENANCE as the value for device_id.

PEP8 method name

reveal_uninstall_token

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
audit_message
Service Class Support

Uber Class Support
body string Message to list in the audit log for this action.
body
Service Class Support

Uber Class Support
body string Full body payload in JSON format.
device_id
Service Class Support

Uber Class Support
body string Device ID to retrieve the uninstall token for.

Pass the value MAINTENANCE here to retrieve the bulk maintenance token.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.reveal_uninstall_token(audit_message="string",
                                         device_id="string"
                                         )
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.revealUninstallToken(audit_message="string",
                                       device_id="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 = {
    "audit_message": "string",
    "device_id": "string"
}

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

queryCombinedSensorUpdateBuilds

Retrieve available builds for use with Sensor Update Policies

PEP8 method name

query_combined_builds

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
platform
Service Class Support

Uber Class Support
query string The platform to return builds for.

Allowed values:
  • linux
  • mac
  • windows
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.query_combined_builds(platform="string")
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.queryCombinedSensorUpdateBuilds(platform="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("queryCombinedSensorUpdateBuilds", platform="string")
print(response)

queryCombinedSensorUpdatePolicyMembers

Search for members of a Sensor Update Policy in your environment by providing an 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 Datatype Description
id
Service Class Support

No Uber Class Support
query string The ID of the Sensor Update Policy to search for members of.
filter
Service Class Support

No Uber Class Support
query string The filter expression that should be used to limit the results using FQL syntax.
limit
Service Class Support

No Uber Class Support
query integer The maximum number of records to return. [1-5000]
offset
Service Class Support

No Uber Class Support
query integer The offset to start retrieving records from.
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.
sort
Service Class Support

No Uber Class Support
query string The property to sort by in FQL syntax.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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 SensorUpdatePolicy

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

response = falcon.queryCombinedSensorUpdatePolicyMembers(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("queryCombinedSensorUpdatePolicyMembers",
                          id="string",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)

queryCombinedSensorUpdatePolicies

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

PEP8 method name

query_combined_policies

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
filter
Service Class Support

No Uber Class Support
query string The filter expression that should be used to limit the results using FQL syntax.
limit
Service Class Support

No Uber Class Support
query integer The maximum number of records to return. [1-5000]
offset
Service Class Support

No Uber Class Support
query integer The offset to start retrieving records from.
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.
sort
Service Class Support

No Uber Class Support
query string The property to sort by in FQL syntax.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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 SensorUpdatePolicy

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

response = falcon.queryCombinedSensorUpdatePolicies(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("queryCombinedSensorUpdatePolicies",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)

queryCombinedSensorUpdatePoliciesV2

Search for Sensor Update Policies with additional support for uninstall protection in your environment by providing an FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria

PEP8 method name

query_combined_policies_v2

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
filter
Service Class Support

No Uber Class Support
query string The filter expression that should be used to limit the results using FQL syntax.
limit
Service Class Support

No Uber Class Support
query integer The maximum number of records to return. [1-5000]
offset
Service Class Support

No Uber Class Support
query integer The offset to start retrieving records from.
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.
sort
Service Class Support

No Uber Class Support
query string The property to sort by in FQL syntax.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.query_combined_policies_v2(filter="string",
                                             offset=integer,
                                             limit=integer,
                                             sort="string"
                                             )
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.queryCombinedSensorUpdatePoliciesV2(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("queryCombinedSensorUpdatePoliciesV2",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)

performSensorUpdatePoliciesAction

Perform the specified action on the Sensor Update Policies specified in the request

PEP8 method name

perform_policies_action

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
action_name
Service Class Support

Uber Class Support
query string Specify one of these actions:
  • add-host-group
  • disable
  • enable
  • remove-host-group
action_parameters
Service Class Support

No Uber Class Support
body list of dictionaries Action specific parameter options.

{
    "name": "string",
    "value": "string"
}
body
Service Class Support

Uber Class Support
body string Full body payload in JSON format.
ids
Service Class Support

No Uber Class Support
body string or list of strings The ID of the Sensor Update Policy you want to impact. If you provide IDs to the method using this keyword, you do not have to provide a body payload. (Service class usage only)
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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_policies_action(action_name="string",
                                          action_parameters=act_params,
                                          ids=id_list
                                          )
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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.performSensorUpdatePoliciesAction(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"
                    )

id_list = ['ID1', 'ID2', 'ID3']

BODY = {
    "action_parameters": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "ids": id_list
}

response = falcon.command("performSensorUpdatePoliciesAction", action_name="string", body=BODY)
print(response)

# Can also use the following syntax
response = falcon.command("performSensorUpdatePoliciesAction",
                          action_name="string",
                          parameters=PARAMS,
                          body=BODY
                          )
print(response)

setSensorUpdatePoliciesPrecedence

Sets the precedence of Sensor Update 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_policies_precedence

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
body
Service Class Support

Uber Class Support
body string Full body payload in JSON format.
ids
Service Class Support

No Uber Class Support
body string or list of strings The ID of the Sensor Update Policy you want to impact. If you provide IDs to the method using this keyword, you do not have to provide a body payload. (Service class usage only)
platform_name
Service Class Support

Uber Class Support
body string Operating System platform name.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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_policies_precedence(ids=id_list, platform_name="string")
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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.setSensorUpdatePoliciesPrecedence(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']

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

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

getSensorUpdatePolicies

Retrieve a set of Sensor Update Policies by specifying their IDs

PEP8 method name

get_policies

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
ids
Service Class Support

Uber Class Support
query string or list of strings The IDs of the Sensor Update Policy to retrieve.
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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 SensorUpdatePolicy

falcon = SensorUpdatePolicy(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.getSensorUpdatePolicies(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("getSensorUpdatePolicies", ids=id_list)
print(response)

createSensorUpdatePolicies

Create Sensor Update 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 Datatype Description
body
Service Class Support

Uber Class Support
body string Full body payload in JSON format.
build
Service Class Support

Uber Class Support
body string Build this Sensor update policy applies to.
description
Service Class Support

Uber Class Support
body string Sensor update policy description.
name
Service Class Support

Uber Class Support
body string Name of the Sensor Update policy.
platform_name
Service Class Support

Uber Class Support
body string Name of the OS platform the Sensor Update policy applies to.
settings
Service Class Support

Uber Class Support
body dictionary Sensor Update policy specific settings.

Overrides the value of build if present.

{
    "build": "string"
}

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.create_policies(build="string",
                                  description="string",
                                  name="string",
                                  platform_name="string"
                                  )
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.createSensorUpdatePolicies(build="string",
                                             description="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": [
        {
            "description": "string",
            "name": "string",
            "platform_name": "string",
            "settings": {
                    "build": "string"
            }
        }
    ]
}

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

deleteSensorUpdatePolicies

Delete a set of Sensor Update Policies by specifying their IDs

PEP8 method name

delete_policies

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
ids
Service Class Support

Uber Class Support
query string or list of strings The IDs of the Sensor Update policies to delete.
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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 SensorUpdatePolicy

falcon = SensorUpdatePolicy(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.deleteSensorUpdatePolicies(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("deleteSensorUpdatePolicies", ids=id_list)
print(response)

updateSensorUpdatePolicies

Update Sensor Update 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 Datatype Description
body
Service Class Support

Uber Class Support
body string Full body payload in JSON format.
build
Service Class Support

Uber Class Support
body string Build this Sensor update policy applies to.
description
Service Class Support

Uber Class Support
body string Sensor update policy description.
id
Service Class Support

Uber Class Support
body string ID the Sensor Update policy to update.
name
Service Class Support

Uber Class Support
body string Name of the Sensor Update policy.
settings
Service Class Support

Uber Class Support
body dictionary Sensor Update policy specific settings.

Overrides the value of build if present.

{
    "build": "string"
}

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.update_policies(build="string",
                                  description="string",
                                  name="string",
                                  id="string"
                                  )
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

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

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

response = falcon.updateSensorUpdatePolicies(build="string",
                                             description="string",
                                             name="string",
                                             id="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": [
        {
            "description": "string",
            "id": "string",
            "name": "string",
            "settings": {
                    "build": "string"
            }
        }
    ]
}

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

getSensorUpdatePoliciesV2

Retrieve a set of Sensor Update Policies with additional support for uninstall protection by specifying their IDs

PEP8 method name

get_policies_v2

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
ids
Service Class Support

Uber Class Support
query string or list of strings The IDs of the Sensor Update policies to retrieve.
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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_v2(ids=id_list)
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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.getSensorUpdatePoliciesV2(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("getSensorUpdatePoliciesV2", ids=id_list)
print(response)

createSensorUpdatePoliciesV2

Create Sensor Update Policies by specifying details about the policy to create with additional support for uninstall protection

PEP8 method name

create_policies_v2

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
body
Service Class Support

Uber Class Support
body string Full body payload in JSON format.
build
Service Class Support

Uber Class Support
body string Build this Sensor update policy applies to.
description
Service Class Support

Uber Class Support
body string Sensor update policy description.
name
Service Class Support

Uber Class Support
body string Name of the Sensor Update policy.
platform_name
Service Class Support

Uber Class Support
body string Name of the OS platform the Sensor Update policy applies to.
settings
Service Class Support

Uber Class Support
body dictionary Sensor Update policy specific settings.

Overrides the value of build if present.

{
    "build": "string"
}
uninstall_protection
Service Class Support

Uber Class Support
body string Boolean indicating if uninstall protection should be enabled.

Allowed values:
  • ENABLED
  • DISABLED

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.create_policies_v2(build="string",
                                     description="string",
                                     name="string",
                                     platform_name="string",
                                     uninstall_protection="ENABLED"
                                     )
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.createSensorUpdatePoliciesV2(build="string",
                                               description="string",
                                               name="string",
                                               platform_name="string",
                                               uninstall_protection="ENABLED"
                                               )
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": [
        {
            "description": "string",
            "name": "string",
            "platform_name": "Windows",
            "settings": {
                    "build": "string",
                    "uninstall_protection": "ENABLED"
            }
        }
    ]
}

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

updateSensorUpdatePoliciesV2

Update Sensor Update Policies by specifying the ID of the policy and details to update with additional support for uninstall protection

PEP8 method name

update_policies_v2

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
body
Service Class Support

Uber Class Support
body string Full body payload in JSON format.
build
Service Class Support

Uber Class Support
body string Build this Sensor update policy applies to.
description
Service Class Support

Uber Class Support
body string Sensor update policy description.
id
Service Class Support

Uber Class Support
body string ID of the Sensor Update policy to update.
name
Service Class Support

Uber Class Support
body string Name of the Sensor Update policy.
settings
Service Class Support

Uber Class Support
body dictionary Sensor Update policy specific settings.

Overrides the value of build if present.

{
    "build": "string"
}
uninstall_protection
Service Class Support

Uber Class Support
body string Boolean indicating if uninstall protection should be enabled.

Allowed values:
  • ENABLED
  • DISABLED

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.update_policies_v2(build="string",
                                     description="string",
                                     name="string",
                                     platform_name="string",
                                     uninstall_protection="ENABLED"
                                     )
print(response)
Service class example (Operation ID syntax)
from falconpy import SensorUpdatePolicy

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

response = falcon.updateSensorUpdatePoliciesV2(build="string",
                                               description="string",
                                               name="string",
                                               platform_name="string",
                                               uninstall_protection="ENABLED"
                                               )
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": [
        {
            "description": "string",
            "id": "string",
            "name": "string",
            "settings": {
                    "build": "string",
                    "uninstall_protection": "ENABLED"
            }
        }
    ]
}

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

querySensorUpdatePolicyMembers

Search for members of a Sensor Update Policy in your environment by providing an 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 Datatype Description
id
Service Class Support

No Uber Class Support
query string The ID of the Sensor Update Policy to search for members of.
filter
Service Class Support

No Uber Class Support
query string The filter expression that should be used to limit the results using FQL syntax.
limit
Service Class Support

No Uber Class Support
query integer The maximum number of records to return. [1-5000]
offset
Service Class Support

No Uber Class Support
query integer The offset to start retrieving records from.
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.
sort
Service Class Support

No Uber Class Support
query string The property to sort by in FQL syntax.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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 SensorUpdatePolicy

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

response = falcon.querySensorUpdatePolicyMembers(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("querySensorUpdatePolicyMembers",
                          id="string",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)

querySensorUpdatePolicies

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

PEP8 method name

query_policies

Content-Type

  • Produces: application/json

Keyword Arguments

Name Service Uber Type Datatype Description
filter
Service Class Support

No Uber Class Support
query string The filter expression that should be used to limit the results using FQL syntax.
limit
Service Class Support

No Uber Class Support
query integer The maximum number of records to return. [1-5000]
offset
Service Class Support

No Uber Class Support
query integer The offset to start retrieving records from.
parameters
Service Class Support

Uber Class Support
query string Full query string parameters payload in JSON format.
sort
Service Class Support

No Uber Class Support
query string The property to sort by in FQL syntax.

Usage

Service class example (PEP8 syntax)
from falconpy import SensorUpdatePolicy

falcon = SensorUpdatePolicy(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 SensorUpdatePolicy

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

response = falcon.querySensorUpdatePolicies(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("querySensorUpdatePolicies",
                          filter="string",
                          offset=integer,
                          limit=integer,
                          sort="string"
                          )
print(response)

CrowdStrike Falcon

Clone this wiki locally