Skip to content

Foundry LogScale

The Foundry LogScale service collection provides operations for ingesting data, managing lookup files, executing saved searches, and listing repositories and views within your CrowdStrike Falcon Foundry LogScale environment.

LanguageLast Update
Pythonv1.6.1
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
ListReposV1
list_repos
Lists available repositories and views
IngestDataAsyncV1
ingest_data_async
Ingest data into the application repository asynchronously
IngestDataV1
ingest_data
Ingest data into the application repository
CreateFileV1
create_file
Creates a lookup file.
UpdateFileV1
update_file
Updates a lookup file.
CreateSavedSearchesDynamicExecuteV1
execute_dynamic
Execute a dynamic saved search
GetSavedSearchesExecuteV1
get_search_results
Get the results of a saved search
CreateSavedSearchesExecuteV1
execute
Execute a saved search
CreateSavedSearchesIngestV1
populate
Populate a saved search
GetSavedSearchesJobResultsDownloadV1
download_results
Get the results of a saved search as a file
ListViewV1
list_views
List views

Lists available repositories and views

GET /loggingapi/combined/repos/v1
Scope App Logs: READ Consumes · Produces application/json
PEP 8 list_repos
NameTypeData typeDescription
check_test_dataquerybooleanInclude whether test data is present in the application repository.
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.list_repos(check_test_data=boolean)
print(response)

Ingest data into the application repository asynchronously

POST /loggingapi/entities/data-ingestion/ingest-async/v1
Scope App Logs: WRITE Consumes · Produces multipart/form-data · application/json
PEP 8 ingest_data_async
NameTypeData typeDescription
data_contentformDatastringJSON data to ingest.
data_fileformDatafileData file to ingest.
parametersquerydictionaryFull query string parameters payload in JSON format.
repoformDatastringRepository name to ingest data into. (If not part of a Foundry application.)
tagformDatastring or list of stringsCustom tag for ingested data in the form tag:value.
tag_sourceformDatastringTag the data with the specified source.
test_dataformDatabooleanTag the data with test-ingest.
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ingest_data_async(data_content="string",
data_file="string",
tag="string",
tag_source="string",
test_data=boolean)
print(response)

Ingest data into the application repository

POST /loggingapi/entities/data-ingestion/ingest/v1
Scope App Logs: WRITE Consumes · Produces multipart/form-data · application/json
PEP 8 ingest_data
NameTypeData typeDescription
data_contentformDatastringJSON data to ingest.
data_fileformDatafileData file to ingest.
parametersquerydictionaryFull query string parameters payload in JSON format.
tagformDatastring or list of stringsCustom tag for ingested data in the form tag:value.
tag_sourceformDatastringTag the data with the specified source.
test_dataformDatabooleanTag the data with test-ingest.
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ingest_data(data_content="string",
data_file="string",
tag="string",
tag_source="string",
test_data=boolean)
print(response)

Creates a lookup file.

POST /loggingapi/entities/lookup-files/v1
Scope App Logs: WRITE Consumes · Produces multipart/form-data · application/json
PEP 8 create_file
NameTypeData typeDescription
data_fileformDatafileFile to be uploaded. file is also accepted for this parameter.
nameformDatastringName used to identify the file.
descriptionformDatastringFile description.
idformDatastringUnique identifier of the file being updated.
repoformDatastringName of repository or view to save the file.
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.create_file(data_file="string",
name="string",
description="string",
id="string",
repo="string")
print(response)

Updates a lookup file.

PATCH /loggingapi/entities/lookup-files/v1
Scope App Logs: WRITE Consumes · Produces multipart/form-data · application/json
PEP 8 update_file
NameTypeData typeDescription
idformDatastringUnique identifier of the file being updated.
descriptionformDatastringFile description.
data_fileformDatafileFile to be uploaded. file is also accepted for this parameter.
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.update_file(data_file="string",
description="string",
id="string")
print(response)

Execute a dynamic saved search

POST /loggingapi/entities/saved-searches/execute-dynamic/v1
Scope App Logs: WRITE Consumes · Produces application/json
PEP 8 execute_dynamic
NameTypeData typeDescription
app_idquerystringApplication ID
endbodystringDynamic search end
include_schema_generationquerybooleanInclude generated schemas in the response
include_test_dataquerybooleanInclude test data when executing searches
infer_json_typesquerybooleanWhether to try to infer data types in json event response instead of returning map[string]string.
match_response_schemaquerybooleanWhether to validate search results against their schema.
metadataquerybooleanWhether to include metadata in the response
modequerystringMode to execute the query under.
bodybodydictionaryFull body payload in JSON format, not required if using other keywords.
parametersquerydictionaryFull query string parameters payload in JSON format.
repo_or_viewbodystringRepository or view to search
search_querybodystringSearch query to perform
search_query_argsbodydictionarySearch query arguments to leverage when processing the query
startbodystringDynamic search start
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
search_query_args = {}
response = falcon.execute_dynamic(app_id="string",
end="string",
include_schema_generation=boolean,
incude_test_data=boolean,
infer_json_types="string",
match_response_schema=boolean,
metadata=boolean,
mode="string",
repo_or_view="string",
search_query="string",
search_query_args=search_query_args,
start="string")
print(response)

