Firewall Policies

The Firewall Policies service collection provides operations for managing Firewall Policies. Search for policies and their members, perform actions on policies, set policy precedence, retrieve, create, delete, and update Firewall Policies.

Language	Last Update
Python	v1.4.6
PowerShell	v2.2.9
Go	v0.20.0
TypeScript	v0.6.0
Rust	v0.7.0
Ruby	v1.2.0

Operation	Description
queryCombinedFirewallPolicyMembers `query_combined_policy_members`	Search for members of a Firewall Policy in your environment by providing a FQL filter and paging details. Returns a set of host details which match the filter criteria
queryCombinedFirewallPolicies `query_combined_policies`	Search for Firewall Policies in your environment by providing a FQL filter and paging details. Returns a set of Firewall Policies which match the filter criteria
performFirewallPoliciesAction `perform_policies_action`	Perform the specified action on the Firewall Policies specified in the request
setFirewallPoliciesPrecedence `set_policies_precedence`	Sets the precedence of Firewall 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
getFirewallPolicies `get_policies`	Retrieve a set of Firewall Policies by specifying their IDs
createFirewallPolicies `create_policies`	Create Firewall Policies by specifying details about the policy to create
deleteFirewallPolicies `delete_policies`	Delete a set of Firewall Policies by specifying their IDs
updateFirewallPolicies `update_policies`	Update Firewall Policies by specifying the ID of the policy and details to update
queryFirewallPolicyMembers `query_policy_members`	Search for members of a Firewall Policy in your environment by providing a FQL filter and paging details. Returns a set of Agent IDs which match the filter criteria
queryFirewallPolicies `query_policies`	Search for Firewall Policies in your environment by providing a FQL filter and paging details. Returns a set of Firewall Policy IDs which match the filter criteria

queryCombinedFirewallPolicyMembers

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

GET /policy/combined/firewall-members/v1

Scope Firewall Policies: READ Consumes · Produces application/json

PEP 8 query_combined_policy_members

Parameters

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

Code Examples

from falconpy import FirewallPolicies

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

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

