Skip to content

Case Management

The Case Management service collection provides operations for managing security cases and workflows. Create, update, assign, and query cases, as well as manage case activities, attachments, and status transitions.

LanguageLast Update
Pythonv1.5.5
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
aggregates_file_details_post_v1
aggregates_file_details_post_v1
Get file details aggregates as specified via json in the request body.
combined_file_details_get_v1
query_file_details
Query file details
entities_files_upload_post_v1
upload_file
Upload file for case
entities_file_details_patch_v1
update_file_details
Update file details
entities_file_details_get_v1
get_file_details
Get file details by id
entities_files_bulk_download_post_v1
bulk_download_files
Download multiple existing file from case as a ZIP
entities_files_download_get_v1
download_existing_files
Download existing file from case
entities_files_delete_v1
delete_file_details
Delete file details by id
queries_file_details_get_v1
query_file_detail_ids
Query for ids of file details
entities_get_rtr_file_metadata_post_v1
get_rtr_file_metadata
Get metadata for a file via RTR without retrieving it.
entities_retrieve_rtr_file_post_v1
retrieve_rtr_file
Retrieve a file from host using RTR and add it to a case.
entities_retrieve_rtr_recent_file_post_v1
retrieve_rtr_recent_file
Retrieve a recently fetched RTR file and add it to a case.
aggregates_notification_groups_post_v1
get_notification_groups_aggregation
Get notification groups aggregations
aggregates_notification_groups_post_v2
get_notification_groups_aggregation_v2
Get notification groups aggregations
aggregates_slas_post_v1
get_sla_aggregations
Get SLA aggregations
aggregates_templates_post_v1
get_template_aggregations
Get templates aggregations
aggregates_access_tags_post_v1
get_access_tag_aggregations
Get access tag aggregates.
entities_access_tags_get_v1
get_access_tags
Get access tags.
entities_notification_groups_get_v1
get_notification_groups
Get notification groups by ID
entities_notification_groups_post_v1
create_notification_group
Create notification group
entities_notification_groups_patch_v1
update_notification_group
Update notification group
entities_notification_groups_delete_v1
delete_notification_group
Delete notification groups by ID
entities_notification_groups_get_v2
get_notification_groups_v2
Get notification groups by ID
entities_notification_groups_post_v2
create_notification_group_v2
Create notification group
entities_notification_groups_patch_v2
update_notification_group_v2
Update notification group
entities_notification_groups_delete_v2
delete_notification_group_v2
Delete notification groups by ID
entities_fields_get_v1
get_fields
Get fields by ID
entities_slas_get_v1
get_slas
Get SLAs by ID
entities_slas_post_v1
create_sla
Create SLA
entities_slas_patch_v1
update_sla
Update SLA
entities_slas_delete_v1
delete_sla
Delete SLAs
entities_template_snapshots_get_v1
get_template_snapshots
Get template snapshots
entities_templates_export_get_v1
export_templates
Export templates to files in a zip archive
entities_templates_import_post_v1
import_template
Import a template from a file
entities_templates_get_v1
get_templates
Get templates by ID
entities_templates_post_v1
create_template
Create template
entities_templates_patch_v1
update_template
Update template
entities_templates_delete_v1
delete_templates
Delete templates
queries_access_tags_get_v1
query_access_tags
Query access tags.
queries_fields_get_v1
query_fields
Query fields
queries_notification_groups_get_v1
query_notification_groups
Query notification groups
queries_notification_groups_get_v2
query_notification_groups_v2
Query notification groups
queries_slas_get_v1
query_slas
Query SLAs
queries_template_snapshots_get_v1
query_template_snapshots
Query template snapshots
queries_templates_get_v1
query_templates
Query templates
entities_alert_evidence_post_v1
add_case_alert_evidence
Adds the given list of alert evidence to the specified case.
entities_case_tags_post_v1
add_case_tags
Adds the given list of tags to the specified case.
entities_case_tags_delete_v1
delete_case_tags
Removes the specified tags from the specified case.
entities_cases_put_v2
create_case
Creates the given Case
entities_cases_post_v2
get_cases
Retrieves all Cases given their IDs.
entities_cases_patch_v2
update_case_fields
Updates given fields on the specified case.
entities_event_evidence_post_v1
add_case_event_evidence
Adds the given list of event evidence to the specified case.
queries_cases_get_v1
query_case_ids
Retrieves all Cases IDs that match a given query.