Get the results of a saved search

GET /loggingapi/entities/saved-searches/execute/v1
Scope App Logs: READ Consumes · Produces application/json
PEP 8 get_search_results
NameTypeData typeDescription
app_idquerystringApplication ID
job_idquerystringJob ID for a previously executed async query
job_status_onlyquerybooleanIf set to true, result rows are dropped from the response and only the job status is returned
limitquerystringMaximum number of records to return.
infer_json_typesquerybooleanWhether to try to infer data types in json event response instead of returning map[string]string.
match_response_schemaquerybooleanWhether to validate search results against their schema.
metadataquerybooleanWhether to include metadata in the response
offsetquerystringStarting pagination offset of records to return.
parametersquerydictionaryFull query string parameters payload in JSON format.
versionquerystringVersion of resource being created
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_search_results(app_id="string",
job_id="string",
job_status_only="string",
limit=integer,
infer_json_types="string",
match_response_schema=boolean,
metadata=boolean,
offset="string")
print(response)

Execute a saved search

POST /loggingapi/entities/saved-searches/execute/v1
Scope App Logs: WRITE Consumes · Produces application/json
PEP 8 execute
NameTypeData typeDescription
app_idquerystringApplication ID
bodybodystringFull body payload in JSON format. Not required if using other keywords.
detailedquerybooleanWhether to include search field details
endbodystringSaved search end.
idbodystringSaved search ID.
include_test_dataquerybooleanInclude test data when executing searches
infer_json_typesquerybooleanWhether to try to infer data types in json event response instead of returning map[string]string.
match_response_schemaquerybooleanWhether to validate search results against their schema.
metadataquerybooleanWhether to include metadata in the response
modebodystringMode to execute the query under. If provided, takes precedence over the mode provided in the body.
namebodystringName of the saved search.
parametersquerystringFull query string payload in JSON format. Not required if using other keywords.
search_parametersbodydictionaryParameters to use for the saved search.
startbodystringSaved search start.
versionbodystringVersion of resource being created
with_inbodydictionaryLimit search results to field names matching the provided list.
with_limitbodydictionaryLimit search results by a maximum count.
with_renamesbodylistRename fields for display.
with_sortbodydictionaryApply sort criteria.
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with_in = {
"field": "string",
"values": [
"string"
]
}
with_limit = {
"from": "string",
"limit": 0
}
with_renames = [
{
"as": "string",
"field": "string"
}
]
with_sort = {
"fields": [
"string"
],
"limit": 0,
"order": [
"string"
],
"reverse": true,
"type": [
"string"
]
}
response = falcon.execute(app_id="string",
detailed=boolean,
end="string",
id="string",
include_test_data=boolean,
infer_json_types="string",
match_response_schema=boolean,
metadata=boolean,
name="string",
search_parameters={},
start="string",
with_in=with_in,
with_limit=with_limit,
with_renames=with_renames,
with_sort=with_sort)
print(response)

Populate a saved search

POST /loggingapi/entities/saved-searches/ingest/v1
Scope App Logs: WRITE Consumes · Produces multipart/form-data · application/json
PEP 8 populate
NameTypeData typeDescription
app_idquerystringInclude generated schemas in the response
parametersquerydictionaryFull query string parameters payload in JSON format.
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.populate(app_id="string")
print(response)

Get the results of a saved search as a file

GET /loggingapi/entities/saved-searches/job-results-download/v1
Scope App Logs: READ Consumes · Produces application/json · application/octet-stream
PEP 8 download_results
NameTypeData typeDescription
job_idquerystringJob ID for a previously executed async query
infer_json_typesquerybooleanWhether to try to infer data types in json event response instead of returning map[string]string.
parametersquerydictionaryFull query string parameters payload in JSON format.
result_formatquerystringResult Format
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
with open("output_file", "wb") as save_file:
response = falcon.download_results(job_id="string",
infer_json_types="string",
result_format="string",
stream=boolean)
save_file.write(response)

List views

GET /loggingapi/entities/views/v1
Scope App Logs: READ Consumes · Produces application/json
PEP 8 list_views
NameTypeData typeDescription
check_test_dataquerybooleanInclude whether test data is present in the application repository.
from falconpy import FoundryLogScale
falcon = FoundryLogScale(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.list_views(check_test_data=boolean)
print(response)