Skip to content

Seraphic

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

LanguageLast Update
Pythonv1.6.6
PowerShell
Go
TypeScript
Rust
Ruby

OperationDescription
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).

Activate agents by ID.

Method POST
Route /seraphic-enterprise-browser/entities/agent-activation/v1
Scope Secure Access: WRITE
PEP 8 activate_agents
body body · dictionary
Full body payload as JSON formatted dictionary.
ids body · array
The ids value.
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)
[
{}
]


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
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.
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)
[
{}
]


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
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.
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)
{
"errors": [
{
"code": 0,
"message": "string"
}
],
"meta": {
"trace_id": "string"
},
"resources": [
{}
]
}


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
body body · dictionary
Full body payload as JSON formatted dictionary.
domains body · array
The domains value.
from falconpy import Seraphic
falcon = Seraphic(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.classify_domains(domains=["string"])
print(response)
[
{}
]


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
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.
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)
[
{}
]


Create a destination group.

Method POST
Route /seraphic-enterprise-browser/entities/destination-groups/v1
Scope Secure Access: WRITE
PEP 8 create_destination_group
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.
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)
[
{}
]


Deactivate agents by ID.

Method POST
Route /seraphic-enterprise-browser/entities/agent-deactivation/v1
Scope Secure Access: WRITE
PEP 8 deactivate_agents
body body · dictionary
Full body payload as JSON formatted dictionary.
ids body · array
The ids value.
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)
[
{}
]


Delete a destination group.

Method DELETE
Route /seraphic-enterprise-browser/entities/destination-groups/v1
Scope Secure Access: WRITE
PEP 8 delete_destination_group
id query · string
The resource ID.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
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)
[
{}
]


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
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.
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)
[
{}
]


Retrieve agents by ID.

Method GET
Route /seraphic-enterprise-browser/entities/agents/v1
Scope Secure Access: READ
PEP 8 get_seraphic_agents
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.
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)
[
{}
]


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
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.
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)
[
{}
]


Retrieve destination groups by ID.

Method GET
Route /seraphic-enterprise-browser/entities/destination-groups/v1
Scope Secure Access: READ
PEP 8 get_destination_groups
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.
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)
[
{}
]


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
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.
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)
[
{}
]


Retrieve rules by ID.

Method GET
Route /seraphic-enterprise-browser/entities/rules/v1
Scope Secure Access: READ
PEP 8 get_seraphic_rules
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.
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)
[
{}
]


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
from falconpy import Seraphic
falcon = Seraphic(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_tenant_settings()
print(response)
[
{}
]


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
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.
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)
[
{}
]


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
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.
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)
[
{}
]


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
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.
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)
[
{}
]


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
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.
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)
[
{}
]


Partial-update a destination group.

Method PATCH
Route /seraphic-enterprise-browser/entities/destination-groups/v1
Scope Secure Access: WRITE
PEP 8 update_destination_group
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.
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)
[
{}
]


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
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.
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)
[
{}
]