Get file details aggregates as specified via json in the request body.

POST /case-files/aggregates/file-details/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 aggregates_file_details_post_v1
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
filterquerystringFQL filter expression.
idsquerystring or list of stringsResource IDs.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.aggregates_file_details_post_v1(ids=id_list, filter="string")
print(response)

Query file details

GET /case-files/combined/file-details/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_file_details
NameTypeData typeDescription
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 10.
offsetqueryintegerPage offset.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_file_details(filter="string",
limit=integer,
offset=integer)
print(response)

Upload file for case

POST /case-files/entities/files/upload/v1
Scope Case Templates: WRITE Consumes · Produces multipart/form-data application/json
PEP 8 upload_file
NameTypeData typeDescription
case_idformDatastringCase ID for the file.
descriptionformDatastringDescription of the file.
fileformDatafileLocal file to Upload.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.upload_file(file="string",
description="string",
case_id="string")
print(response)

Update file details

PATCH /case-files/entities/file-details/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 update_file_details
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
descriptionbodystringFile details description.
idbodystringFile details ID.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.update_file_details(description="string", id="string")
print(response)

Get file details by id

GET /case-files/entities/file-details/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_file_details
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_file_details(ids=id_list)
print(response)

Download multiple existing file from case as a ZIP

POST /case-files/entities/files/bulk-download/v1
Scope Case Templates: READ Consumes · Produces application/json application/octet-stream
PEP 8 bulk_download_files
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
idsbodystring or list of stringsList of files to download.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.bulk_download_files(ids=id_list)
print(response)

Download existing file from case

GET /case-files/entities/files/download/v1
Scope Case Templates: READ Consumes · Produces application/octet-stream
PEP 8 download_existing_files
NameTypeData typeDescription
idquerystringResource ID.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.download_existing_files(id="string")
print(response)

Delete file details by id

DELETE /case-files/entities/files/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 delete_file_details
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_file_details(ids=id_list)
print(response)

Query for ids of file details

GET /case-files/queries/file-details/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_file_detail_ids
NameTypeData typeDescription
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 10.
offsetqueryintegerPage offset.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_file_detail_ids(filter="string",
limit=integer,
offset=integer)
print(response)

Get metadata for a file via RTR without retrieving it.

POST /case-files/entities/get-rtr-file-metadata/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_rtr_file_metadata
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
aidbodystringThe agent ID of the host to retrieve file metadata from.
file_pathbodystringThe path to the file on the host.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_rtr_file_metadata(aid="string", file_path="string")
print(response)

Retrieve a file from host using RTR and add it to a case.

POST /case-files/entities/retrieve-rtr-file/v1
Consumes · Produces application/json
PEP 8 retrieve_rtr_file
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
aidbodystringThe agent ID of the host to retrieve the file from.
case_idbodystringThe ID of the case to add the file to.
descriptionbodystringA description of the file being retrieved.
file_pathbodystringThe path to the file on the host.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.retrieve_rtr_file(aid="string",
case_id="string",
description="string",
file_path="string")
print(response)

Retrieve a recently fetched RTR file and add it to a case.

POST /case-files/entities/retrieve-rtr-recent-file/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 retrieve_rtr_recent_file
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
aidbodystringThe agent ID of the host.
case_idbodystringThe ID of the case to add the file to.
descriptionbodystringA description of the file being retrieved.
session_idbodystringThe RTR session ID for the file retrieval.
sha256bodystringThe SHA256 hash of the file to retrieve.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.retrieve_rtr_recent_file(aid="string",
case_id="string",
description="string",
session_id="string",
sha256="string")
print(response)

Get notification groups aggregations

