Using the Message Center service collection
Table of Contents
Operation ID | Description | ||||
---|---|---|---|---|---|
| Retrieve aggregate case values based on the matched filter | ||||
| Retrieve activities for given id's | ||||
| Add an activity to case. Only activities of type comment are allowed via API | ||||
| retrieves an attachment for the case, given the attachment id | ||||
| Upload an attachment for the case. | ||||
| create a new case | ||||
| create a new case | ||||
| update an existing case | ||||
| Retrieve message center cases | ||||
| Retrieve activities id's for a case | ||||
| Retrieve case id's that match the provided filter criteria |
Passing credentials
WARNING
client_id
andclient_secret
are keyword arguments that contain your CrowdStrike API credentials. Please note that all examples below do not hard code these values. (These values are ingested as strings.)CrowdStrike does not recommend hard coding API credentials or customer identifiers within source code.
AggregateCases
Retrieve aggregate case values based on the matched filter
PEP8 method name
aggregate_cases
Endpoint
Method | Route |
---|---|
/message-center/aggregates/cases/GET/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
body | body | list of dictionaries | Full body payload in JSON format. | ||
date_ranges | body | list of dictionaries | Applies to date_range aggregations. Example: [ { "from": "2016-05-28T09:00:31Z", "to": "2016-05-30T09:00:31Z" }, { "from": "2016-06-01T09:00:31Z", "to": "2016-06-10T09:00:31Z" } ] | ||
field | body | string | The field on which to compute the aggregation. | ||
filter | body | string | FQL syntax formatted string to use to filter the results. | ||
interval | body | string | Time interval for date histogram aggregations. Valid values include:
| ||
min_doc_count | body | integer | Only return buckets if values are greater than or equal to the value here. | ||
missing | body | string | Missing is the value to be used when the aggregation field is missing from the object. In other words, the missing parameter defines how documents that are missing a value should be treated. By default they will be ignored, but it is also possible to treat them as if they had a value. | ||
name | body | string | Name of the aggregate query, as chosen by the user. Used to identify the results returned to you. | ||
q | body | string | Full text search across all metadata fields. | ||
ranges | body | list of dictionaries | Applies to range aggregations. Ranges values will depend on field. For example, if max_severity is used, ranges might look like: [ { "From": 0, "To": 70 }, { "From": 70, "To": 100 } ] | ||
size | body | integer | The max number of term buckets to be returned. | ||
sub_aggregates | body | list of dictionaries | A nested aggregation, such as: [ { "name": "max_first_behavior", "type": "max", "field": "first_behavior" } ] There is a maximum of 3 nested aggregations per request. | ||
sort | body | string | FQL syntax string to sort bucket results.
asc and desc using | format. Example: _count|desc | ||
time_zone | body | string | Time zone for bucket results. | ||
type | body | string | Type of aggregation. Valid values include:
|
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "2021-05-15T14:55:21.892315096Z",
"to": "2021-05-17T13:42:16.493180643Z"
}
]
ranges = [
{
"From": 1,
"To": 100
}
]
response = falcon.aggregate_cases(date_ranges=date_ranges,
field="string",
filter="string",
interval="string",
min_doc_count=integer,
missing="string",
name="string",
q="string",
ranges=ranges,
size=integer,
sort="string",
time_zone="string",
type="string"
)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "2021-05-15T14:55:21.892315096Z",
"to": "2021-05-17T13:42:16.493180643Z"
}
]
ranges = [
{
"From": 1,
"To": 100
}
]
response = falcon.AggregateCases(date_ranges=date_ranges,
field="string",
filter="string",
interval="string",
min_doc_count=integer,
missing="string",
name="string",
q="string",
ranges=ranges,
size=integer,
sort="string",
time_zone="string",
type="string"
)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
date_ranges = [
{
"from": "2021-05-15T14:55:21.892315096Z",
"to": "2021-05-17T13:42:16.493180643Z"
}
]
ranges = [
{
"From": 1,
"To": 100
}
]
BODY = [{
"date_ranges": date_ranges,
"field": "string",
"filter": "string",
"interval": "string",
"min_doc_count": 0,
"missing": "string",
"name": "string",
"q": "string",
"ranges": ranges,
"size": 0,
"sort": "string",
"sub_aggregates": [
null
],
"time_zone": "string",
"type": "string"
}]
response = falcon.command("AggregateCases", body=BODY)
print(response)
GetCaseActivityByIds
Retrieve activities for given id's
PEP8 method name
get_case_activity
Endpoint
Method | Route |
---|---|
/message-center/entities/case-activities/GET/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
body | body | dictionary | Full body payload in JSON format. | ||
ids | body | string or list of strings | One or more Case IDs. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(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_case_activity(ids=id_list)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.GetCaseActivityByIds(ids=id_list)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = ['ID1', 'ID2', 'ID3']
BODY = {
"ids": id_list
}
response = falcon.command("GetCaseActivityByIds", body=BODY)
print(response)
CaseAddActivity
Add an activity to case. Only activities of type comment are allowed via API
PEP8 method name
add_case_activity
Endpoint
Method | Route |
---|---|
/message-center/entities/case-activity/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
body | body | dictionary | Full body payload in JSON format. | ||
case_id | body | string | Case ID to attach the activity to. | ||
content | body | string | Case activity content. Used for the body key within the BODY payload. | ||
type | body | string | Case activity type. | ||
user_uuid | body | string | UUID of the user attached to the case activity. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.add_case_activity(case_id="string"
content="string",
type="string",
user_uuid="string"
)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.CaseAddActivity(case_id="string"
content="string",
type="string",
user_uuid="string"
)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
# Raw BODY payload uses the key `body` not `content`
BODY = {
"body": "string",
"case_id": "string",
"type": "string",
"user_uuid": "string"
}
response = falcon.command("CaseAddActivity", body=BODY)
print(response)
CaseDownloadAttachment
retrieves an attachment for the case, given the attachment id
PEP8 method name
download_case_attachment
Endpoint
Method | Route |
---|---|
/message-center/entities/case-attachment/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
id | query | string | Attachment ID to retrieve. | ||
parameters | query | dictionary | Full query string parameters payload in JSON format. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("savefile.exe", "w") as save_file:
save_file.write(falcon.download_case_attachment(id="string"))
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("savefile.exe", "w") as save_file:
save_file.write(falcon.CaseDownloadAttachment(id="string"))
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("savefile.exe", "w") as save_file:
save_file.write(falcon.command("CaseDownloadAttachment", id="string"))
CaseAddAttachment
Upload an attachment for the case.
PEP8 method name
add_case_attachment
Endpoint
Method | Route |
---|---|
/message-center/entities/case-attachment/v1 |
Required Scope
Content-Type
- Consumes: multipart/form-data
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
case_id | formData | string | Case ID to update. | ||
data | formData | file | Content of the attachment in binary format. Max file size is 15 MB. Filename must start with a-zA-Z0-9_- and has a maximum of 255 characters. Allowed characters in file name are a-zA-Z0-9-_. .Accepted file formats:
| ||
file_data or sample or upfile | formData | file | Content of the attachment in binary format. Max file size is 15 MB. sample and upfile are also accepted as this parameter. Filename must start with a-zA-Z0-9_- and has a maximum of 255 characters. Allowed characters in file name are a-zA-Z0-9-_. .Accepted file formats:
| ||
parameters | query | dictionary | Full query string parameters payload in JSON format. | ||
user_uuid | formData | string | UUID of the user providing the attachment. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
FILENAME = "testfile.png"
PAYLOAD = open(FILENAME, 'rb').read()
response = falcon.add_case_attachment(case_id="string",
file_data=PAYLOAD,
user_uuid="string"
)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
FILENAME = "testfile.png"
PAYLOAD = open(FILENAME, 'rb').read()
response = falcon.CaseAddAttachment(case_id="string",
file_data=PAYLOAD,
user_uuid="string"
)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
FILENAME = "testfile.png"
PAYLOAD = open(FILENAME, 'rb').read()
response = falcon.command("CaseAddAttachment",
data=PAYLOAD,
case_id="string",
user_uuid="string",
content_type="multipart/form-data"
)
print(response)
CreateCase
create a new case
PEP8 method name
create_case
Endpoint
Method | Route |
---|---|
/message-center/entities/case/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
body | body | dictionary | Full body payload in JSON format. | ||
content | body | string | Case content. Used for the body key within the BODY payload. | ||
detections | body | list of dictionaries | List of detections to attach to the case. Dictionary format: { "id": "string", "url": "string" } | ||
incidents | body | list of dictionaries | List of incidents to attach to the case. Dictionary format: { "id": "string", "url": "string" } | ||
title | body | string | Case title. | ||
type | body | string | Case type. | ||
user_uuid | body | string | UUID of the user attached to the case. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
response = falcon.create_case(content="string",
detections=detect_list,
incidents=incident_list,
title="string",
type="string",
user_uuid="string"
)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
response = falcon.CreateCase(content="string",
detections=detect_list,
incidents=incident_list,
title="string",
type="string",
user_uuid="string"
)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
# Raw BODY payload uses the key `body` not `content`
BODY = {
"body": "string",
"detections": detect_list,
"incidents": incident_list,
"title": "string",
"type": "string",
"user_uuid": "string"
}
response = falcon.command("CreateCase", body=BODY)
print(response)
CreateCaseV2
create a new case
PEP8 method name
create_case_v2
Endpoint
Method | Route |
---|---|
/message-center/entities/case/v2 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
body | body | dictionary | Full body payload in JSON format. | ||
content | body | string | Case content. Used for the body key within the BODY payload. | ||
detections | body | list of dictionaries | List of detections to attach to the case. Dictionary format: { "id": "string", "url": "string" } | ||
incidents | body | list of dictionaries | List of incidents to attach to the case. Dictionary format: { "id": "string", "url": "string" } | ||
title | body | string | Case title. | ||
type | body | string | Case type. | ||
user_uuid | body | string | UUID of the user attached to the case. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"product": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
response = falcon.create_case_v2(content="string",
detections=detect_list,
incidents=incident_list,
title="string",
type="string",
user_uuid="string"
)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"product": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
response = falcon.CreateCaseV2(content="string",
detections=detect_list,
incidents=incident_list,
title="string",
type="string",
user_uuid="string"
)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"product": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
# Raw BODY payload uses the key `body` not `content`
BODY = {
"body": "string",
"detections": detect_list,
"incidents": incident_list,
"title": "string",
"type": "string",
"user_uuid": "string"
}
response = falcon.command("CreateCaseV2", body=BODY)
print(response)
UpdateCase
update an existing case
PEP8 method name
update_case
Endpoint
Method | Route |
---|---|
/message-center/entities/case/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
body | body | dictionary | Full body payload in JSON format. | ||
content | body | string | Case content. Used for the body key within the BODY payload. | ||
detections | body | list of dictionaries | List of detections to attach to the case. Dictionary format: { "id": "string", "url": "string" } | ||
incidents | body | list of dictionaries | List of incidents to attach to the case. Dictionary format: { "id": "string", "url": "string" } | ||
id | body | string | Case ID to be updated. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
response = falcon.update_case(content="string",
detections=detect_list,
id="string",
incidents=incident_list
)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
response = falcon.UpdateCase(content="string",
detections=detect_list,
id="string",
incidents=incident_list
)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
detect_list = [
{
"id": "string",
"url": "string"
}
]
incident_list = [
{
"id": "string",
"url": "string"
}
]
# Raw BODY payload uses the key `body` not `content`
BODY = {
"body": "string",
"detections": detect_list,
"incidents": incident_list,
"id": "string"
}
response = falcon.command("UpdateCase", body=BODY)
print(response)
GetCaseEntitiesByIDs
Retrieve message center cases
PEP8 method name
get_cases
Endpoint
Method | Route |
---|---|
/message-center/entities/cases/GET/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
body | body | dictionary | Full body payload in JSON format. | ||
ids | body | string or list of strings | One or more Case IDs. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(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_cases(ids=id_list)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.GetCaseEntitiesByIDs(ids=id_list)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = ['ID1', 'ID2', 'ID3']
BODY = {
"ids": id_list
}
response = falcon.command("GetCaseEntitiesByIDs", body=BODY)
print(response)
QueryActivityByCaseID
Retrieve activities id's for a case
PEP8 method name
query_activities
Endpoint
Method | Route |
---|---|
/message-center/queries/case-activities/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
case_id | query | string | Case ID to search for activities. | ||
filter | query | string | The filter expression that should be used to limit the results. FQL Syntax. | ||
limit | query | integer | Maximum number of records to return. (Max: 500) | ||
offset | query | string | Starting index of overall result set from which to return ids. | ||
sort | query | string | The property to sort by. (Ex: case.created_time.desc) Available sort fields
| ||
parameters | query | dictionary | Full query string parameters payload in JSON format. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_activities(case_id="string",
limit=integer,
sort="string",
filter="string",
offset="string"
)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.QueryActivityByCaseID(case_id="string",
limit=integer,
sort="string",
filter="string",
offset="string"
)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("QueryActivityByCaseID",
case_id="string",
limit=integer,
sort="string",
filter="string",
offset="string"
)
print(response)
QueryCasesIdsByFilter
Retrieve case id's that match the provided filter criteria
PEP8 method name
query_cases
Endpoint
Method | Route |
---|---|
/message-center/queries/cases/v1 |
Required Scope
Content-Type
- Consumes: application/json
- Produces: application/json
Keyword Arguments
Name | Service | Uber | Type | Datatype | Description |
---|---|---|---|---|---|
filter | query | string | The filter expression that should be used to limit the results. FQL Syntax. | ||
limit | query | integer | Maximum number of records to return. (Max: 500) | ||
offset | query | string | Starting index of overall result set from which to return ids. | ||
sort | query | string | The property to sort by. (Ex: case.created_time.desc) Available sort fields
| ||
parameters | query | dictionary | Full query string parameters payload in JSON format. |
Usage
Service class example (PEP8 syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_cases(limit=integer,
sort="string",
filter="string",
offset="string"
)
print(response)
Service class example (Operation ID syntax)
from falconpy import MessageCenter
# Do not hardcode API credentials!
falcon = MessageCenter(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.QueryCasesIdsByFilter(limit=integer,
sort="string",
filter="string",
offset="string"
)
print(response)
Uber class example
from falconpy import APIHarnessV2
# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("QueryCasesIdsByFilter",
limit=integer,
sort="string",
filter="string",
offset="string"
)
print(response)