Seraphic

Operations for the Seraphic service collection. Also available in FalconPy as BrowserSecurity.

Language	Last Update
Python	v1.6.6
PowerShell
Go	v0.24.0
TypeScript	v0.9.0
Rust
Ruby	v1.6.0

---

Table of Contents

Operation	Description
ActivateAgents activate_agents	Activate agents by ID.
AddUrlDomainList add_url_domain_list	Add URLs and domains to an integration list.
ApplyAgentTasks apply_agent_tasks	Apply tasks to a Seraphic Enterprise Browser agent.
ClassifyDomains classify_domains	Classify domains via the Seraphic Enterprise Browser classification engine.
CombinedQueryAgents query_combined_seraphic_agents	Query agents and return their details in a single call. limit accepts up to 2500.
CreateDestinationGroup create_destination_group	Create a destination group.
DeactivateAgents deactivate_agents	Deactivate agents by ID.
DeleteDestinationGroup delete_destination_group	Delete a destination group.
DeleteUrlDomainList delete_url_domain_list	Delete URLs and domains from an integration list.
GetAgents get_seraphic_agents	Retrieve agents by ID.
GetAuditLogsMixin0 get_seraphic_audit_logs	Retrieve audit log entries by ID.
GetDestinationGroups get_destination_groups	Retrieve destination groups by ID.
GetExtensionAnalysis get_extension_analysis	Retrieve browser-extension risk analysis by store and extension ID.
GetRules get_seraphic_rules	Retrieve rules by ID.
GetTenantSettings get_tenant_settings	Retrieve Seraphic Enterprise Browser tenant settings.
GetUrlDomainLists get_url_domain_lists	Retrieve URL/domain integration lists by ID.
QueryAgents query_seraphic_agents	Query agent IDs by filter, sort and pagination. limit accepts up to 1000.
QueryDestinationGroups query_destination_groups	Query destination groups by filter, sort and pagination.
QueryRulesMixin0 query_seraphic_rules	Query rules within a category by filter, sort and pagination.
UpdateDestinationGroup update_destination_group	Partial-update a destination group.
UpdateRuleMixin0 update_seraphic_rule	Partial-update a rule (extensions, targets, destination groups, status).

---

ActivateAgents

Activate agents by ID.

Method POST

Route /seraphic-enterprise-browser/entities/agent-activation/v1

Scope Secure Access: WRITE

PEP 8 activate_agents

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

ids body · array

The ids value.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

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

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

Operation ID