POST /casemgmt/aggregates/notification-groups/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_notification_groups_aggregation
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
date_rangesbodydictionary or listDate range timeframe.
fieldbodystringField to retrieve.
filterbodystringFQL syntax.
frombodyinteger
namebodystring
sizebodyinteger
sortbodystringField to sort on.
typebodystring
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "string",
"to": "string"
}
]
response = falcon.get_notification_groups_aggregation(date_ranges=date_ranges,
field="string",
filter="string",
from=integer,
name="string",
size=integer,
sort="string",
type="string")
print(response)

Get notification groups aggregations

POST /casemgmt/aggregates/notification-groups/v2
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_notification_groups_aggregation_v2
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
date_rangesbodydictionary or listDate range timeframe.
fieldbodystringField to retrieve.
filterbodystringFQL syntax.
frombodyinteger
namebodystring
sizebodyinteger
sortbodystringField to sort on.
typebodystring
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "string",
"to": "string"
}
]
response = falcon.get_notification_groups_aggregation_v2(date_ranges=date_ranges,
field="string",
filter="string",
from=integer,
name="string",
size=integer,
sort="string",
type="string")
print(response)

Get SLA aggregations

POST /casemgmt/aggregates/slas/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_sla_aggregations
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
date_rangesbodydictionary or listDate range timeframe.
fieldbodystringField to retrieve.
filterbodystringFQL syntax.
frombodyinteger
namebodystring
sizebodyinteger
sortbodystringField to sort on.
typebodystring
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "string",
"to": "string"
}
]
response = falcon.get_sla_aggregations(date_ranges=date_ranges,
field="string",
filter="string",
from=integer,
name="string",
size=integer,
sort="string",
type="string")
print(response)

Get templates aggregations

POST /casemgmt/aggregates/templates/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_template_aggregations
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
date_rangesbodydictionary or listDate range timeframe.
fieldbodystringField to retrieve.
filterbodystringFQL syntax.
frombodyinteger
namebodystring
sizebodyinteger
sortbodystringField to sort on.
typebodystring
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "string",
"to": "string"
}
]
response = falcon.get_template_aggregations(date_ranges=date_ranges,
field="string",
filter="string",
from=integer,
name="string",
size=integer,
sort="string",
type="string")
print(response)

Get access tag aggregates.

POST /casemgmt/aggregates/access-tags/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_access_tag_aggregations
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
date_rangesbodydictionary or listDate range timeframe.
fieldbodystringField to retrieve.
filterbodystringFQL syntax.
frombodyinteger
namebodystring
sizebodyinteger
sortbodystringField to sort on.
typebodystring
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "string",
"to": "string"
}
]
response = falcon.get_access_tag_aggregations(date_ranges=date_ranges,
field="string",
filter="string",
from=integer,
name="string",
size=integer,
sort="string",
type="string")
print(response)

Get access tags.

GET /casemgmt/entities/access-tags/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_access_tags
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_access_tags(ids=id_list, with_has_access=boolean)
print(response)

Get notification groups by ID

GET /casemgmt/entities/notification-groups/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_notification_groups
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_notification_groups(ids=id_list)
print(response)

Create notification group

POST /casemgmt/entities/notification-groups/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 create_notification_group
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
channelsbodylist of dictionariesThe notification group channel configuration parameters.
descriptionbodystringNotification group description.
namebodystringNotification group name.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
channels = [
{
"config_id": "string",
"config_name": "string",
"recipients": [
"string"
],
"severity": "string",
"type": "email"
}
]
response = falcon.create_notification_group(channels=channels,
description="string",
name="string")
print(response)

Update notification group

PATCH /casemgmt/entities/notification-groups/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 update_notification_group
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
channelsbodylist of dictionariesThe notification group channel configuration parameters.
descriptionbodystringNotification group description.
idbodystringThe ID of the notification group.
namebodystringNotification group name.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
channels = [
{
"config_id": "string",
"config_name": "string",
"recipients": [
"string"
],
"severity": "string",
"type": "email"
}
]
response = falcon.update_notification_group(channels=channels,
description="string",
id="string",
name="string")
print(response)

Delete notification groups by ID

DELETE /casemgmt/entities/notification-groups/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 delete_notification_group
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_notification_group(ids=id_list)
print(response)

Get notification groups by ID