Get-FalconFirewallPolicyMember -Filter "string" `
  -Sort "string" `
  -Limit integer `
  -Offset integer

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.QueryCombinedFirewallPolicyMembers(
    &firewall_policies.QueryCombinedFirewallPolicyMembersParams{
      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.firewallPolicies.queryCombinedFirewallPolicyMembers(
  "string",  // id
  "string",  // filter
  integer,  // offset
  integer,  // limit
  "string"  // sort
);

console.log(response);

use rusty_falcon::apis::firewall_policies_api::query_combined_firewall_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_firewall_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::FirewallPolicies.new

response = api.query_combined_firewall_policy_members(id: 'string',
                                                      filter: 'string',
                                                      offset: integer,
                                                      limit: integer,
                                                      sort: 'string')

puts response

queryCombinedFirewallPolicies

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

GET /policy/combined/firewall/v1

Scope Firewall Policies: READ Consumes · Produces application/json

PEP 8 query_combined_policies

Parameters

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

Code Examples

from falconpy import FirewallPolicies

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

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

Get-FalconFirewallPolicy -Filter "string" `
  -Sort "string" `
  -Limit integer `
  -Offset integer

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.QueryCombinedFirewallPolicies(
    &firewall_policies.QueryCombinedFirewallPoliciesParams{
      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.firewallPolicies.queryCombinedFirewallPolicies(
  "string",  // filter
  integer,  // offset
  integer,  // limit
  "string"  // sort
);

console.log(response);

use rusty_falcon::apis::firewall_policies_api::query_combined_firewall_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_firewall_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::FirewallPolicies.new

response = api.query_combined_firewall_policies(filter: 'string',
                                                offset: integer,
                                                limit: integer,
                                                sort: 'string')

puts response

performFirewallPoliciesAction

Perform the specified action on the Firewall Policies specified in the request

POST /policy/entities/firewall-actions/v1

Scope Firewall Policies: WRITE Consumes · Produces application/json

PEP 8 perform_policies_action

Parameters

Name	Type	Data type	Description
action_name	query	string	The action to perform. Allowed values: `add-host-group`, `add-rule-group`, `disable`, `enable`, `remove-host-group`, `remove-rule-group`
action_parameters	body	list of dictionaries	List of name / value pairs in JSON format.
body	body	dictionary	Full body payload in JSON format.
group_id	body / action_parameters	string	Host Group ID to apply the policy to. String. Overridden if `action_parameters` is specified.
ids	body	string or list of strings	Response Policy ID(s) to perform actions against.
parameters	query	dictionary	Full query string parameters payload in JSON format.

Code Examples

from falconpy import FirewallPolicies

falcon = FirewallPolicies(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_action(action_name="string",
                                 action_parameters=[{"key": "value"}],
                                 group_id="string",
                                 ids=id_list)
print(response)

from falconpy import FirewallPolicies

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

response = falcon.performFirewallPoliciesAction(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("performFirewallPoliciesAction",
                          action_name="string",
                          body=body_payload)
print(response)

Invoke-FalconFirewallPolicyAction -Name "string" -Id "string"

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.PerformFirewallPoliciesAction(
    &firewall_policies.PerformFirewallPoliciesActionParams{
      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.firewallPolicies.performFirewallPoliciesAction(
  "string",  // actionName
  {  // body
      actionParameters: [{
          name: "string",
          value: "string"
        }],
      ids: []
  }
);

console.log(response);

use rusty_falcon::apis::firewall_policies_api::perform_firewall_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_firewall_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::FirewallPolicies.new

body = Falcon::MsaEntityActionRequestV2.new(
  action_parameters: [{
      name: 'string',
      value: 'string'
    }],
  ids: []
)

response = api.perform_firewall_policies_action(body, 'string')

puts response

setFirewallPoliciesPrecedence

Sets the precedence of Firewall 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

POST /policy/entities/firewall-precedence/v1

Scope Firewall Policies: WRITE Consumes · Produces application/json

PEP 8 set_policies_precedence

Parameters

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

Code Examples

from falconpy import FirewallPolicies

falcon = FirewallPolicies(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(ids=id_list, platform_name="string")
print(response)

from falconpy import FirewallPolicies

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

response = falcon.setFirewallPoliciesPrecedence(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("setFirewallPoliciesPrecedence", body=body_payload)
print(response)

Set-FalconFirewallPrecedence -PlatformName "string" -Id @("ID1", "ID2")

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.SetFirewallPoliciesPrecedence(
    &firewall_policies.SetFirewallPoliciesPrecedenceParams{
      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.firewallPolicies.setFirewallPoliciesPrecedence(
  {
    ids: [],
    platformName: "string"
}  // body
);

console.log(response);

use rusty_falcon::apis::firewall_policies_api::set_firewall_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_firewall_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::FirewallPolicies.new

body = Falcon::BaseSetPolicyPrecedenceReqV1.new(
  ids: [],
  platform_name: 'string'
)

response = api.set_firewall_policies_precedence(body)

puts response

getFirewallPolicies

Retrieve a set of Firewall Policies by specifying their IDs

GET /policy/entities/firewall/v1

Scope Firewall Policies: READ Consumes · Produces application/json

PEP 8 get_policies

Parameters

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

Code Examples

from falconpy import FirewallPolicies

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

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

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

Get-FalconFirewallPolicy -Id @("ID1", "ID2")

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.GetFirewallPolicies(
    &firewall_policies.GetFirewallPoliciesParams{
      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.firewallPolicies.getFirewallPolicies(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

use rusty_falcon::apis::firewall_policies_api::get_firewall_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_firewall_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::FirewallPolicies.new

response = api.get_firewall_policies(['ID1', 'ID2', 'ID3'])

puts response

createFirewallPolicies

Create Firewall Policies by specifying details about the policy to create

POST /policy/entities/firewall/v1

Scope Firewall Policies: WRITE Consumes · Produces application/json

PEP 8 create_policies

Parameters

Name	Type	Data type	Description
body	body	dictionary	Full body payload in JSON format.
description	body	string	Firewall Policy description.
clone_id	query	string	Firewall Policy ID to clone.
name	body	string	Firewall Policy name.
platform_name	body	string	Firewall Policy platform.

Code Examples

from falconpy import FirewallPolicies

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

from falconpy import FirewallPolicies

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

response = falcon.createFirewallPolicies(clone_id="string",
                                         description="string",
                                         name="string",
                                         platform_name="string")
print(response)

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "resources": [
        {
            "clone_id": "string",
            "description": "string",
            "name": "string",
            "platform_name": "string"
        }
    ]
}

response = falcon.command("createFirewallPolicies",
                          clone_id="string",
                          body=body_payload)
print(response)

New-FalconFirewallPolicy -Name "string" -PlatformName "string"

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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)
  }

  clone_id := "string"
  description := "string"
  name := "string"
  platform_name := "string"
  cloneID := "string"

  response, err := client.FirewallPolicies.CreateFirewallPolicies(
    &firewall_policies.CreateFirewallPoliciesParams{
      Body: &models.FirewallCreateFirewallPoliciesReqV1{
        Resources: []interface{}{
          {
          CloneID: &clone_id,
          Description: &description,
          Name: &name,
          PlatformName: &platform_name,
          },
        },
      },
      CloneID: &cloneID,
      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.firewallPolicies.createFirewallPolicies(
  {  // body
      resources: [{
          cloneId: "string",
          description: "string",
          name: "string",
          platformName: "string"
        }]
  },
  "string"  // cloneId
);

console.log(response);

use rusty_falcon::apis::firewall_policies_api::create_firewall_policies;
use rusty_falcon::easy::client::FalconHandle;
use rusty_falcon::models::FirewallCreateFirewallPoliciesReqV1;

#[tokio::main]
async fn main() {
    let falcon = FalconHandle::from_env().await.expect("Could not authenticate");

    let body = FirewallCreateFirewallPoliciesReqV1 {
        resources: vec![CreateFirewallPolicyReqV1 {
            name: Some("string".to_string()),
            platform_name: Some("string".to_string()),
            ..Default::default()
        }],
        ..Default::default()
    };

    let response = create_firewall_policies(
        &falcon.cfg,  // configuration
        body,  // body
        Some("string"),  // clone_id
    ).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::FirewallPolicies.new

body = Falcon::FirewallCreateFirewallPoliciesReqV1.new(
  resources: [{
      clone_id: 'string',
      description: 'string',
      name: 'string',
      platform_name: 'string'
    }]
)

response = api.create_firewall_policies(body)

puts response

deleteFirewallPolicies

Delete a set of Firewall Policies by specifying their IDs

DELETE /policy/entities/firewall/v1

Scope Firewall Policies: WRITE Consumes · Produces application/json

PEP 8 delete_policies

Parameters

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

Code Examples

from falconpy import FirewallPolicies

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

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

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

Remove-FalconFirewallPolicy -Id @("ID1", "ID2")

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.DeleteFirewallPolicies(
    &firewall_policies.DeleteFirewallPoliciesParams{
      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.firewallPolicies.deleteFirewallPolicies(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

use rusty_falcon::apis::firewall_policies_api::delete_firewall_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_firewall_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::FirewallPolicies.new

response = api.delete_firewall_policies(['ID1', 'ID2', 'ID3'])

puts response

updateFirewallPolicies

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

PATCH /policy/entities/firewall/v1

Scope Firewall Policies: WRITE Consumes · Produces application/json

PEP 8 update_policies

Parameters

Name	Type	Data type	Description
body	body	dictionary	Full body payload in JSON format.
description	body	string	Firewall Policy description.
id	body	string	Firewall Policy ID to update.
name	body	string	Firewall Policy name.
platform_name	body	string	Firewall Policy platform.

Code Examples

from falconpy import FirewallPolicies

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

from falconpy import FirewallPolicies

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

response = falcon.updateFirewallPolicies(id="string",
                                         description="string",
                                         name="string")
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"
        }
    ]
}

response = falcon.command("updateFirewallPolicies", body=body_payload)
print(response)

Edit-FalconFirewallPolicy -Id "string"

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.UpdateFirewallPolicies(
    &firewall_policies.UpdateFirewallPoliciesParams{
      Body: &models.FirewallUpdateFirewallPoliciesReqV1{
        Resources: []interface{}{
          {
          Description: &description,
          ID: &id,
          Name: &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.firewallPolicies.updateFirewallPolicies(
  {
    resources: [{
        description: "string",
        id: "string",
        name: "string"
      }]
}  // body
);

console.log(response);

use rusty_falcon::apis::firewall_policies_api::update_firewall_policies;
use rusty_falcon::easy::client::FalconHandle;
use rusty_falcon::models::FirewallUpdateFirewallPoliciesReqV1;

#[tokio::main]
async fn main() {
    let falcon = FalconHandle::from_env().await.expect("Could not authenticate");

    let body = FirewallUpdateFirewallPoliciesReqV1 {
        resources: vec![UpdateFirewallPolicyReqV1 {
            id: Some("string".to_string()),
            ..Default::default()
        }],
        ..Default::default()
    };

    let response = update_firewall_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::FirewallPolicies.new

body = Falcon::FirewallUpdateFirewallPoliciesReqV1.new(
  resources: [{
      description: 'string',
      id: 'string',
      name: 'string'
    }]
)

response = api.update_firewall_policies(body)

puts response

queryFirewallPolicyMembers

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

GET /policy/queries/firewall-members/v1

Scope Firewall Policies: READ Consumes · Produces application/json

PEP 8 query_policy_members

Parameters

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

Code Examples

from falconpy import FirewallPolicies

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

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

Get-FalconFirewallPolicyMember -Filter "string" `
  -Sort "string" `
  -Limit integer `
  -Offset integer

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.QueryFirewallPolicyMembers(
    &firewall_policies.QueryFirewallPolicyMembersParams{
      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.firewallPolicies.queryFirewallPolicyMembers(
  "string",  // id
  "string",  // filter
  integer,  // offset
  integer,  // limit
  "string"  // sort
);

console.log(response);

use rusty_falcon::apis::firewall_policies_api::query_firewall_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_firewall_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::FirewallPolicies.new

response = api.query_firewall_policy_members(id: 'string',
                                             filter: 'string',
                                             offset: integer,
                                             limit: integer,
                                             sort: 'string')

puts response

queryFirewallPolicies

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

GET /policy/queries/firewall/v1

Scope Firewall Policies: READ Consumes · Produces application/json

PEP 8 query_policies

Parameters

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

Code Examples

from falconpy import FirewallPolicies

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

falcon = FirewallPolicies(client_id=CLIENT_ID,
                          client_secret=CLIENT_SECRET
                          )

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

Get-FalconFirewallPolicy -Filter "string" `
  -Sort "string" `
  -Limit integer `
  -Offset integer

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/firewall_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.FirewallPolicies.QueryFirewallPolicies(
    &firewall_policies.QueryFirewallPoliciesParams{
      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.firewallPolicies.queryFirewallPolicies(
  "string",  // filter
  integer,  // offset
  integer,  // limit
  "string"  // sort
);

console.log(response);

use rusty_falcon::apis::firewall_policies_api::query_firewall_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_firewall_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::FirewallPolicies.new

response = api.query_firewall_policies(filter: 'string',
                                       offset: integer,
                                       limit: integer,
                                       sort: 'string')

puts response

Firewall Policies

Table of Contents

queryCombinedFirewallPolicyMembers

Parameters

Code Examples

queryCombinedFirewallPolicies

Parameters

Code Examples

performFirewallPoliciesAction

Parameters

Code Examples

setFirewallPoliciesPrecedence

Parameters

Code Examples

getFirewallPolicies

Parameters

Code Examples

createFirewallPolicies

Parameters

Code Examples

deleteFirewallPolicies

Parameters

Code Examples

updateFirewallPolicies

Parameters

Code Examples

queryFirewallPolicyMembers

Parameters

Code Examples

queryFirewallPolicies

Parameters

Code Examples