Sensor Update Policy
The Sensor Update Policy service collection provides operations for managing Sensor Update Policies in your CrowdStrike Falcon environment. Reveal and increment uninstall tokens, retrieve available sensor builds and kernel compatibility information, manage policy members, create and update policies with support for uninstall protection, and set policy precedence.
| Language | Last Update |
|---|---|
| Python | v1.6.1 |
| PowerShell | v2.2.9 |
| Go | v0.20.0 |
| TypeScript | v0.6.0 |
| Rust | v0.7.0 |
| Ruby | v1.2.0 |
This service collection has code examples posted to the repository.
Table of Contents
Section titled “Table of Contents”| Operation | Description |
|---|---|
revealUninstallTokenreveal_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’. |
incrementUninstallTokenincrement_uninstall_token | Increment a bulk maintenance token. |
queryCombinedSensorUpdateBuildsquery_combined_builds | Retrieve available builds for use with Sensor Update Policies. |
queryCombinedSensorUpdateKernelsquery_combined_kernels | Retrieve kernel compatibility info for Sensor Update Builds. |
queryCombinedSensorUpdatePolicyMembersquery_combined_policy_members | Search for members of a Sensor Update Policy in your environment by providing a FQL filter and paging details. Returns a set of host details which match the filter criteria. |
queryCombinedSensorUpdatePoliciesquery_combined_policies | Search for Sensor Update Policies in your environment by providing a FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria. |
queryCombinedSensorUpdatePoliciesV2query_combined_policies_v2 | Search for Sensor Update Policies with additional support for uninstall protection in your environment by providing a FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria. |
performSensorUpdatePoliciesActionperform_policies_action | Perform the specified action on the Sensor Update Policies specified in the request. |
setSensorUpdatePoliciesPrecedenceset_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. |
getSensorUpdatePoliciesget_policies | Retrieve a set of Sensor Update Policies by specifying their IDs. |
createSensorUpdatePoliciescreate_policies | Create Sensor Update Policies by specifying details about the policy to create. |
deleteSensorUpdatePoliciesdelete_policies | Delete a set of Sensor Update Policies by specifying their IDs. |
updateSensorUpdatePoliciesupdate_policies | Update Sensor Update Policies by specifying the ID of the policy and details to update. |
getSensorUpdatePoliciesV2get_policies_v2 | Retrieve a set of Sensor Update Policies with additional support for uninstall protection by specifying their IDs. |
createSensorUpdatePoliciesV2create_policies_v2 | Create Sensor Update Policies by specifying details about the policy to create with additional support for uninstall protection. |
updateSensorUpdatePoliciesV2update_policies_v2 | Update Sensor Update Policies by specifying the ID of the policy and details to update with additional support for uninstall protection. |
querySensorUpdateKernelsDistinctquery_kernels | Retrieve kernel compatibility info for Sensor Update Builds. |
querySensorUpdatePolicyMembersquery_policy_members | Search for members of a Sensor Update Policy in your environment by providing a FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria. |
querySensorUpdatePoliciesquery_policies | Search for Sensor Update Policies in your environment by providing a FQL filter and paging details. Returns a set of Sensor Update Policy IDs which match the filter criteria. |
revealUninstallToken
Section titled “revealUninstallToken”Reveals an uninstall token for a specific device or the bulk maintenance token.
To retrieve the bulk maintenance token pass the value MAINTENANCE as the value for device_id.
reveal_uninstall_tokenParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| audit_message | body | string | Message to list in the audit log for this action. |
| body | body | dictionary | Full body payload in JSON format. |
| device_id | body | string | Device ID to retrieve the uninstall token for. Pass the value MAINTENANCE here to retrieve the bulk maintenance token. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.reveal_uninstall_token(audit_message=["string"], device_id="string")print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.revealUninstallToken(audit_message=["string"], device_id="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "audit_message": "string", "device_id": "string"}
response = falcon.command("revealUninstallToken", body=body_payload)print(response)Get-FalconUninstallToken -Id "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
audit_message := "string" device_id := "string"
response, err := client.SensorUpdatePolicies.RevealUninstallToken( &sensor_update_policies.RevealUninstallTokenParams{ Body: &models.UninstallTokenRevealUninstallTokenReqV1{ AuditMessage: &audit_message, DeviceID: &device_id, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.revealUninstallToken( { auditMessage: "string", deviceId: "string"} // body);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::reveal_uninstall_token;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::UninstallTokenRevealUninstallTokenReqV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = UninstallTokenRevealUninstallTokenReqV1 { device_id: Some("string".to_string()), ..Default::default() };
let response = reveal_uninstall_token( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
body = Falcon::UninstallTokenRevealUninstallTokenReqV1.new( audit_message: 'string', device_id: 'string')
response = api.reveal_uninstall_token(body)
puts responseincrementUninstallToken
Section titled “incrementUninstallToken”Increment a bulk maintenance token.
increment_uninstall_tokenParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| audit_message | body | string | The audit message for the token increment operation. |
| body | body | dictionary | Full body payload as a JSON formatted dictionary. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.increment_uninstall_token(audit_message="string")print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.incrementUninstallToken(audit_message="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "audit_message": "string"}
response = falcon.command("incrementUninstallToken", body=body_payload)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/maintenance_token" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
audit_message := "string"
response, err := client.MaintenanceToken.IncrementUninstallToken( &maintenance_token.IncrementUninstallTokenParams{ Body: &models.UninstallTokenIncrementUninstallTokenReqV1{ AuditMessage: &audit_message, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.maintenanceToken.incrementUninstallToken( { auditMessage: "string"} // body);
console.log(response);Examples coming soon.
require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::MaintenanceToken.new
body = Falcon::UninstallTokenIncrementUninstallTokenReqV1.new( audit_message: 'string')
response = api.increment_uninstall_token(body)
puts responsequeryCombinedSensorUpdateBuilds
Section titled “queryCombinedSensorUpdateBuilds”Retrieve available builds for use with Sensor Update Policies.
query_combined_buildsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| platform | query | string | The platform to return builds for. Allowed values: linux, mac, windows. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
| stage | query | string or list of strings | The stages to return builds for. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.query_combined_builds(platform="string", stage=id_list)print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.queryCombinedSensorUpdateBuilds(platform="string", stage=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("queryCombinedSensorUpdateBuilds", platform="string", stage=id_list)print(response)Get-FalconBuildpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
platform := "string"
response, err := client.SensorUpdatePolicies.QueryCombinedSensorUpdateBuilds( &sensor_update_policies.QueryCombinedSensorUpdateBuildsParams{ Platform: &platform, Stage: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.queryCombinedSensorUpdateBuilds( "string", // platform ["ID1", "ID2", "ID3"] // stage);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::query_combined_sensor_update_builds;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_combined_sensor_update_builds( &falcon.cfg, // configuration Some("string"), // platform Some(vec!["string".to_string()]), // stage ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.query_combined_sensor_update_builds(platform: 'string', stage: ['ID1', 'ID2', 'ID3'])
puts responsequeryCombinedSensorUpdateKernels
Section titled “queryCombinedSensorUpdateKernels”Retrieve kernel compatibility info for Sensor Update Builds.
query_combined_kernelsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| filter | query | string | The filter expression that should be used to limit the results using FQL syntax. |
| limit | query | integer | The maximum number of records to return. [1-500] |
| offset | query | integer | The offset to start retrieving records from. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_combined_kernels(filter="string", limit=integer, offset=integer)print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryCombinedSensorUpdateKernels(filter="string", limit=integer, offset=integer)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryCombinedSensorUpdateKernels", filter="string", offset=integer, limit=integer)print(response)Get-FalconKernel -Filter "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
filter := "string" offset := int64(0) limit := int64(0)
response, err := client.SensorUpdatePolicies.QueryCombinedSensorUpdateKernels( &sensor_update_policies.QueryCombinedSensorUpdateKernelsParams{ Filter: &filter, Offset: &offset, Limit: &limit, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.queryCombinedSensorUpdateKernels( "string", // filter integer, // offset integer // limit);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::query_combined_sensor_update_kernels;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_combined_sensor_update_kernels( &falcon.cfg, // configuration Some("string"), // filter Some(integer), // offset Some(integer), // limit ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.query_combined_sensor_update_kernels(filter: 'string', offset: integer, limit: integer)
puts responsequeryCombinedSensorUpdatePolicyMembers
Section titled “queryCombinedSensorUpdatePolicyMembers”Search for members of a Sensor Update Policy in your environment by providing a FQL filter and paging details. Returns a set of host details which match the filter criteria.
query_combined_policy_membersParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| id | query | string | The ID of the Sensor Update Policy to search for members of. |
| filter | query | string | The filter expression that should be used to limit the results using FQL syntax. |
| limit | query | integer | The maximum number of records to return. [1-5000] |
| offset | query | integer | The offset to start retrieving records from. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
| sort | query | string | The property to sort by in FQL syntax. Supports asc or desc. Available sort options: created_by, created_timestamp, enabled, modified_by, modified_timestamp, name, platform_name, precedence. |
Available Filters
Section titled “Available Filters”The following fields can be used to filter results retrieved from the API.
| Name | Description |
|---|---|
| created_by | The username, email, or API client ID of the person who created the policy, as identified in the policy object. When specifying an email address, use a letter p as an operator so that the @ sign is accepted. You can also search by using the email username or the domain as the value. For example, to filter on policies created by the email address diana.hudson@email.com: filter=created_by:p’diana.hudson@email.com’ (correct)filter=created_by:‘diana.hudson’ (correct)filter=created_by:‘email.com’ (correct)filter=created_by:‘diana’ (incorrect)Enter only the alphanumeric value when providing an API client ID. For example, to filter on api-client-id:7a1284d634af196bff5988fb1775721b: filter=created_by:‘7a12…721b’ (correct)filter=created_by:‘api-client-id:7a12…721b’ (incorrect)filter=created_by:‘api-client-id’ (incorrect) |
| created_timestamp | The full timestamp of when the policy was created in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss.sssZ) The timezone is always UTC as denoted by the suffix “Z”. filter=created_timestamp:‘2020-11-23T19:36:24.129652084Z’ |
| description | Search for a term found in the policy description. The value must be entered in lowercase.filter=description:‘policy’ |
| enabled | Find policies by their enabled status. Specify true to find enabled policies or false to find disabled policies.filter=enabled:‘true’ |
| groups | Enter a host group ID to find the policy it’s been assigned to.filter=groups:‘1ef3…b0fe’ |
| modified_by | The username, email, or API client ID of the person who modified the policy, as identified in the policy object. Values for this field follow the same rules as the created_by filter. |
| modified_timestamp | The full timestamp of when the policy was modified in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss. sssZ) The timezone is always UTC as denoted by the suffix “Z”. Values for this field follow the same rules as the created_timestamp filter. |
| name | Performs a free text search on single words found in a policy name. Values must be entered as lowercase and enclosed in single quotes. You can provide multiple name values separated by an &.filter=name:‘test’ |
| name.raw | Filters on exact matches to the full policy name. Searches on this field are case-sensitive and require the correct input of uppercase and lowercase letters. filter=name.raw:‘Test sensor update Policy’ |
| platform_name | The name of the operating system listed in the policy. One of: Windows, Mac, Linuxfilter=platform_name:‘Windows’ |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_combined_policy_members(id="string", filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryCombinedSensorUpdatePolicyMembers(id="string", filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryCombinedSensorUpdatePolicyMembers", id="string", filter="string", offset=integer, limit=integer, sort="string")print(response)Get-FalconSensorUpdatePolicyMember -Filter "string" ` -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
iD := "string" filter := "string" offset := int64(0) limit := int64(0) sort := "string"
response, err := client.SensorUpdatePolicies.QueryCombinedSensorUpdatePolicyMembers( &sensor_update_policies.QueryCombinedSensorUpdatePolicyMembersParams{ ID: &iD, Filter: &filter, Offset: &offset, Limit: &limit, Sort: &sort, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.queryCombinedSensorUpdatePolicyMembers( "string", // id "string", // filter integer, // offset integer, // limit "string" // sort);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::query_combined_sensor_update_policy_members;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_combined_sensor_update_policy_members( &falcon.cfg, // configuration Some("string"), // id Some("string"), // filter Some(integer), // offset Some(integer), // limit Some("string"), // sort ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.query_combined_sensor_update_policy_members(id: 'string', filter: 'string', offset: integer, limit: integer, sort: 'string')
puts responsequeryCombinedSensorUpdatePolicies
Section titled “queryCombinedSensorUpdatePolicies”Search for Sensor Update Policies in your environment by providing a FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria.
query_combined_policiesParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| filter | query | string | The filter expression that should be used to limit the results using FQL syntax. |
| limit | query | integer | The maximum number of records to return. [1-5000] |
| offset | query | integer | The offset to start retrieving records from. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
| sort | query | string | The property to sort by in FQL syntax. Supports asc or desc. Available sort options: created_by, created_timestamp, enabled, modified_by, modified_timestamp, name, platform_name, precedence. |
Available Filters
Section titled “Available Filters”The following fields can be used to filter results retrieved from the API.
| Name | Description |
|---|---|
| created_by | The username, email, or API client ID of the person who created the policy, as identified in the policy object. When specifying an email address, use a letter p as an operator so that the @ sign is accepted. You can also search by using the email username or the domain as the value. For example, to filter on policies created by the email address diana.hudson@email.com: filter=created_by:p’diana.hudson@email.com’ (correct)filter=created_by:‘diana.hudson’ (correct)filter=created_by:‘email.com’ (correct)filter=created_by:‘diana’ (incorrect)Enter only the alphanumeric value when providing an API client ID. For example, to filter on api-client-id:7a1284d634af196bff5988fb1775721b: filter=created_by:‘7a12…721b’ (correct)filter=created_by:‘api-client-id:7a12…721b’ (incorrect)filter=created_by:‘api-client-id’ (incorrect) |
| created_timestamp | The full timestamp of when the policy was created in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss.sssZ) The timezone is always UTC as denoted by the suffix “Z”. filter=created_timestamp:‘2020-11-23T19:36:24.129652084Z’ |
| description | Search for a term found in the policy description. The value must be entered in lowercase.filter=description:‘policy’ |
| enabled | Find policies by their enabled status. Specify true to find enabled policies or false to find disabled policies.filter=enabled:‘true’ |
| groups | Enter a host group ID to find the policy it’s been assigned to.filter=groups:‘1ef3…b0fe’ |
| modified_by | The username, email, or API client ID of the person who modified the policy, as identified in the policy object. Values for this field follow the same rules as the created_by filter. |
| modified_timestamp | The full timestamp of when the policy was modified in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss. sssZ) The timezone is always UTC as denoted by the suffix “Z”. Values for this field follow the same rules as the created_timestamp filter. |
| name | Performs a free text search on single words found in a policy name. Values must be entered as lowercase and enclosed in single quotes. You can provide multiple name values separated by an &.filter=name:‘test’ |
| name.raw | Filters on exact matches to the full policy name. Searches on this field are case-sensitive and require the correct input of uppercase and lowercase letters. filter=name.raw:‘Test sensor update Policy’ |
| platform_name | The name of the operating system listed in the policy. One of: Windows, Mac, Linuxfilter=platform_name:‘Windows’ |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_combined_policies(filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryCombinedSensorUpdatePolicies(filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryCombinedSensorUpdatePolicies", filter="string", offset=integer, limit=integer, sort="string")print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
filter := "string" offset := int64(0) limit := int64(0) sort := "string"
response, err := client.SensorUpdatePolicies.QueryCombinedSensorUpdatePolicies( &sensor_update_policies.QueryCombinedSensorUpdatePoliciesParams{ Filter: &filter, Offset: &offset, Limit: &limit, Sort: &sort, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.queryCombinedSensorUpdatePolicies( "string", // filter integer, // offset integer, // limit "string" // sort);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::query_combined_sensor_update_policies;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_combined_sensor_update_policies( &falcon.cfg, // configuration Some("string"), // filter Some(integer), // offset Some(integer), // limit Some("string"), // sort ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.query_combined_sensor_update_policies(filter: 'string', offset: integer, limit: integer, sort: 'string')
puts responsequeryCombinedSensorUpdatePoliciesV2
Section titled “queryCombinedSensorUpdatePoliciesV2”Search for Sensor Update Policies with additional support for uninstall protection in your environment by providing a FQL filter and paging details. Returns a set of Sensor Update Policies which match the filter criteria.
query_combined_policies_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| filter | query | string | The filter expression that should be used to limit the results using FQL syntax. |
| limit | query | integer | The maximum number of records to return. [1-5000] |
| offset | query | integer | The offset to start retrieving records from. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
| sort | query | string | The property to sort by in FQL syntax. Supports asc or desc. Available sort options: created_by, created_timestamp, enabled, modified_by, modified_timestamp, name, platform_name, precedence. |
Available Filters
Section titled “Available Filters”The following fields can be used to filter results retrieved from the API.
| Name | Description |
|---|---|
| created_by | The username, email, or API client ID of the person who created the policy, as identified in the policy object. When specifying an email address, use a letter p as an operator so that the @ sign is accepted. You can also search by using the email username or the domain as the value. For example, to filter on policies created by the email address diana.hudson@email.com: filter=created_by:p’diana.hudson@email.com’ (correct)filter=created_by:‘diana.hudson’ (correct)filter=created_by:‘email.com’ (correct)filter=created_by:‘diana’ (incorrect)Enter only the alphanumeric value when providing an API client ID. For example, to filter on api-client-id:7a1284d634af196bff5988fb1775721b: filter=created_by:‘7a12…721b’ (correct)filter=created_by:‘api-client-id:7a12…721b’ (incorrect)filter=created_by:‘api-client-id’ (incorrect) |
| created_timestamp | The full timestamp of when the policy was created in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss.sssZ) The timezone is always UTC as denoted by the suffix “Z”. filter=created_timestamp:‘2020-11-23T19:36:24.129652084Z’ |
| description | Search for a term found in the policy description. The value must be entered in lowercase.filter=description:‘policy’ |
| enabled | Find policies by their enabled status. Specify true to find enabled policies or false to find disabled policies.filter=enabled:‘true’ |
| groups | Enter a host group ID to find the policy it’s been assigned to.filter=groups:‘1ef3…b0fe’ |
| modified_by | The username, email, or API client ID of the person who modified the policy, as identified in the policy object. Values for this field follow the same rules as the created_by filter. |
| modified_timestamp | The full timestamp of when the policy was modified in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss. sssZ) The timezone is always UTC as denoted by the suffix “Z”. Values for this field follow the same rules as the created_timestamp filter. |
| name | Performs a free text search on single words found in a policy name. Values must be entered as lowercase and enclosed in single quotes. You can provide multiple name values separated by an &.filter=name:‘test’ |
| name.raw | Filters on exact matches to the full policy name. Searches on this field are case-sensitive and require the correct input of uppercase and lowercase letters. filter=name.raw:‘Test sensor update Policy’ |
| platform_name | The name of the operating system listed in the policy. One of: Windows, Mac, Linuxfilter=platform_name:‘Windows’ |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_combined_policies_v2(filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.queryCombinedSensorUpdatePoliciesV2(filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("queryCombinedSensorUpdatePoliciesV2", filter="string", offset=integer, limit=integer, sort="string")print(response)Get-FalconSensorUpdatePolicy -Filter "string" ` -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
filter := "string" offset := int64(0) limit := int64(0) sort := "string"
response, err := client.SensorUpdatePolicies.QueryCombinedSensorUpdatePoliciesV2( &sensor_update_policies.QueryCombinedSensorUpdatePoliciesV2Params{ Filter: &filter, Offset: &offset, Limit: &limit, Sort: &sort, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.queryCombinedSensorUpdatePoliciesV2( "string", // filter integer, // offset integer, // limit "string" // sort);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::query_combined_sensor_update_policies_v2;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_combined_sensor_update_policies_v2( &falcon.cfg, // configuration Some("string"), // filter Some(integer), // offset Some(integer), // limit Some("string"), // sort ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.query_combined_sensor_update_policies_v2(filter: 'string', offset: integer, limit: integer, sort: 'string')
puts responseperformSensorUpdatePoliciesAction
Section titled “performSensorUpdatePoliciesAction”Perform the specified action on the Sensor Update Policies specified in the request.
perform_policies_actionParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| action_name | query | string | Specify one of these actions: add-host-group, add-rule-group, disable, enable, remove-host-group, remove-rule-group. |
| action_parameters | body | list of dictionaries | Action specific parameter options. { “name”: “string”, “value”: “string” } |
| body | body | dictionary | Full body payload in JSON format. |
| group_id | body action_parameters | string | Host Group ID to apply the policy to. Overridden if action_parameters is specified. |
| ids | 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 | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.perform_policies_action(action_name="string", action_parameters=[{"key": "value"}], group_id="string", ids=id_list)print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.performSensorUpdatePoliciesAction(action_name="string", action_parameters=[{"key": "value"}], group_id="string", ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "action_parameters": [ { "name": "string", "value": "string" } ], "ids": ["string"]}
response = falcon.command("performSensorUpdatePoliciesAction", action_name="string", body=body_payload)print(response)Invoke-FalconSensorUpdatePolicyAction -Name "string" -Id "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
name := "string" value := "string"
response, err := client.SensorUpdatePolicies.PerformSensorUpdatePoliciesAction( &sensor_update_policies.PerformSensorUpdatePoliciesActionParams{ Body: &models.MsaEntityActionRequestV2{ ActionParameters: []interface{}{ { Name: &name, Value: &value, }, }, Ids: []string{"string"}, }, ActionName: "string", Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.performSensorUpdatePoliciesAction( "string", // actionName { // body actionParameters: [{ name: "string", value: "string" }], ids: [] });
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::perform_sensor_update_policies_action;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::MsaEntityActionRequestV2;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = MsaEntityActionRequestV2 { ids: vec!["string".to_string()], ..Default::default() };
let response = perform_sensor_update_policies_action( &falcon.cfg, // configuration "string", // action_name body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
body = Falcon::MsaEntityActionRequestV2.new( action_parameters: [{ name: 'string', value: 'string' }], ids: [])
response = api.perform_sensor_update_policies_action(body, 'string')
puts responsesetSensorUpdatePoliciesPrecedence
Section titled “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.
set_policies_precedenceParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| ids | 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 | body | string | Operating System platform name. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
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)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
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)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
body_payload = { "ids": ["string"], "platform_name": "string"}
response = falcon.command("setSensorUpdatePoliciesPrecedence", body=body_payload)print(response)Set-FalconSensorUpdatePrecedence -PlatformName "string" -Id @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
platform_name := "string"
response, err := client.SensorUpdatePolicies.SetSensorUpdatePoliciesPrecedence( &sensor_update_policies.SetSensorUpdatePoliciesPrecedenceParams{ Body: &models.BaseSetPolicyPrecedenceReqV1{ Ids: []string{"string"}, PlatformName: &platform_name, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.setSensorUpdatePoliciesPrecedence( { ids: [], platformName: "string"} // body);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::set_sensor_update_policies_precedence;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::BaseSetPolicyPrecedenceReqV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = BaseSetPolicyPrecedenceReqV1 { ids: vec!["string".to_string()], platform_name: Some("string".to_string()), ..Default::default() };
let response = set_sensor_update_policies_precedence( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
body = Falcon::BaseSetPolicyPrecedenceReqV1.new( ids: [], platform_name: 'string')
response = api.set_sensor_update_policies_precedence(body)
puts responsegetSensorUpdatePolicies
Section titled “getSensorUpdatePolicies”Retrieve a set of Sensor Update Policies by specifying their IDs.
get_policiesParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | The IDs of the Sensor Update Policy to retrieve. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_policies(ids=id_list)print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getSensorUpdatePolicies(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getSensorUpdatePolicies", ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.SensorUpdatePolicies.GetSensorUpdatePolicies( &sensor_update_policies.GetSensorUpdatePoliciesParams{ Ids: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.getSensorUpdatePolicies(["ID1", "ID2", "ID3"]); // ids
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::get_sensor_update_policies;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_sensor_update_policies( &falcon.cfg, // configuration vec!["string".to_string()], // ids ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.get_sensor_update_policies(['ID1', 'ID2', 'ID3'])
puts responsecreateSensorUpdatePolicies
Section titled “createSensorUpdatePolicies”Create Sensor Update Policies by specifying details about the policy to create.
create_policiesParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| build | body | string | Build this Sensor update policy applies to. |
| description | body | string | Sensor update policy description. |
| name | body | string | Name of the Sensor Update policy. |
| platform_name | body | string | Name of the OS platform the Sensor Update policy applies to. |
| settings | body | dictionary | Sensor Update policy specific settings. Overrides the value of build if present.{ “build”: “string” } |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.create_policies(build="string", description="string", name="string", platform_name="string", settings={})print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.createSensorUpdatePolicies(build="string", description="string", name="string", platform_name="string", settings={})print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "resources": [ { "description": "string", "name": "string", "platform_name": "string", "settings": { "build": "string" } } ]}
response = falcon.command("createSensorUpdatePolicies", body=body_payload)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
description := "string" name := "string" platform_name := "string"
response, err := client.SensorUpdatePolicies.CreateSensorUpdatePolicies( &sensor_update_policies.CreateSensorUpdatePoliciesParams{ Body: &models.SensorUpdateCreatePoliciesReqV1{ Resources: []interface{}{ { Description: &description, Name: &name, PlatformName: &platform_name, Settings: &struct{}{}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.createSensorUpdatePolicies( { resources: [{ description: "string", name: "string", platformName: "string", settings: { build: "string" } }]} // body);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::create_sensor_update_policies;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::SensorUpdateCreatePoliciesReqV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = SensorUpdateCreatePoliciesReqV1 { resources: vec![CreatePolicyReqV1 { name: Some("string".to_string()), platform_name: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = create_sensor_update_policies( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
body = Falcon::SensorUpdateCreatePoliciesReqV1.new( resources: [{ description: 'string', name: 'string', platform_name: 'string', settings: { build: 'string' } }])
response = api.create_sensor_update_policies(body)
puts responsedeleteSensorUpdatePolicies
Section titled “deleteSensorUpdatePolicies”Delete a set of Sensor Update Policies by specifying their IDs.
delete_policiesParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | The IDs of the Sensor Update policies to delete. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_policies(ids=id_list)print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.deleteSensorUpdatePolicies(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("deleteSensorUpdatePolicies", ids=id_list)print(response)Remove-FalconSensorUpdatePolicy -Id @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.SensorUpdatePolicies.DeleteSensorUpdatePolicies( &sensor_update_policies.DeleteSensorUpdatePoliciesParams{ Ids: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.deleteSensorUpdatePolicies(["ID1", "ID2", "ID3"]); // ids
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::delete_sensor_update_policies;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = delete_sensor_update_policies( &falcon.cfg, // configuration vec!["string".to_string()], // ids ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.delete_sensor_update_policies(['ID1', 'ID2', 'ID3'])
puts responseupdateSensorUpdatePolicies
Section titled “updateSensorUpdatePolicies”Update Sensor Update Policies by specifying the ID of the policy and details to update.
update_policiesParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| build | body | string | Build this Sensor update policy applies to. |
| description | body | string | Sensor update policy description. |
| id | body | string | ID the Sensor Update policy to update. |
| name | body | string | Name of the Sensor Update policy. |
| settings | body | dictionary | Sensor Update policy specific settings. Overrides the value of build if present.{ “build”: “string” } |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.update_policies(build="string", description="string", id="string", name="string", settings={})print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.updateSensorUpdatePolicies(build="string", description="string", id="string", name="string", settings={})print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "resources": [ { "description": "string", "id": "string", "name": "string", "settings": { "build": "string" } } ]}
response = falcon.command("updateSensorUpdatePolicies", body=body_payload)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
description := "string" id := "string" name := "string"
response, err := client.SensorUpdatePolicies.UpdateSensorUpdatePolicies( &sensor_update_policies.UpdateSensorUpdatePoliciesParams{ Body: &models.SensorUpdateUpdatePoliciesReqV1{ Resources: []interface{}{ { Description: &description, ID: &id, Name: &name, Settings: &struct{}{}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.updateSensorUpdatePolicies( { resources: [{ description: "string", id: "string", name: "string", settings: { build: "string" } }]} // body);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::update_sensor_update_policies;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::SensorUpdateUpdatePoliciesReqV1;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = SensorUpdateUpdatePoliciesReqV1 { resources: vec![UpdatePolicyReqV1 { id: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = update_sensor_update_policies( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
body = Falcon::SensorUpdateUpdatePoliciesReqV1.new( resources: [{ description: 'string', id: 'string', name: 'string', settings: { build: 'string' } }])
response = api.update_sensor_update_policies(body)
puts responsegetSensorUpdatePoliciesV2
Section titled “getSensorUpdatePoliciesV2”Retrieve a set of Sensor Update Policies with additional support for uninstall protection by specifying their IDs.
get_policies_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| ids | query | string or list of strings | The IDs of the Sensor Update policies to retrieve. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_policies_v2(ids=id_list)print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.getSensorUpdatePoliciesV2(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("getSensorUpdatePoliciesV2", ids=id_list)print(response)Get-FalconSensorUpdatePolicy -Id @("ID1", "ID2")package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.SensorUpdatePolicies.GetSensorUpdatePoliciesV2( &sensor_update_policies.GetSensorUpdatePoliciesV2Params{ Ids: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.getSensorUpdatePoliciesV2(["ID1", "ID2", "ID3"]); // ids
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::get_sensor_update_policies_v2;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_sensor_update_policies_v2( &falcon.cfg, // configuration vec!["string".to_string()], // ids ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.get_sensor_update_policies_v2(['ID1', 'ID2', 'ID3'])
puts responsecreateSensorUpdatePoliciesV2
Section titled “createSensorUpdatePoliciesV2”Create Sensor Update Policies by specifying details about the policy to create with additional support for uninstall protection.
create_policies_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| build | body | string | Build this Sensor update policy applies to. Ignored if settings is provided. |
| description | body | string | Sensor update policy description. |
| name | body | string | Name of the Sensor Update policy. |
| platform_name | body | string | Name of the OS platform the Sensor Update policy applies to. |
| scheduler | body | dictionary | Dictionary containing details for the schedule. Ignored if settings is provided. |
| settings | body | dictionary | Sensor Update policy specific settings. Overrides the value of build, scheduler, show_early_adopter_builds, uninstall_protection, and variants if present. |
| show_early_adopter_builds | body | boolean | Flag indicating if early adopter builds should be shown as part of this policy. Ignored if settings is provided. |
| uninstall_protection | body | string | Boolean indicating if uninstall protection should be enabled. Ignored if settings is provided. Allowed values: ENABLED, DISABLED. |
| variants | body | list of dictionaries | List of dictionaries containing details for variants to include in the policy. Ignored if settings is provided.[{ “build”: “string”, “platform”: “string” }] |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.create_policies_v2(build="string", description="string", name="string", platform_name="string", scheduler={}, settings={}, show_early_adopter_builds=boolean, uninstall_protection=boolean, variants=[{"key": "value"}])print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.createSensorUpdatePoliciesV2(build="string", description="string", name="string", platform_name="string", scheduler={}, settings={}, show_early_adopter_builds=boolean, uninstall_protection=boolean, variants=[{"key": "value"}])print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "resources": [ { "description": "string", "name": "string", "platform_name": "string", "settings": { "build": "string", "scheduler": {}, "show_early_adopter_builds": boolean, "uninstall_protection": "string", "variants": ["string"] } } ]}
response = falcon.command("createSensorUpdatePoliciesV2", body=body_payload)print(response)New-FalconSensorUpdatePolicy -Name "string" -PlatformName "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
description := "string" name := "string" platform_name := "string"
response, err := client.SensorUpdatePolicies.CreateSensorUpdatePoliciesV2( &sensor_update_policies.CreateSensorUpdatePoliciesV2Params{ Body: &models.SensorUpdateCreatePoliciesReqV2{ Resources: []interface{}{ { Description: &description, Name: &name, PlatformName: &platform_name, Settings: &struct{}{}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.createSensorUpdatePoliciesV2( { resources: [{ description: "string", name: "string", platformName: "string", settings: { build: "string", scheduler: {}, showEarlyAdopterBuilds: boolean, uninstallProtection: "string", variants: [] } }]} // body);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::create_sensor_update_policies_v2;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::SensorUpdateCreatePoliciesReqV2;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = SensorUpdateCreatePoliciesReqV2 { resources: vec![CreatePolicyReqV2 { name: Some("string".to_string()), platform_name: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = create_sensor_update_policies_v2( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
body = Falcon::SensorUpdateCreatePoliciesReqV2.new( resources: [{ description: 'string', name: 'string', platform_name: 'string', settings: { build: 'string', scheduler: {}, show_early_adopter_builds: boolean, uninstall_protection: 'string', variants: [] } }])
response = api.create_sensor_update_policies_v2(body)
puts responseupdateSensorUpdatePoliciesV2
Section titled “updateSensorUpdatePoliciesV2”Update Sensor Update Policies by specifying the ID of the policy and details to update with additional support for uninstall protection.
update_policies_v2Parameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. |
| build | body | string | Build this Sensor update policy applies to. Ignored if settings is provided. |
| description | body | string | Sensor update policy description. |
| id | body | string | ID of the Sensor Update policy to update. |
| name | body | string | Name of the Sensor Update policy. |
| scheduler | body | dictionary | Dictionary containing details for the schedule. Ignored if settings is provided. |
| settings | body | dictionary | Sensor Update policy specific settings. Overrides the value of build, scheduler, show_early_adopter_builds, uninstall_protection, and variants if present. |
| show_early_adopter_builds | body | boolean | Flag indicating if early adopter builds should be shown as part of this policy. Ignored if settings is provided. |
| uninstall_protection | body | string | Boolean indicating if uninstall protection should be enabled. Ignored if settings is provided. Allowed values: ENABLED, DISABLED. |
| variants | body | list of dictionaries | List of dictionaries containing details for variants to include in the policy. Ignored if settings is provided.[{ “build”: “string”, “platform”: “string” }] |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.update_policies_v2(build="string", description="string", id="string", name="string", scheduler={}, settings={}, show_early_adopter_builds=boolean, uninstall_protection=boolean, variants=[{"key": "value"}])print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.updateSensorUpdatePoliciesV2(build="string", description="string", id="string", name="string", scheduler={}, settings={}, show_early_adopter_builds=boolean, uninstall_protection=boolean, variants=[{"key": "value"}])print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "resources": [ { "description": "string", "id": "string", "name": "string", "settings": { "build": "string", "scheduler": {}, "show_early_adopter_builds": boolean, "uninstall_protection": "string", "variants": ["string"] } } ]}
response = falcon.command("updateSensorUpdatePoliciesV2", body=body_payload)print(response)Edit-FalconSensorUpdatePolicy -Id "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
description := "string" id := "string" name := "string"
response, err := client.SensorUpdatePolicies.UpdateSensorUpdatePoliciesV2( &sensor_update_policies.UpdateSensorUpdatePoliciesV2Params{ Body: &models.SensorUpdateUpdatePoliciesReqV2{ Resources: []interface{}{ { Description: &description, ID: &id, Name: &name, Settings: &struct{}{}, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.updateSensorUpdatePoliciesV2( { resources: [{ description: "string", id: "string", name: "string", settings: { build: "string", scheduler: {}, showEarlyAdopterBuilds: boolean, uninstallProtection: "string", variants: [] } }]} // body);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::update_sensor_update_policies_v2;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::SensorUpdateUpdatePoliciesReqV2;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = SensorUpdateUpdatePoliciesReqV2 { resources: vec![UpdatePolicyReqV2 { id: Some("string".to_string()), ..Default::default() }], ..Default::default() };
let response = update_sensor_update_policies_v2( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
body = Falcon::SensorUpdateUpdatePoliciesReqV2.new( resources: [{ description: 'string', id: 'string', name: 'string', settings: { build: 'string', scheduler: {}, show_early_adopter_builds: boolean, uninstall_protection: 'string', variants: [] } }])
response = api.update_sensor_update_policies_v2(body)
puts responsequerySensorUpdateKernelsDistinct
Section titled “querySensorUpdateKernelsDistinct”Retrieve kernel compatibility info for Sensor Update Builds.
query_kernelsParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| distinct_field | path | string | The field name to get distinct values for. Default: id. |
| filter | query | string | The filter expression that should be used to limit the results using FQL syntax. |
| limit | query | integer | The maximum number of records to return. [1-500] |
| offset | query | integer | The offset to start retrieving records from. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_kernels(distinct_field="string", filter="string", limit=integer, offset=integer)print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.querySensorUpdateKernelsDistinct(distinct_field="string", filter="string", limit=integer, offset=integer)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("querySensorUpdateKernelsDistinct", distinct_field="string", filter="string", offset=integer, limit=integer)print(response)Get-FalconKernel -Filter "string" ` -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
filter := "string" offset := int64(0) limit := int64(0)
response, err := client.SensorUpdatePolicies.QuerySensorUpdateKernelsDistinct( &sensor_update_policies.QuerySensorUpdateKernelsDistinctParams{ DistinctField: "string", Filter: &filter, Offset: &offset, Limit: &limit, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.querySensorUpdateKernelsDistinct( "string", // distinctField "string", // filter integer, // offset integer // limit);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::query_sensor_update_kernels_distinct;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_sensor_update_kernels_distinct( &falcon.cfg, // configuration "string", // distinct_field Some("string"), // filter Some(integer), // offset Some(integer), // limit ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.query_sensor_update_kernels_distinct('string')
puts responsequerySensorUpdatePolicyMembers
Section titled “querySensorUpdatePolicyMembers”Search for members of a Sensor Update Policy in your environment by providing a FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria.
query_policy_membersParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| id | query | string | The ID of the Sensor Update Policy to search for members of. |
| filter | query | string | The filter expression that should be used to limit the results using FQL syntax. |
| limit | query | integer | The maximum number of records to return. [1-5000] |
| offset | query | integer | The offset to start retrieving records from. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
| sort | query | string | The property to sort by in FQL syntax. Supports asc or desc. Available sort options: created_by, created_timestamp, enabled, modified_by, modified_timestamp, name, platform_name, precedence. |
Available Filters
Section titled “Available Filters”The following fields can be used to filter results retrieved from the API.
| Name | Description |
|---|---|
| created_by | The username, email, or API client ID of the person who created the policy, as identified in the policy object. When specifying an email address, use a letter p as an operator so that the @ sign is accepted. You can also search by using the email username or the domain as the value. For example, to filter on policies created by the email address diana.hudson@email.com: filter=created_by:p’diana.hudson@email.com’ (correct)filter=created_by:‘diana.hudson’ (correct)filter=created_by:‘email.com’ (correct)filter=created_by:‘diana’ (incorrect)Enter only the alphanumeric value when providing an API client ID. For example, to filter on api-client-id:7a1284d634af196bff5988fb1775721b: filter=created_by:‘7a12…721b’ (correct)filter=created_by:‘api-client-id:7a12…721b’ (incorrect)filter=created_by:‘api-client-id’ (incorrect) |
| created_timestamp | The full timestamp of when the policy was created in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss.sssZ) The timezone is always UTC as denoted by the suffix “Z”. filter=created_timestamp:‘2020-11-23T19:36:24.129652084Z’ |
| description | Search for a term found in the policy description. The value must be entered in lowercase.filter=description:‘policy’ |
| enabled | Find policies by their enabled status. Specify true to find enabled policies or false to find disabled policies.filter=enabled:‘true’ |
| groups | Enter a host group ID to find the policy it’s been assigned to.filter=groups:‘1ef3…b0fe’ |
| modified_by | The username, email, or API client ID of the person who modified the policy, as identified in the policy object. Values for this field follow the same rules as the created_by filter. |
| modified_timestamp | The full timestamp of when the policy was modified in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss. sssZ) The timezone is always UTC as denoted by the suffix “Z”. Values for this field follow the same rules as the created_timestamp filter. |
| name | Performs a free text search on single words found in a policy name. Values must be entered as lowercase and enclosed in single quotes. You can provide multiple name values separated by an &.filter=name:‘test’ |
| name.raw | Filters on exact matches to the full policy name. Searches on this field are case-sensitive and require the correct input of uppercase and lowercase letters. filter=name.raw:‘Test sensor update Policy’ |
| platform_name | The name of the operating system listed in the policy. One of: Windows, Mac, Linuxfilter=platform_name:‘Windows’ |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_policy_members(id="string", filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.querySensorUpdatePolicyMembers(id="string", filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("querySensorUpdatePolicyMembers", id="string", filter="string", offset=integer, limit=integer, sort="string")print(response)Get-FalconSensorUpdatePolicyMember -Filter "string" ` -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
iD := "string" filter := "string" offset := int64(0) limit := int64(0) sort := "string"
response, err := client.SensorUpdatePolicies.QuerySensorUpdatePolicyMembers( &sensor_update_policies.QuerySensorUpdatePolicyMembersParams{ ID: &iD, Filter: &filter, Offset: &offset, Limit: &limit, Sort: &sort, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.querySensorUpdatePolicyMembers( "string", // id "string", // filter integer, // offset integer, // limit "string" // sort);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::query_sensor_update_policy_members;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_sensor_update_policy_members( &falcon.cfg, // configuration Some("string"), // id Some("string"), // filter Some(integer), // offset Some(integer), // limit Some("string"), // sort ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.query_sensor_update_policy_members(id: 'string', filter: 'string', offset: integer, limit: integer, sort: 'string')
puts responsequerySensorUpdatePolicies
Section titled “querySensorUpdatePolicies”Search for Sensor Update Policies in your environment by providing a FQL filter and paging details. Returns a set of Sensor Update Policy IDs which match the filter criteria.
query_policiesParameters
Section titled “Parameters”| Name | Type | Data type | Description |
|---|---|---|---|
| filter | query | string | The filter expression that should be used to limit the results using FQL syntax. |
| limit | query | integer | The maximum number of records to return. [1-5000] |
| offset | query | integer | The offset to start retrieving records from. |
| parameters | query | dictionary | Full query string parameters payload in JSON format. |
| sort | query | string | The property to sort by in FQL syntax. Supports asc or desc. Available sort options: created_by, created_timestamp, enabled, modified_by, modified_timestamp, name, platform_name, precedence. |
Available Filters
Section titled “Available Filters”The following fields can be used to filter results retrieved from the API.
| Name | Description |
|---|---|
| created_by | The username, email, or API client ID of the person who created the policy, as identified in the policy object. When specifying an email address, use a letter p as an operator so that the @ sign is accepted. You can also search by using the email username or the domain as the value. For example, to filter on policies created by the email address diana.hudson@email.com: filter=created_by:p’diana.hudson@email.com’ (correct)filter=created_by:‘diana.hudson’ (correct)filter=created_by:‘email.com’ (correct)filter=created_by:‘diana’ (incorrect)Enter only the alphanumeric value when providing an API client ID. For example, to filter on api-client-id:7a1284d634af196bff5988fb1775721b: filter=created_by:‘7a12…721b’ (correct)filter=created_by:‘api-client-id:7a12…721b’ (incorrect)filter=created_by:‘api-client-id’ (incorrect) |
| created_timestamp | The full timestamp of when the policy was created in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss.sssZ) The timezone is always UTC as denoted by the suffix “Z”. filter=created_timestamp:‘2020-11-23T19:36:24.129652084Z’ |
| description | Search for a term found in the policy description. The value must be entered in lowercase.filter=description:‘policy’ |
| enabled | Find policies by their enabled status. Specify true to find enabled policies or false to find disabled policies.filter=enabled:‘true’ |
| groups | Enter a host group ID to find the policy it’s been assigned to.filter=groups:‘1ef3…b0fe’ |
| modified_by | The username, email, or API client ID of the person who modified the policy, as identified in the policy object. Values for this field follow the same rules as the created_by filter. |
| modified_timestamp | The full timestamp of when the policy was modified in ISO 8601 format. (YYYY-MM-DDTHH:mm:ss. sssZ) The timezone is always UTC as denoted by the suffix “Z”. Values for this field follow the same rules as the created_timestamp filter. |
| name | Performs a free text search on single words found in a policy name. Values must be entered as lowercase and enclosed in single quotes. You can provide multiple name values separated by an &.filter=name:‘test’ |
| name.raw | Filters on exact matches to the full policy name. Searches on this field are case-sensitive and require the correct input of uppercase and lowercase letters. filter=name.raw:‘Test sensor update Policy’ |
| platform_name | The name of the operating system listed in the policy. One of: Windows, Mac, Linuxfilter=platform_name:‘Windows’ |
Code Examples
Section titled “Code Examples”from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_policies(filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import SensorUpdatePolicy
falcon = SensorUpdatePolicy(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.querySensorUpdatePolicies(filter="string", limit=integer, offset=integer, sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("querySensorUpdatePolicies", filter="string", offset=integer, limit=integer, sort="string")print(response)Get-FalconSensorUpdatePolicy -Filter "string" ` -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/sensor_update_policies")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
filter := "string" offset := int64(0) limit := int64(0) sort := "string"
response, err := client.SensorUpdatePolicies.QuerySensorUpdatePolicies( &sensor_update_policies.QuerySensorUpdatePoliciesParams{ Filter: &filter, Offset: &offset, Limit: &limit, Sort: &sort, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.sensorUpdatePolicies.querySensorUpdatePolicies( "string", // filter integer, // offset integer, // limit "string" // sort);
console.log(response);use rusty_falcon::apis::sensor_update_policies_api::query_sensor_update_policies;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_sensor_update_policies( &falcon.cfg, // configuration Some("string"), // filter Some(integer), // offset Some(integer), // limit Some("string"), // sort ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::SensorUpdatePolicies.new
response = api.query_sensor_update_policies(filter: 'string', offset: integer, limit: integer, sort: 'string')
puts response