GET /casemgmt/entities/notification-groups/v2
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_notification_groups_v2
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_notification_groups_v2(ids=id_list)
print(response)

Create notification group

POST /casemgmt/entities/notification-groups/v2
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 create_notification_group_v2
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
channelsbodylist of dictionariesThe notification group channel configuration parameters.
descriptionbodystringNotification group description.
namebodystringNotification group name.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
channels = [
{
"config_id": "string",
"config_name": "string",
"params": {},
"type": "email"
}
]
response = falcon.create_notification_group_v2(channels=channels,
description="string",
name="string")
print(response)

Update notification group

PATCH /casemgmt/entities/notification-groups/v2
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 update_notification_group_v2
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
channelsbodylist of dictionariesThe notification group channel configuration parameters.
descriptionbodystringNotification group description.
namebodystringNotification group name.
idbodystringThe ID of the notification group.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
channels = [
{
"config_id": "string",
"config_name": "string",
"params": {},
"type": "email"
}
]
response = falcon.update_notification_group_v2(channels=channels,
description="string",
id="string",
name="string")
print(response)

Delete notification groups by ID

DELETE /casemgmt/entities/notification-groups/v2
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 delete_notification_group_v2
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_notification_group_v2(ids=id_list)
print(response)

Get fields by ID

GET /casemgmt/entities/fields/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_fields
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_fields(ids=id_list)
print(response)

Get SLAs by ID

GET /casemgmt/entities/slas/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_slas
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_slas(ids=id_list)
print(response)

Create SLA

POST /casemgmt/entities/slas/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 create_sla
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
descriptionbodystringThe description of the SLA.
goalsbodylist of dictionariesThe SLA goals.
namebodystringThe name of the SLA.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
goals = [
{
"duration_seconds": 0,
"escalation_policy": {
"steps": [
{
"escalate_after_seconds": 0,
"notification_group_id": "string"
}
]
},
"type": "string"
}
]
response = falcon.create_sla(description="string", goals=goals, name="string")
print(response)

Update SLA

PATCH /casemgmt/entities/slas/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 update_sla
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
descriptionbodystringThe description of the SLA.
goalsbodylist of dictionariesThe SLA goals.
idbodystringThe ID of the SLA to update.
namebodystringThe name of the SLA.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
goals = [
{
"duration_seconds": 0,
"escalation_policy": {
"steps": [
{
"escalate_after_seconds": 0,
"notification_group_id": "string"
}
]
},
"type": "string"
}
]
response = falcon.update_sla(description="string", goals=goals, name="string")
print(response)

Delete SLAs

DELETE /casemgmt/entities/slas/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 delete_sla
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_sla(ids=id_list)
print(response)

Get template snapshots

GET /casemgmt/entities/template-snapshots/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_template_snapshots
NameTypeData typeDescription
idsquerystring or list of stringsSnapshot IDs.
template_idsquerystring or list of stringsRetrieves the latest snapshot for all Template IDs.
versionsqueryinteger or list of integersRetrieve a specific version of the template from the parallel array template_ids. A value of zero will return the latest snapshot.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_template_snapshots(ids=id_list,
template_ids=id_list,
versions="string")
print(response)

Export templates to files in a zip archive

GET /casemgmt/entities/templates/export/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 export_templates
NameTypeData typeDescription
idsquerystring or list of stringsTemplate IDs.
filterquerystringFQL filter expression.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.export_templates(ids=id_list,
filter="string",
format="string")
print(response)

Import a template from a file

POST /casemgmt/entities/templates/import/v1
Scope Case Templates: WRITE Consumes · Produces multipart/form-data application/json
PEP 8 import_template
NameTypeData typeDescription
fileformDatafileLocal file to import.
dry_runformDatabooleanRun validation only.
dataformDatadictionaryFull formData payload as a dictionary. Not required when using other keywords.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.import_template(file="string", dry_run=boolean)
print(response)

Get templates by ID

GET /casemgmt/entities/templates/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_templates
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_templates(ids=id_list, with_has_access=boolean)
print(response)

Create template

