Ml Exclusions

Using the ML Exclusions service collection

Table of Contents

Method	Operation ID	Description
get_exclusions	getMLExclusionsV1	Get a set of ML Exclusions by specifying their IDs
create_exclusions	createMLExclusionsV1	Create the ML exclusions
delete_exclusions	deleteMLExclusionsV1	Delete the ML exclusions by id
update_exclusions	updateMLExclusionsV1	Update the ML exclusions
query_exclusions	queryMLExclusionsV1	Search for ML exclusions.

getMLExclusionsV1

Get a set of ML Exclusions by specifying their IDs

Content-Type

• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	array (string)	The ids of the exclusions to retrieve

Usage

Service class example (PEP8 syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_exclusions(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.getMLExclusionsV1(ids=id_list)
print(response)

Uber class example

from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("getMLExclusionsV1", ids=id_list)
print(response)

createMLExclusionsV1

Create the ML exclusions

Content-Type

• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	body	body	string

Usage

Service class example (PEP8 syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.create_exclusions(body=BODY)
print(response)

Service class example (Operation ID syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.createMLExclusionsV1(body=BODY)
print(response)

Uber class example

from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.command("createMLExclusionsV1", body=BODY)
print(response)

deleteMLExclusionsV1

Delete the ML exclusions by id

Content-Type

• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	array (string)	The ids of the exclusions to delete
	comment	query	string	Explains why this exclusions was deleted

Usage

Service class example (PEP8 syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.delete_exclusions(comment="string", ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.deleteMLExclusionsV1(comment="string", ids=id_list)
print(response)

Uber class example

from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

PARAMS = {
    "comment": "string"
}

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("deleteMLExclusionsV1", parameters=PARAMS, ids=id_list)
print(response)

updateMLExclusionsV1

Update the ML exclusions

Content-Type

• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	body	body	string

Usage

Service class example (PEP8 syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.update_exclusions(body=BODY)
print(response)

Service class example (Operation ID syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.updateMLExclusionsV1(body=BODY)
print(response)

Uber class example

from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "Body Payload": "See body description above"
}

response = falcon.command("updateMLExclusionsV1", body=BODY)
print(response)

queryMLExclusionsV1

Search for ML exclusions.

Content-Type

• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
	filter	query	string	The filter expression that should be used to limit the results.
	offset	query	integer	The offset to start retrieving records from
	limit	query	integer	The maximum records to return. [1-500]
	sort	query	string	The sort expression that should be used to sort the results.

Usage

Service class example (PEP8 syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

response = falcon.query_exclusions(filter="string",
                                   offset=integer,
                                   limit=integer,
                                   sort="string"
                                   )
print(response)

Service class example (Operation ID syntax)

from falconpy.ml_exclusions import MLExclusions

falcon = MLExclusions(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

response = falcon.queryMLExclusionsV1(filter="string",
                                      offset=integer,
                                      limit=integer,
                                      sort="string"
                                      )
print(response)

Uber class example

from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

PARAMS = {
    "filter": "string",
    "offset": integer,
    "limit": integer,
    "sort": "string"
}

response = falcon.command("queryMLExclusionsV1", parameters=PARAMS)
print(response)