Skip to content

Tailored Intelligence

The Tailored Intelligence service collection provides operations for accessing events and rules data. Retrieve event body content, fetch event and rule entities by ID, and query events or rules using FQL-formatted filter criteria.

LanguageLast Update
Pythonv1.6.5
PowerShellv2.2.9
Gov0.22.0
TypeScriptv0.6.0
Rustv0.7.1
Rubyv1.4.0


OperationDescription
GetEventsBody
get_event_body
Get event body for the provided event ID
GetEventsEntities
get_event_entities
Get events entities for specified ids.
GetRulesEntities
get_rule_entities
Get rules entities for specified ids.
QueryEvents
query_events
Get events ids that match the provided filter criteria.
QueryRules
query_rules
Get rules ids that match the provided filter criteria.

Get event body for the provided event ID

Method GET
Route /ti/events/entities/events-full-body/v2
Scope Tailored Intelligence: READ
PEP 8 get_event_body
id query · string
Return the event body for event id.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Authorization body · string
Bearer Token.
from falconpy import TailoredIntelligence
falcon = TailoredIntelligence(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("output_file", "wb") as save_file:
response = falcon.get_event_body(id="string",
Authorization="string",
stream=boolean)
save_file.write(response)
{
"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
}
}
}


Get events entities for specified ids.

Method POST
Route /ti/events/entities/events/GET/v2
Scope Tailored Intelligence: READ
PEP 8 get_event_entities
body body · dictionary
Full body payload as JSON formatted dictionary.
ids body · array
Event ID to retrieve.
Authorization body · string
Bearer Token.
from falconpy import TailoredIntelligence
falcon = TailoredIntelligence(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_event_entities(ids=id_list, Authorization="string")
print(response)
[
{
"body": "string",
"body_is_truncated": false,
"body_link": "string",
"botnet_config_source": {},
"created_date": "string",
"ddos_attack_source": {},
"event_type": "string",
"fingerprint": "string",
"id": "string",
"matched_rules": [],
"pastebin_text_source": {},
"tags": [],
"tweet_source": {},
"updated_date": "string"
}
]


Get rules entities for specified ids.

Method POST
Route /ti/rules/entities/rules/GET/v2
Scope Tailored Intelligence: READ
PEP 8 get_rule_entities
body body · dictionary
Full body payload as JSON formatted dictionary.
ids body · array
Rule ID to retrieve.
Authorization body · string
Bearer Token.
from falconpy import TailoredIntelligence
falcon = TailoredIntelligence(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_rule_entities(ids=id_list, Authorization="string")
print(response)
[
{
"created_date": 0,
"description": "string",
"id": 0,
"last_modified_date": 0,
"name": "string",
"rich_text_description": "string",
"short_description": "string",
"tags": [],
"type": "string"
}
]


Get events ids that match the provided filter criteria.

Method GET
Route /ti/events/queries/events/v2
Scope Tailored Intelligence: READ
PEP 8 query_events
offset query · string
Starting index of overall result set from which to return ids.
limit query · integer
Number of ids to return.
sort query · string
Possible order by fields:
Available values (3)
source_typecreated_dateupdated_date
filter query · string
FQL query specifying the filter parameters. Wildcard character ’*’ means to not filter on anything.
q query · string
Match phrase_prefix query criteria; included fields: _all (all filter string fields indexed).
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Authorization body · string
Bearer Token.
from falconpy import TailoredIntelligence
falcon = TailoredIntelligence(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_events(filter="string",
limit=integer,
offset="string",
Authorization="string",
q="string",
sort="string")
print(response)
[
"string"
]


Get rules ids that match the provided filter criteria.

Method GET
Route /ti/rules/queries/rules/v2
Scope Tailored Intelligence: READ
PEP 8 query_rules
offset query · string
Starting index of overall result set from which to return ids.
limit query · integer
Number of ids to return.
sort query · string
Possible order by fields:
Available values (6)
namevaluerule_type
customer_idcreated_dateupdated_date
filter query · string
FQL query specifying the filter parameters. Wildcard character ’*’ means to not filter on anything.
q query · string
Match phrase_prefix query criteria; included fields: _all (all filter string fields indexed).
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Authorization body · string
Bearer Token.
from falconpy import TailoredIntelligence
falcon = TailoredIntelligence(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_rules(filter="string",
limit=integer,
offset="string",
Authorization="string",
q="string",
sort="string")
print(response)
[
"string"
]