POST /casemgmt/entities/templates/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 create_template
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
descriptionbodystringTemplate description.
fieldsbodylist of dictionariesTemplate fields configuration.
namebodystringTemplate name.
sla_idbodystringSLA ID for the template.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
fields = [
{
"data_type": "string",
"default_value": "string",
"input_type": "string",
"multivalued": true,
"name": "string",
"options": [
{
"value": "string"
}
],
"required": true
}
]
response = falcon.create_template(description="string",
fields=fields,
name="string",
sla_id="string")
print(response)

Update template

PATCH /casemgmt/entities/templates/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 update_template
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
fieldsbodylist of dictionariesThe template fields configuration.
descriptionbodystringTemplate description.
idbodystringThe ID of the template to update.
sla_idbodystringThe ID of the SLA.
namebodystringTemplate name.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
fields = [
{
"data_type": "string",
"default_value": "string",
"id": "string",
"input_type": "string",
"multivalued": true,
"name": "string",
"options": [
{
"id": "string",
"value": "string"
}
],
"required": true
}
]
response = falcon.update_template(description="string",
fields=fields,
id="string",
name="string",
sla_id="string")
print(response)

Delete templates

DELETE /casemgmt/entities/templates/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 delete_templates
NameTypeData typeDescription
idsquerystring or list of stringsResource IDs.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_templates(ids=id_list)
print(response)

Query access tags.

GET /casemgmt/queries/access-tags/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_access_tags
NameTypeData typeDescription
afterquerystringPagination token.
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 200.
sortquerystringSort expression.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_access_tags(filter="string",
sort="string",
limit=integer,
after="string")
print(response)

Query fields

GET /casemgmt/queries/fields/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_fields
NameTypeData typeDescription
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 200.
offsetqueryintegerPage offset.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_fields(filter="string", limit=integer, offset=integer)
print(response)

Query notification groups

GET /casemgmt/queries/notification-groups/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_notification_groups
NameTypeData typeDescription
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 200.
offsetqueryintegerPage offset.
sortquerystringSort expression.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_notification_groups(filter="string",
sort="string",
limit=integer,
offset=integer)
print(response)

Query notification groups

GET /casemgmt/queries/notification-groups/v2
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_notification_groups_v2
NameTypeData typeDescription
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 200.
offsetqueryintegerPage offset.
sortquerystringSort expression.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_notification_groups_v2(filter="string",
sort="string",
limit=integer,
offset=integer)
print(response)

Query SLAs

GET /casemgmt/queries/slas/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_slas
NameTypeData typeDescription
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 200.
offsetqueryintegerPage offset.
sortquerystringSort expression.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_slas(filter="string",
sort="string",
limit=integer,
offset=integer)
print(response)

Query template snapshots

GET /casemgmt/queries/template-snapshots/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_template_snapshots
NameTypeData typeDescription
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 200.
offsetqueryintegerPage offset.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_template_snapshots(filter="string",
limit=integer,
offset=integer)
print(response)

Query templates

GET /casemgmt/queries/templates/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_templates
NameTypeData typeDescription
filterquerystringFQL filter expression.
limitqueryintegerPage size. Maximum value is 200.
offsetqueryintegerPage offset.
sortquerystringSort expression.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_templates(filter="string",
sort="string",
limit=integer,
offset=integer)
print(response)

Adds the given list of alert evidence to the specified case.

POST /cases/entities/alert-evidence/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 add_case_alert_evidence
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
alertsbodylist of dictionariesThe alert IDs.
idbodystringThe specified case ID.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.add_case_alert_evidence(alerts="string", id="string")
print(response)

Adds the given list of tags to the specified case.

POST /cases/entities/case-tags/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 add_case_tags
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
tagsbodyarray of stringsThe given list of tags.
idbodystringThe specified case ID.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.add_case_tags(id="string", tags=["string"])
print(response)

Removes the specified tags from the specified case.

