Using the DataScanner service collection

Table of Contents

get_image_registry_credentials

Retrieves image registry credentials.

PEP8 method name

get_image_registry_credentials

Endpoint

Method	Route
	/data-security-dspm/entities/image-registry-credentials/v1

Required Scope

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 / Operation ID syntax)

from falconpy import DataScanner

falcon = DataScanner(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.get_image_registry_credentials()
print(response)

Uber class example

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("get_image_registry_credentials")
print(response)

get_data_scanner_tasks

Retrieve pending tasks.

PEP8 method name

get_data_scanner_tasks

Endpoint

Method	Route
	/data-security-dspm/entities/scanner-tasks/v1

Required Scope

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

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.

Usage

Service class example (PEP8 / Operation ID syntax)

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)

Uber class example

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)

update_data_scanner_tasks

Reports back on task status.

PEP8 method name

update_data_scanner_tasks

Endpoint

Method	Route
	/data-security-dspm/entities/scanner-tasks/v1

Required Scope

Content-Type

• Consumes: application/json
• Produces: text/plain

Keyword Arguments

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.

Usage

Service class example (PEP8 / Operation ID syntax)

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)

Uber class example

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)

handle

Produces the input message into the corresponding Kafka topic.

PEP8 method name

handle

Endpoint

Method	Route
	/data-security-dspm/entities/kafka-rest-produce/v1

Required Scope

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 / Operation ID syntax)

from falconpy import DataScanner

falcon = DataScanner(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.handle()
print(response)

Uber class example

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("handle")
print(response)