Seraphic
Operations for the Seraphic service collection. Also available in FalconPy as BrowserSecurity.
| Language | Last Update |
|---|---|
| Python | v1.6.6 |
| PowerShell | |
| Go | |
| TypeScript | |
| Rust | |
| Ruby |
Table of Contents
Section titled “Table of Contents”| Operation | Description |
|---|---|
ActivateAgentsactivate_agents | Activate agents by ID. |
AddUrlDomainListadd_url_domain_list | Add URLs and domains to an integration list. |
ApplyAgentTasksapply_agent_tasks | Apply tasks to a Seraphic Enterprise Browser agent. |
ClassifyDomainsclassify_domains | Classify domains via the Seraphic Enterprise Browser classification engine. |
CombinedQueryAgentsquery_combined_seraphic_agents | Query agents and return their details in a single call. limit accepts up to 2500. |
CreateDestinationGroupcreate_destination_group | Create a destination group. |
DeactivateAgentsdeactivate_agents | Deactivate agents by ID. |
DeleteDestinationGroupdelete_destination_group | Delete a destination group. |
DeleteUrlDomainListdelete_url_domain_list | Delete URLs and domains from an integration list. |
GetAgentsget_seraphic_agents | Retrieve agents by ID. |
GetAuditLogsMixin0get_seraphic_audit_logs | Retrieve audit log entries by ID. |
GetDestinationGroupsget_destination_groups | Retrieve destination groups by ID. |
GetExtensionAnalysisget_extension_analysis | Retrieve browser-extension risk analysis by store and extension ID. |
GetRulesget_seraphic_rules | Retrieve rules by ID. |
GetTenantSettingsget_tenant_settings | Retrieve Seraphic Enterprise Browser tenant settings. |
GetUrlDomainListsget_url_domain_lists | Retrieve URL/domain integration lists by ID. |
QueryAgentsquery_seraphic_agents | Query agent IDs by filter, sort and pagination. limit accepts up to 1000. |
QueryDestinationGroupsquery_destination_groups | Query destination groups by filter, sort and pagination. |
QueryRulesMixin0query_seraphic_rules | Query rules within a category by filter, sort and pagination. |
UpdateDestinationGroupupdate_destination_group | Partial-update a destination group. |
UpdateRuleMixin0update_seraphic_rule | Partial-update a rule (extensions, targets, destination groups, status). |
ActivateAgents
Section titled “ActivateAgents”Activate agents by ID.
activate_agentsParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}AddUrlDomainList
Section titled “AddUrlDomainList”Add URLs and domains to an integration list.
add_url_domain_listParameters
Section titled “Parameters”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)from falconpy import Seraphic
falcon = Seraphic(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.AddUrlDomainList(integrationId="string", urls=["string"])print(response)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}ApplyAgentTasks
Section titled “ApplyAgentTasks”Apply tasks to a Seraphic Enterprise Browser agent.
apply_agent_tasksParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}ClassifyDomains
Section titled “ClassifyDomains”Classify domains via the Seraphic Enterprise Browser classification engine.
classify_domainsParameters
Section titled “Parameters”from falconpy import Seraphic
falcon = Seraphic(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.classify_domains(domains=["string"])print(response)from falconpy import Seraphic
falcon = Seraphic(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.ClassifyDomains(domains=["string"])print(response)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}CombinedQueryAgents
Section titled “CombinedQueryAgents”Query agents and return their details in a single call. limit accepts up to 2500.
query_combined_seraphic_agentsParameters
Section titled “Parameters”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.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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}CreateDestinationGroup
Section titled “CreateDestinationGroup”Create a destination group.
create_destination_groupParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}DeactivateAgents
Section titled “DeactivateAgents”Deactivate agents by ID.
deactivate_agentsParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}DeleteDestinationGroup
Section titled “DeleteDestinationGroup”Delete a destination group.
delete_destination_groupParameters
Section titled “Parameters”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)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)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("DeleteDestinationGroup", id="string")print(response)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}DeleteUrlDomainList
Section titled “DeleteUrlDomainList”Delete URLs and domains from an integration list.
delete_url_domain_listParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}GetAgents
Section titled “GetAgents”Retrieve agents by ID.
get_seraphic_agentsParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}GetAuditLogsMixin0
Section titled “GetAuditLogsMixin0”Retrieve audit log entries by ID.
get_seraphic_audit_logsParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}GetDestinationGroups
Section titled “GetDestinationGroups”Retrieve destination groups by ID.
get_destination_groupsParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}GetExtensionAnalysis
Section titled “GetExtensionAnalysis”Retrieve browser-extension risk analysis by store and extension ID.
get_extension_analysisParameters
Section titled “Parameters”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)from falconpy import Seraphic
falcon = Seraphic(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.GetExtensionAnalysis(store="string", id="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("GetExtensionAnalysis", store="string", id="string")print(response)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}GetRules
Section titled “GetRules”Retrieve rules by ID.
get_seraphic_rulesParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}GetTenantSettings
Section titled “GetTenantSettings”Retrieve Seraphic Enterprise Browser tenant settings.
get_tenant_settingsfrom falconpy import Seraphic
falcon = Seraphic(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.get_tenant_settings()print(response)from falconpy import Seraphic
falcon = Seraphic(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.GetTenantSettings()print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("GetTenantSettings")print(response)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}GetUrlDomainLists
Section titled “GetUrlDomainLists”Retrieve URL/domain integration lists by ID.
get_url_domain_listsParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}QueryAgents
Section titled “QueryAgents”Query agent IDs by filter, sort and pagination. limit accepts up to 1000.
query_seraphic_agentsParameters
Section titled “Parameters”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.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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}QueryDestinationGroups
Section titled “QueryDestinationGroups”Query destination groups by filter, sort and pagination.
query_destination_groupsParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}QueryRulesMixin0
Section titled “QueryRulesMixin0”Query rules within a category by filter, sort and pagination.
query_seraphic_rulesParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}UpdateDestinationGroup
Section titled “UpdateDestinationGroup”Partial-update a destination group.
update_destination_groupParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}UpdateRuleMixin0
Section titled “UpdateRuleMixin0”Partial-update a rule (extensions, targets, destination groups, status).
update_seraphic_ruleParameters
Section titled “Parameters”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)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)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)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
[ {}]{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}{ "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 } }}{ "errors": [ { "code": 0, "message": "string" } ], "meta": { "trace_id": "string" }, "resources": [ {} ]}