DELETE /cases/entities/case-tags/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 delete_case_tags
NameTypeData typeDescription
idquerystringThe ID of the case to remove tags from.
tagquerystring or list of stringsThe tag to remove from the case.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(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_case_tags(id="string", tag=id_list)
print(response)

Creates the given Case

PUT /cases/entities/cases/v2
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 create_case
NameTypeData typeDescription
bodybodydictionaryFull body payload as a dictionary. Not required if using other keywords.
assigned_to_user_uuidbodystringUUID of the user to assign the case to.
descriptionbodystringThe description of the case.
evidencebodydictionaryThe case evidence info.
namebodystringThe name of the case.
severitybodyintegerThe severity level of the case.
statusbodystringThe current status of the case.
tagsbodylist of stringsThe tags to be attached to the case.
templatebodydictionaryThe template case to utilize.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
evidence = {
"alerts": [
{
"id": "string"
}
],
"events": [
{
"id": "string"
}
],
"leads": [
{
"id": "string"
}
]
}
template = {
"id": "string"
}
response = falcon.create_case(assigned_to_user_uuid="string",
description="string",
evidence=evidence,
name="string",
severity=integer,
status="string",
tags=["string"],
template=template)
print(response)

Retrieves all Cases given their IDs.

POST /cases/entities/cases/v2
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 get_cases
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
idsbodystring or list of stringsThe case IDs.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_cases(ids=["string"])
print(response)

Updates given fields on the specified case.

PATCH /cases/entities/cases/v2
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 update_case_fields
NameTypeData typeDescription
bodybodydictionaryFull body payload as a dictionary. Not required if using other keywords.
expected_consistency_versionbodyintegerThe consistency version.
expected_versionbodyintegerThe version.
fieldsbodydictionaryThe updated given fields for the specified case.
idbodystringThe specified case ID.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
fields = {
"assigned_to_user_uuid": "string",
"custom_fields": [
{
"id": "string",
"values": [
"string"
]
}
],
"description": "string",
"name": "string",
"remove_user_assignment": true,
"severity": 0,
"slas_active": true,
"status": "string",
"template": {
"id": "string"
}
}
response = falcon.update_case_fields(expected_consistency_version=integer,
expected_version=integer,
fields=fields,
id="string")
print(response)

Adds the given list of event evidence to the specified case.

POST /cases/entities/event-evidence/v1
Scope Case Templates: WRITE Consumes · Produces application/json
PEP 8 add_case_event_evidence
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format
eventsbodylist of dictionariesThe event evidence field.
idbodystringThe specified case id.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
events = [
{
"id": "string"
}
]
response = falcon.add_case_event_evidence(events=events, id="string")
print(response)

Retrieves all Cases IDs that match a given query.

GET /cases/queries/cases/v1
Scope Case Templates: READ Consumes · Produces application/json
PEP 8 query_case_ids
NameTypeData typeDescription
filterquerystringFilter Cases using a query in Falcon Query Language (FQL). Filter fields can be any keyword field that is part of #domain.Case. An asterisk wildcard * includes all results. Empty value means to not filter on anything. Most commonly used filter fields that supports exact match: cid, id. Most commonly used filter fields that supports wildcard (*): assigned_to_name, assigned_to_uuid. Most commonly filter fields that supports range comparisons (>, <, >=, <=): created_timestamp, updated_timestamp. All filter fields and operations support negation (!). The full list of valid filter options is extensive. Review it in our documentation inside the Falcon console.
limitqueryintegerThe maximum number of Cases to return in this response (default: 100; max: 10000). Use this parameter together with the offset parameter to manage pagination of the results.
offsetqueryintegerThe first case to return, where 0 is the latest case. Use with the offset parameter to manage pagination of results.
qquerystringSearch all Case metadata for the provided string.
sortquerystringSort parameter takes the form <field|direction>. Direction can be either asc (ascending) or desc (descending) order. For example: status|asc or status|desc. The sorting fields can be any keyword field that is part of #domain.Case except for the text based fields. Most commonly used fields are status, cid, created_timestamp, updated_timestamp, assigned_to_name, assigned_to_userid, assigned_to_uuid, tags. If the fields are missing from the Cases, the service will fallback to its default ordering.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CaseManagement
falcon = CaseManagement(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_case_ids(limit=integer,
offset=integer,
sort="string",
filter="string",
q="string")
print(response)