DataScanner - CrowdStrike/falconpy GitHub Wiki
| Operation ID | Description | ||||
|---|---|---|---|---|---|
|
Retrieves image registry credentials. | ||||
|
Retrieve pending tasks. | ||||
|
Reports back on task status. | ||||
|
Produces the input message into the corresponding Kafka topic. | ||||
WARNING
client_idandclient_secretare 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.
Retrieves image registry credentials.
This operation has been deprecated and will be removed from the SDK when this endpoint is decommissioned.
get_image_registry_credentials
| Method | Route |
|---|---|
 |
/data-security-dspm/entities/image-registry-credentials/v1 |
- Consumes: application/json
- Produces: application/json
No keywords or arguments accepted.
from falconpy import DataScanner
falcon = DataScanner(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_image_registry_credentials()
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("get_image_registry_credentials")
print(response)Retrieve pending tasks.
This operation has been deprecated and will be removed from the SDK when this endpoint is decommissioned.
get_data_scanner_tasks
| Method | Route |
|---|---|
|
/data-security-dspm/entities/scanner-tasks/v1 |
- Consumes: application/json
- Produces: application/json
| Name | Service | Uber | Type | Data type | Description |
|---|---|---|---|---|---|
| scanner_id |  |
|
query | string | ID of the data scanner. |
| parameters | |
|
query | dictionary | Full query string parameters payload in JSON format. |
from falconpy import DataScanner
falcon = DataScanner(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_data_scanner_tasks(scanner_id="string")
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("get_data_scanner_tasks", scanner_id="string")
print(response)Reports back on task status.
This operation has been deprecated and will be removed from the SDK when this endpoint is decommissioned.
update_data_scanner_tasks
| Method | Route |
|---|---|
 |
/data-security-dspm/entities/scanner-tasks/v1 |
- Consumes: application/json
- Produces: text/plain
| Name | Service | Uber | Type | Data type | Description |
|---|---|---|---|---|---|
| scanner_id | |
|
query | ID of the data scanner. | |
| machine_id | |
|
query | Provider ID of machine. | |
| parameters | |
|
query | dictionary | Full query string parameters payload in JSON format. |
from falconpy import DataScanner
falcon = DataScanner(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.update_data_scanner_tasks(scanner_id="string", machine_id="string")
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("update_data_scanner_tasks", scanner_id="string", machine_id="string")
print(response)Produces the input message into the corresponding Kafka topic.
This operation has been deprecated and will be removed from the SDK when this endpoint is decommissioned.
handle
| Method | Route |
|---|---|
 |
/data-security-dspm/entities/kafka-rest-produce/v1 |
- Consumes: application/json
- Produces: application/json
No keywords or arguments accepted.
from falconpy import DataScanner
falcon = DataScanner(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.handle()
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("handle")
print(response)