from falconpy import Seraphic

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

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

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

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "ids": ["string"]
}

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.ActivateAgents(
    &seraphic_enterprise_browser.ActivateAgentsParams{
      Body: &models.AgentIDsRequest{
        Ids: []string{"string"},
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.activateAgents(
  {
    ids: []
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::AgentIDsRequest.new(
  ids: []
)

response = api.activate_agents(body)

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

AddUrlDomainList

Add URLs and domains to an integration list.

Method POST

Route /seraphic-enterprise-browser/entities/url-domain-lists/v1

Scope Secure Access: WRITE

PEP 8 add_url_domain_list

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

integration_id body · string

integrationId body · string

IntegrationId body · string

urls body · array

The urls value.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

response = falcon.add_url_domain_list(integrationId="string", urls=["string"])
print(response)

Operation ID

from falconpy import Seraphic

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

response = falcon.AddUrlDomainList(integrationId="string", urls=["string"])
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "integration_id": "string",
    "urls": ["string"]
}

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  integrationID := "string"

  response, err := client.SeraphicEnterpriseBrowser.AddURLDomainList(
    &seraphic_enterprise_browser.AddURLDomainListParams{
      Body: &models.URLDomainListRequest{
        IntegrationID: &integrationID,
        Urls: []string{"string"},
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.addUrlDomainList(
  {
    integrationId: "string",
    urls: []
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::UrlDomainListRequest.new(
  integration_id: 'string',
  urls: []
)

response = api.add_url_domain_list(body)

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

ApplyAgentTasks

Apply tasks to a Seraphic Enterprise Browser agent.

Method POST

Route /seraphic-enterprise-browser/entities/agent-tasks/v1

Scope Secure Access: WRITE

PEP 8 apply_agent_tasks

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

actions body · array

The actions value.

ttl body · integer

The ttl value.

agent_id query · string

The agent ID to apply the tasks to.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

actions = [
    {
        "action": "string",
        "args": [
            "string"
        ]
    }
]

response = falcon.apply_agent_tasks(agent_id="string",
                                    actions=actions,
                                    ttl=integer)
print(response)

Operation ID

from falconpy import Seraphic

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

actions = [
    {
        "action": "string",
        "args": [
            "string"
        ]
    }
]

response = falcon.ApplyAgentTasks(agent_id="string",
                                  actions=actions,
                                  ttl=integer)
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "actions": [
        {
            "action": "string",
            "args": ["string"]
        }
    ],
    "ttl": integer
}

response = falcon.command("ApplyAgentTasks",
                          agent_id="string",
                          body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  action := "string"

  response, err := client.SeraphicEnterpriseBrowser.ApplyAgentTasks(
    &seraphic_enterprise_browser.ApplyAgentTasksParams{
      Body: &models.AgentTasksRequest{
        Actions: []*models.AgentTaskAction{
          {
            Action: &action,
            Args: []models.Object{models.Object("string")},
          },
        },
        TTLHours: integer,
      },
      AgentID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.applyAgentTasks(
  "string",  // agentId
  {  // body
      actions: [{
          action: "remove_browsing_data",
          args: []
        }],
      ttlHours: integer
  }
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::AgentTasksRequest.new(
  actions: [{
      action: 'string',
      args: []
    }]
)

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

puts response

Responses

202 Accepted

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

ClassifyDomains

Classify domains via the Seraphic Enterprise Browser classification engine.

Method POST

Route /seraphic-enterprise-browser/combined/domain-classifications/v1

Scope Secure Access: WRITE

PEP 8 classify_domains

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

domains body · array

The domains value.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

response = falcon.classify_domains(domains=["string"])
print(response)

Operation ID

from falconpy import Seraphic

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

response = falcon.ClassifyDomains(domains=["string"])
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "domains": ["string"]
}

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.ClassifyDomains(
    &seraphic_enterprise_browser.ClassifyDomainsParams{
      Body: &models.DomainClassificationRequest{
        Domains: []string{"string"},
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.classifyDomains(
  {
    domains: []
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::DomainClassificationRequest.new(
  domains: []
)

response = api.classify_domains(body)

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

CombinedQueryAgents

Query agents and return their details in a single call. limit accepts up to 2500.

Method POST

Route /seraphic-enterprise-browser/combined/agents/v1

Scope Secure Access: READ

PEP 8 query_combined_seraphic_agents

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

filter body · object

The filter value. A JSON object, not an FQL string. Every key is optional: application, application_name, application_version, browser_name, browser_version, deployment_method, email, first_seen, host_id, hostname, id, last_seen, os_name, platform, policy_updated, protection_type, status, username.

limit body · integer

The limit value.

search body · string

The search value.

skip body · integer

The skip value.

sort body · array

The sort value.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

filter = {
    "application": [
        "string"
    ],
    "first_seen": {
        "end": "string",
        "start": "string"
    }
}

sort = [
    {
        "field": "string",
        "order": "string"
    }
]

response = falcon.query_combined_seraphic_agents(filter=filter,
                                                 limit=integer,
                                                 search="string",
                                                 skip=integer,
                                                 sort=sort)
print(response)

Operation ID

from falconpy import Seraphic

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

filter = {
    "application": [
        "string"
    ],
    "first_seen": {
        "end": "string",
        "start": "string"
    }
}

sort = [
    {
        "field": "string",
        "order": "string"
    }
]

response = falcon.CombinedQueryAgents(filter=filter,
                                      limit=integer,
                                      search="string",
                                      skip=integer,
                                      sort=sort)
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "filter": {
        "application": ["string"],
        "application_name": ["string"],
        "application_version": ["string"],
        "browser_name": ["string"],
        "browser_version": ["string"],
        "deployment_method": ["string"],
        "email": ["string"],
        "first_seen": {
            "end": "string",
            "start": "string"
        },
        "host_id": ["string"],
        "hostname": ["string"],
        "id": ["string"],
        "last_seen": {
            "end": "string",
            "start": "string"
        },
        "os_name": ["string"],
        "platform": ["string"],
        "policy_updated": ["string"],
        "protection_type": ["string"],
        "status": ["string"],
        "username": ["string"]
    },
    "limit": integer,
    "search": "string",
    "skip": integer,
    "sort": [
        {
            "field": "string",
            "order": "string"
        }
    ]
}

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.CombinedQueryAgents(
    &seraphic_enterprise_browser.CombinedQueryAgentsParams{
      Body: &models.AgentQuery{
        Filter: &models.AgentsFilter{
          Application: []string{"string"},
          ApplicationName: []string{"string"},
          ApplicationVersion: []string{"string"},
          BrowserName: []string{"string"},
          BrowserVersion: []string{"string"},
          DeploymentMethod: []string{"string"},
          Email: []string{"string"},
          FirstSeen: &models.TimeFilter{},
          HostID: []string{"string"},
          Hostname: []string{"string"},
          ID: []string{"string"},
          LastSeen: &models.TimeFilter{},
          OsName: []string{"string"},
          Platform: []string{"string"},
          PolicyUpdated: []bool{boolean},
          ProtectionType: []string{"string"},
          Status: []string{"string"},
          Username: []string{"string"},
        },
        Limit: integer,
        Search: "string",
        Skip: integer,
        Sort: []*models.AgentSort{
          {
            Field: "string",
            Order: "string",
          },
        },
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.combinedQueryAgents(
  {
    filter: {
      application: [],
      applicationName: [],
      applicationVersion: [],
      browserName: [],
      browserVersion: [],
      deploymentMethod: [],
      email: [],
      firstSeen: {
        end: "string",
        start: "string"
      },
      hostId: [],
      hostname: [],
      id: [],
      lastSeen: {
        end: "string",
        start: "string"
      },
      osName: [],
      platform: [],
      policyUpdated: [],
      protectionType: [],
      status: [],
      username: []
    },
    limit: integer,
    search: "string",
    skip: integer,
    sort: [{
        field: "status",
        order: "ASC"
      }]
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::AgentQuery.new(
  filter: {
    application: [],
    application_name: [],
    application_version: [],
    browser_name: [],
    browser_version: [],
    deployment_method: [],
    email: [],
    first_seen: {
      end: 'string',
      start: 'string'
    },
    host_id: [],
    hostname: [],
    id: [],
    last_seen: {
      end: 'string',
      start: 'string'
    },
    os_name: [],
    platform: [],
    policy_updated: [],
    protection_type: [],
    status: [],
    username: []
  },
  limit: integer,
  search: 'string',
  skip: integer,
  sort: [{
      field: 'string',
      order: 'string'
    }]
)

response = api.combined_query_agents(body)

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

CreateDestinationGroup

Create a destination group.

Method POST

Route /seraphic-enterprise-browser/entities/destination-groups/v1

Scope Secure Access: WRITE

PEP 8 create_destination_group

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

classification body · array

The classification value.

countries body · array

The countries value.

description body · string

The description value.

domains body · array

The domains value.

ips_range body · array

ipsRange body · array

IpsRange body · array

match_ips body · boolean

The match_ips value.

name body · string

The name value.

single_ips body · array

singleIps body · array

SingleIps body · array

top_level_domains body · array

The top_level_domains value.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

response = falcon.create_destination_group(classification=["string"],
                                           countries=["string"],
                                           description="string",
                                           domains=["string"],
                                           ipsRange=["string"],
                                           match_ips=boolean,
                                           name="string",
                                           singleIps=["string"],
                                           top_level_domains=["string"])
print(response)

Operation ID

from falconpy import Seraphic

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

response = falcon.CreateDestinationGroup(classification=["string"],
                                         countries=["string"],
                                         description="string",
                                         domains=["string"],
                                         ipsRange=["string"],
                                         match_ips=boolean,
                                         name="string",
                                         singleIps=["string"],
                                         top_level_domains=["string"])
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "classification": ["string"],
    "countries": ["string"],
    "description": "string",
    "domains": ["string"],
    "ips_range": ["string"],
    "match_ips": boolean,
    "name": "string",
    "single_ips": ["string"],
    "top_level_domains": ["string"]
}

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.CreateDestinationGroup(
    &seraphic_enterprise_browser.CreateDestinationGroupParams{
      Body: &models.DestinationGroup{
        Classification: []string{"string"},
        Countries: []string{"string"},
        Description: "string",
        Domains: []string{"string"},
        IpsRange: []models.Object{models.Object("string")},
        MatchIps: boolean,
        Name: &name,
        SingleIps: []string{"string"},
        TopLevelDomains: []string{"string"},
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.createDestinationGroup(
  {
    classification: [],
    countries: [],
    description: "string",
    domains: [],
    ipsRange: [],
    matchIps: boolean,
    name: "string",
    singleIps: [],
    topLevelDomains: []
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::DestinationGroup.new(
  classification: [],
  countries: [],
  description: 'string',
  domains: [],
  ips_range: [],
  match_ips: boolean,
  name: 'string',
  single_ips: [],
  top_level_domains: []
)

response = api.create_destination_group(body)

puts response

Responses

201 Created

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

DeactivateAgents

Deactivate agents by ID.

Method POST

Route /seraphic-enterprise-browser/entities/agent-deactivation/v1

Scope Secure Access: WRITE

PEP 8 deactivate_agents

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

ids body · array

The ids value.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

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

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

Operation ID

from falconpy import Seraphic

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

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

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

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "ids": ["string"]
}

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.DeactivateAgents(
    &seraphic_enterprise_browser.DeactivateAgentsParams{
      Body: &models.AgentIDsRequest{
        Ids: []string{"string"},
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.deactivateAgents(
  {
    ids: []
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::AgentIDsRequest.new(
  ids: []
)

response = api.deactivate_agents(body)

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

DeleteDestinationGroup

Delete a destination group.

Method DELETE

Route /seraphic-enterprise-browser/entities/destination-groups/v1

Scope Secure Access: WRITE

PEP 8 delete_destination_group

Parameters

id query · string

The resource ID.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

falcon = Seraphic(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_destination_group(id=id_list)
print(response)

Operation ID

from falconpy import Seraphic

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

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

response = falcon.DeleteDestinationGroup(id=id_list)
print(response)

Uber

from falconpy import APIHarnessV2

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

response = falcon.command("DeleteDestinationGroup",
                          id="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/seraphic_enterprise_browser"
)

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.SeraphicEnterpriseBrowser.DeleteDestinationGroup(
    &seraphic_enterprise_browser.DeleteDestinationGroupParams{
      ID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.deleteDestinationGroup("string");  // id

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

response = api.delete_destination_group('string')

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

DeleteUrlDomainList

Delete URLs and domains from an integration list.

Method DELETE

Route /seraphic-enterprise-browser/entities/url-domain-lists/v1

Scope Secure Access: WRITE

PEP 8 delete_url_domain_list

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

integration_id body · string

integrationId body · string

IntegrationId body · string

urls body · array

id query · string

The resource ID.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

falcon = Seraphic(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_url_domain_list(id=id_list)
print(response)

Operation ID

from falconpy import Seraphic

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

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

response = falcon.DeleteUrlDomainList(id=id_list)
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "integration_id": "string",
    "urls": ["string"]
}

response = falcon.command("DeleteUrlDomainList",
                          id="string",
                          body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  integrationID := "string"

  response, err := client.SeraphicEnterpriseBrowser.DeleteURLDomainList(
    &seraphic_enterprise_browser.DeleteURLDomainListParams{
      Body: &models.URLDomainListRequest{
        IntegrationID: &integrationID,
        Urls: []string{"string"},
      },
      ID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.deleteUrlDomainList(
  "string",  // id
  {  // body
      integrationId: "string",
      urls: []
  }
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::UrlDomainListRequest.new(
  integration_id: 'string',
  urls: []
)

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

GetAgents

Retrieve agents by ID.

Method GET

Route /seraphic-enterprise-browser/entities/agents/v1

Scope Secure Access: READ

PEP 8 get_seraphic_agents

Parameters

ids query · string or list of strings

One or more resource IDs.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

falcon = Seraphic(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_seraphic_agents(ids=id_list)
print(response)

Operation ID

from falconpy import Seraphic

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

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

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

Uber

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/seraphic_enterprise_browser"
)

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.SeraphicEnterpriseBrowser.GetAgents(
    &seraphic_enterprise_browser.GetAgentsParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.getAgents(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

GetAuditLogsMixin0

Retrieve audit log entries by ID.

Method GET

Route /seraphic-enterprise-browser/entities/audit-logs/v1

Scope Secure Access: READ

PEP 8 get_seraphic_audit_logs

Parameters

ids query · string or list of strings

One or more resource IDs.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

falcon = Seraphic(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_seraphic_audit_logs(ids=id_list)
print(response)

Operation ID

from falconpy import Seraphic

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

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

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

Uber

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/seraphic_enterprise_browser"
)

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.SeraphicEnterpriseBrowser.GetAuditLogsMixin0(
    &seraphic_enterprise_browser.GetAuditLogsMixin0Params{
      Ids: []string{"ID1", "ID2", "ID3"},
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.getAuditLogsMixin0(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

GetDestinationGroups

Retrieve destination groups by ID.

Method GET

Route /seraphic-enterprise-browser/entities/destination-groups/v1

Scope Secure Access: READ

PEP 8 get_destination_groups

Parameters

ids query · string or list of strings

One or more resource IDs.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

falcon = Seraphic(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_destination_groups(ids=id_list)
print(response)

Operation ID

from falconpy import Seraphic

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

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

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

Uber

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/seraphic_enterprise_browser"
)

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.SeraphicEnterpriseBrowser.GetDestinationGroups(
    &seraphic_enterprise_browser.GetDestinationGroupsParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.getDestinationGroups(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

GetExtensionAnalysis

Retrieve browser-extension risk analysis by store and extension ID.

Method GET

Route /seraphic-enterprise-browser/entities/extension-analysis/v1

Scope Secure Access: READ

PEP 8 get_extension_analysis

Parameters

store query · string

The extension store.

id query · string

The extension ID.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

response = falcon.get_extension_analysis(store="string", id="string")
print(response)

Operation ID

from falconpy import Seraphic

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

response = falcon.GetExtensionAnalysis(store="string", id="string")
print(response)

Uber

from falconpy import APIHarnessV2

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

response = falcon.command("GetExtensionAnalysis",
                          store="string",
                          id="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/seraphic_enterprise_browser"
)

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.SeraphicEnterpriseBrowser.GetExtensionAnalysis(
    &seraphic_enterprise_browser.GetExtensionAnalysisParams{
      Store: "string",
      ID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.getExtensionAnalysis(
  "google",  // store
  "string"  // id
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

response = api.get_extension_analysis('string', 'string')

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

GetRules

Retrieve rules by ID.

Method GET

Route /seraphic-enterprise-browser/entities/rules/v1

Scope Secure Access: READ

PEP 8 get_seraphic_rules

Parameters

ids query · string or list of strings

One or more resource IDs.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

falcon = Seraphic(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_seraphic_rules(ids=id_list)
print(response)

Operation ID

from falconpy import Seraphic

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

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

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

Uber

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/seraphic_enterprise_browser"
)

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.SeraphicEnterpriseBrowser.GetRules(
    &seraphic_enterprise_browser.GetRulesParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.getRules(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

GetTenantSettings

Retrieve Seraphic Enterprise Browser tenant settings.

Method GET

Route /seraphic-enterprise-browser/entities/tenant-settings/v1

Scope Secure Access: READ

PEP 8 get_tenant_settings

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

response = falcon.get_tenant_settings()
print(response)

Operation ID

from falconpy import Seraphic

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

response = falcon.GetTenantSettings()
print(response)

Uber

from falconpy import APIHarnessV2

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

response = falcon.command("GetTenantSettings")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/seraphic_enterprise_browser"
)

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.SeraphicEnterpriseBrowser.GetTenantSettings(
    &seraphic_enterprise_browser.GetTenantSettingsParams{
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.getTenantSettings();

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

response = api.get_tenant_settings

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

GetUrlDomainLists

Retrieve URL/domain integration lists by ID.

Method GET

Route /seraphic-enterprise-browser/entities/url-domain-lists/v1

Scope Secure Access: READ

PEP 8 get_url_domain_lists

Parameters

ids query · string or list of strings

One or more resource IDs.

skip query · integer

Number of items to skip. Default 0.

limit query · integer

Maximum items to return. Default 50.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

falcon = Seraphic(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_url_domain_lists(ids=id_list, skip=integer, limit=integer)
print(response)

Operation ID

from falconpy import Seraphic

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

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

response = falcon.GetUrlDomainLists(ids=id_list, skip=integer, limit=integer)
print(response)

Uber

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("GetUrlDomainLists",
                          ids=id_list,
                          skip=integer,
                          limit=integer)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/seraphic_enterprise_browser"
)

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)
  }

  skip := int64(0)
  limit := int64(0)

  response, err := client.SeraphicEnterpriseBrowser.GetURLDomainLists(
    &seraphic_enterprise_browser.GetURLDomainListsParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Skip: &skip,
      Limit: &limit,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.getUrlDomainLists(
  ["ID1", "ID2", "ID3"],  // ids
  integer,  // skip
  integer  // limit
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

QueryAgents

Query agent IDs by filter, sort and pagination. limit accepts up to 1000.

Method POST

Route /seraphic-enterprise-browser/queries/agents/v1

Scope Secure Access: READ

PEP 8 query_seraphic_agents

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

filter body · object

The filter value. A JSON object, not an FQL string. Every key is optional: application, application_name, application_version, browser_name, browser_version, deployment_method, email, first_seen, host_id, hostname, id, last_seen, os_name, platform, policy_updated, protection_type, status, username.

limit body · integer

The limit value.

search body · string

The search value.

skip body · integer

The skip value.

sort body · array

The sort value.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

filter = {
    "application": [
        "string"
    ],
    "first_seen": {
        "end": "string",
        "start": "string"
    }
}

sort = [
    {
        "field": "string",
        "order": "string"
    }
]

response = falcon.query_seraphic_agents(filter=filter,
                                        limit=integer,
                                        search="string",
                                        skip=integer,
                                        sort=sort)
print(response)

Operation ID

from falconpy import Seraphic

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

filter = {
    "application": [
        "string"
    ],
    "first_seen": {
        "end": "string",
        "start": "string"
    }
}

sort = [
    {
        "field": "string",
        "order": "string"
    }
]

response = falcon.QueryAgents(filter=filter,
                              limit=integer,
                              search="string",
                              skip=integer,
                              sort=sort)
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "filter": {
        "application": ["string"],
        "application_name": ["string"],
        "application_version": ["string"],
        "browser_name": ["string"],
        "browser_version": ["string"],
        "deployment_method": ["string"],
        "email": ["string"],
        "first_seen": {
            "end": "string",
            "start": "string"
        },
        "host_id": ["string"],
        "hostname": ["string"],
        "id": ["string"],
        "last_seen": {
            "end": "string",
            "start": "string"
        },
        "os_name": ["string"],
        "platform": ["string"],
        "policy_updated": ["string"],
        "protection_type": ["string"],
        "status": ["string"],
        "username": ["string"]
    },
    "limit": integer,
    "search": "string",
    "skip": integer,
    "sort": [
        {
            "field": "string",
            "order": "string"
        }
    ]
}

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.QueryAgents(
    &seraphic_enterprise_browser.QueryAgentsParams{
      Body: &models.AgentQuery{
        Filter: &models.AgentsFilter{
          Application: []string{"string"},
          ApplicationName: []string{"string"},
          ApplicationVersion: []string{"string"},
          BrowserName: []string{"string"},
          BrowserVersion: []string{"string"},
          DeploymentMethod: []string{"string"},
          Email: []string{"string"},
          FirstSeen: &models.TimeFilter{},
          HostID: []string{"string"},
          Hostname: []string{"string"},
          ID: []string{"string"},
          LastSeen: &models.TimeFilter{},
          OsName: []string{"string"},
          Platform: []string{"string"},
          PolicyUpdated: []bool{boolean},
          ProtectionType: []string{"string"},
          Status: []string{"string"},
          Username: []string{"string"},
        },
        Limit: integer,
        Search: "string",
        Skip: integer,
        Sort: []*models.AgentSort{
          {
            Field: "string",
            Order: "string",
          },
        },
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.queryAgents(
  {
    filter: {
      application: [],
      applicationName: [],
      applicationVersion: [],
      browserName: [],
      browserVersion: [],
      deploymentMethod: [],
      email: [],
      firstSeen: {
        end: "string",
        start: "string"
      },
      hostId: [],
      hostname: [],
      id: [],
      lastSeen: {
        end: "string",
        start: "string"
      },
      osName: [],
      platform: [],
      policyUpdated: [],
      protectionType: [],
      status: [],
      username: []
    },
    limit: integer,
    search: "string",
    skip: integer,
    sort: [{
        field: "status",
        order: "ASC"
      }]
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::AgentQuery.new(
  filter: {
    application: [],
    application_name: [],
    application_version: [],
    browser_name: [],
    browser_version: [],
    deployment_method: [],
    email: [],
    first_seen: {
      end: 'string',
      start: 'string'
    },
    host_id: [],
    hostname: [],
    id: [],
    last_seen: {
      end: 'string',
      start: 'string'
    },
    os_name: [],
    platform: [],
    policy_updated: [],
    protection_type: [],
    status: [],
    username: []
  },
  limit: integer,
  search: 'string',
  skip: integer,
  sort: [{
      field: 'string',
      order: 'string'
    }]
)

response = api.query_agents(body)

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

QueryDestinationGroups

Query destination groups by filter, sort and pagination.

Method POST

Route /seraphic-enterprise-browser/queries/destination-groups/v1

Scope Secure Access: READ

PEP 8 query_destination_groups

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

exclude body · array

The exclude value.

filter body · object

The filter value.

limit body · integer

The limit value.

search body · string

The search value.

skip body · integer

The skip value.

sort body · array

The sort value.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

filter = "string"

response = falcon.query_destination_groups(exclude=["string"],
                                           filter=filter,
                                           limit=integer,
                                           search="string",
                                           skip=integer,
                                           sort=["string"])
print(response)

Operation ID

from falconpy import Seraphic

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

filter = "string"

response = falcon.QueryDestinationGroups(exclude=["string"],
                                         filter=filter,
                                         limit=integer,
                                         search="string",
                                         skip=integer,
                                         sort=["string"])
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "exclude": ["string"],
    "filter": {},
    "limit": integer,
    "search": "string",
    "skip": integer,
    "sort": ["string"]
}

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

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.QueryDestinationGroups(
    &seraphic_enterprise_browser.QueryDestinationGroupsParams{
      Body: &models.DestinationGroupQuery{
        Exclude: []string{"string"},
        Filter: "string",
        Limit: integer,
        Search: "string",
        Skip: integer,
        Sort: []models.Object{models.Object("string")},
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.queryDestinationGroups(
  {
    exclude: [],
    filter: {},
    limit: integer,
    search: "string",
    skip: integer,
    sort: []
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::DestinationGroupQuery.new(
  exclude: [],
  filter: {},
  limit: integer,
  search: 'string',
  skip: integer,
  sort: []
)

response = api.query_destination_groups(body)

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

QueryRulesMixin0

Query rules within a category by filter, sort and pagination.

Method POST

Route /seraphic-enterprise-browser/queries/rules/v1

Scope Secure Access: READ

PEP 8 query_seraphic_rules

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

advanced_filter body · object

The advanced_filter value.

exclude body · array

The exclude value.

filter body · object

The filter value.

limit body · integer

The limit value.

rule_ids body · array

The rule_ids value.

search body · string

The search value.

skip body · integer

The skip value.

sort body · array

The sort value.

category query · string

The rule category to query.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

advanced_filter = "string"

filter = "string"

response = falcon.query_seraphic_rules(category="string",
                                       advanced_filter=advanced_filter,
                                       exclude=["string"],
                                       filter=filter,
                                       limit=integer,
                                       rule_ids=["string"],
                                       search="string",
                                       skip=integer,
                                       sort=["string"])
print(response)

Operation ID

from falconpy import Seraphic

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

advanced_filter = "string"

filter = "string"

response = falcon.QueryRulesMixin0(category="string",
                                   advanced_filter=advanced_filter,
                                   exclude=["string"],
                                   filter=filter,
                                   limit=integer,
                                   rule_ids=["string"],
                                   search="string",
                                   skip=integer,
                                   sort=["string"])
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "advanced_filter": {},
    "exclude": ["string"],
    "filter": {},
    "limit": integer,
    "rule_ids": ["string"],
    "search": "string",
    "skip": integer,
    "sort": ["string"]
}

response = falcon.command("QueryRulesMixin0",
                          category="string",
                          body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.QueryRulesMixin0(
    &seraphic_enterprise_browser.QueryRulesMixin0Params{
      Body: &models.RuleQuery{
        AdvancedFilter: "string",
        Exclude: []int64{integer},
        Filter: "string",
        Limit: integer,
        RuleIds: []int64{integer},
        Search: "string",
        Skip: integer,
        Sort: []models.Object{models.Object("string")},
      },
      Category: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.queryRulesMixin0(
  "general",  // category
  {  // body
      advancedFilter: {},
      exclude: [],
      filter: {},
      limit: integer,
      ruleIds: [],
      search: "string",
      skip: integer,
      sort: []
  }
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::RuleQuery.new(
  advanced_filter: {},
  exclude: [],
  filter: {},
  limit: integer,
  rule_ids: [],
  search: 'string',
  skip: integer,
  sort: []
)

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

UpdateDestinationGroup

Partial-update a destination group.

Method PATCH

Route /seraphic-enterprise-browser/entities/destination-groups/v1

Scope Secure Access: WRITE

PEP 8 update_destination_group

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

classification body · array

The classification value.

countries body · array

The countries value.

description body · string

The description value.

domains body · array

The domains value.

ips_range body · array

ipsRange body · array

IpsRange body · array

match_ips body · boolean

The match_ips value.

name body · string

The name value.

single_ips body · array

singleIps body · array

SingleIps body · array

top_level_domains body · array

The top_level_domains value.

id query · string

The resource ID.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

response = falcon.update_destination_group(id="string",
                                           classification=["string"],
                                           countries=["string"],
                                           description="string",
                                           domains=["string"],
                                           ipsRange=["string"],
                                           match_ips=boolean,
                                           name="string",
                                           singleIps=["string"],
                                           top_level_domains=["string"])
print(response)

Operation ID

from falconpy import Seraphic

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

response = falcon.UpdateDestinationGroup(id="string",
                                         classification=["string"],
                                         countries=["string"],
                                         description="string",
                                         domains=["string"],
                                         ipsRange=["string"],
                                         match_ips=boolean,
                                         name="string",
                                         singleIps=["string"],
                                         top_level_domains=["string"])
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "classification": ["string"],
    "countries": ["string"],
    "description": "string",
    "domains": ["string"],
    "ips_range": ["string"],
    "match_ips": boolean,
    "name": "string",
    "single_ips": ["string"],
    "top_level_domains": ["string"]
}

response = falcon.command("UpdateDestinationGroup",
                          id="string",
                          body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.UpdateDestinationGroup(
    &seraphic_enterprise_browser.UpdateDestinationGroupParams{
      Body: &models.DestinationGroup{
        Classification: []string{"string"},
        Countries: []string{"string"},
        Description: "string",
        Domains: []string{"string"},
        IpsRange: []models.Object{models.Object("string")},
        MatchIps: boolean,
        Name: &name,
        SingleIps: []string{"string"},
        TopLevelDomains: []string{"string"},
      },
      ID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.updateDestinationGroup(
  "string",  // id
  {  // body
      classification: [],
      countries: [],
      description: "string",
      domains: [],
      ipsRange: [],
      matchIps: boolean,
      name: "string",
      singleIps: [],
      topLevelDomains: []
  }
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::DestinationGroup.new(
  classification: [],
  countries: [],
  description: 'string',
  domains: [],
  ips_range: [],
  match_ips: boolean,
  name: 'string',
  single_ips: [],
  top_level_domains: []
)

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

---

---

UpdateRuleMixin0

Partial-update a rule (extensions, targets, destination groups, status).

Method PATCH

Route /seraphic-enterprise-browser/entities/rules/v1

Scope Secure Access: WRITE

PEP 8 update_seraphic_rule

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

add_extension_ids body · array

addExtensionIds body · array

AddExtensionIds body · array

add_extension_names body · array

addExtensionNames body · array

AddExtensionNames body · array

destinations body · object

The destinations value.

remove_extension_ids body · array

removeExtensionIds body · array

RemoveExtensionIds body · array

remove_extension_names body · array

removeExtensionNames body · array

RemoveExtensionNames body · array

status body · object

The status value.

targets body · object

The targets value.

id query · string

The resource ID.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Seraphic

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

destinations = "string"

status = "string"

targets = "string"

response = falcon.update_seraphic_rule(id="string",
                                       addExtensionIds=["string"],
                                       addExtensionNames=["string"],
                                       destinations=destinations,
                                       removeExtensionIds=["string"],
                                       removeExtensionNames=["string"],
                                       status=status,
                                       targets=targets)
print(response)

Operation ID

from falconpy import Seraphic

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

destinations = "string"

status = "string"

targets = "string"

response = falcon.UpdateRuleMixin0(id="string",
                                   addExtensionIds=["string"],
                                   addExtensionNames=["string"],
                                   destinations=destinations,
                                   removeExtensionIds=["string"],
                                   removeExtensionNames=["string"],
                                   status=status,
                                   targets=targets)
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "add_extension_ids": ["string"],
    "add_extension_names": ["string"],
    "destinations": {},
    "remove_extension_ids": ["string"],
    "remove_extension_names": ["string"],
    "status": {},
    "targets": {}
}

response = falcon.command("UpdateRuleMixin0",
                          id="string",
                          body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  response, err := client.SeraphicEnterpriseBrowser.UpdateRuleMixin0(
    &seraphic_enterprise_browser.UpdateRuleMixin0Params{
      Body: &models.RulePatch{
        AddExtensionIds: []string{"string"},
        AddExtensionNames: []string{"string"},
        Destinations: "string",
        RemoveExtensionIds: []string{"string"},
        RemoveExtensionNames: []string{"string"},
        Status: "string",
        Targets: "string",
      },
      ID: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: "us-1",
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.seraphicEnterpriseBrowser.updateRuleMixin0(
  "string",  // id
  {  // body
      addExtensionIds: [],
      addExtensionNames: [],
      destinations: {},
      removeExtensionIds: [],
      removeExtensionNames: [],
      status: {},
      targets: {}
  }
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::SeraphicEnterpriseBrowser.new

body = Falcon::RulePatch.new(
  add_extension_ids: [],
  add_extension_names: [],
  destinations: {},
  remove_extension_ids: [],
  remove_extension_names: [],
  status: {},
  targets: {}
)

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

puts response

Responses

200 OK

[
  {}
]

400 Bad request

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

403 Forbidden. Missing required scope.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

429 Too many requests

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}

500 Unexpected Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

502 Upstream service unavailable

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "meta": {
    "trace_id": "string"
  },
  "resources": [
    {}
  ]
}