Using the ASPM service collection

Table of Contents

Passing credentials

WARNING

client_id and client_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.

ExecuteFunctionDataCount

A selected list of queryLanguage count queries.

PEP8 method name

execute_function_data_count

Endpoint

Method	Route
	/application-security/aggregates/function-data/count/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
aws_lambda_arn			query	string	AWS Lambda ARN. Required for aws cloud provider.
azure_function_app_name			query	string	Azure Function App name. Required for azure cloud provider.
azure_site_resource_group			query	string	Azure site resource group. Required for azure cloud provider.
azure_site_subscription_id			query	string	Azure site subscription ID. Required for azure cloud provider.
cloud_provider			query	string or list of strings	Cloud provider ID. Allowed values: aws, azure and gcp. Required.
gcp_cloud_function_url			query	string	GCP Cloud Function URL. Required for gcp cloud provider.
parameters			query	dictionary	Full query string parameters payload in JSON format.
query_name			query	string	Query name. Required.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_function_data_count(aws_lambda_arn="string",
                                              azure_function_app_name="string",
                                              azure_site_resource_group="string",
                                              azure_site_subscription_id="string",
                                              cloud_provider="string",  # "string,string" and ["string"] also accepted
                                              gcp_cloud_function_url="string",
                                              query_name="string"
                                              )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionDataCount(aws_lambda_arn="string",
                                           azure_function_app_name="string",
                                           azure_site_resource_group="string",
                                           azure_site_subscription_id="string",
                                           cloud_provider="string",  # "string,string" and ["string"] also accepted
                                           gcp_cloud_function_url="string",
                                           query_name="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("ExecuteFunctionDataCount",
                          aws_lambda_arn="string",
                          azure_function_app_name="string",
                          azure_site_resource_group="string",
                          azure_site_subscription_id="string",
                          cloud_provider="string",  # "string,string" and ["string"] also accepted
                          gcp_cloud_function_url="string",
                          query_name="string"
                          )
print(response)

Back to Table of Contents

ExecuteFunctionsCount

A selected list of queryLanguage count queries.

PEP8 method name

execute_functions_count

Endpoint

Method	Route
	/application-security/aggregates/functions/count/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
cid			query	string or list of strings	Customer ID. Required for azure cloud provider.
cloud_account_id			query	string or list of strings	AWS Cloud Account ID. Required for aws cloud provider.
cloud_provider			query	string or list of strings	Cloud provider ID. Allowed values: aws, azure and gcp. Required.
parameters			query	dictionary	Full query string parameters payload in JSON format.
query_name			query	string	Query name. Required.
region			query	string or list of strings	GCP Region. Required for gcp cloud provider.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_functions_count(cid="string",  # "string,string" and ["string"] also accepted
                                          cloud_account_id="string",  # "string,string" and ["string"] also accepted
                                          cloud_provider="string",  # "string,string" and ["string"] also accepted
                                          query_name="string",
                                          region="string"
                                          )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionsCount(cid="string",  # "string,string" and ["string"] also accepted
                                        cloud_account_id="string",  # "string,string" and ["string"] also accepted
                                        cloud_provider="string",  # "string,string" and ["string"] also accepted
                                        query_name="string",
                                        region="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("ExecuteFunctionsCount",
                          cid="string",  # "string,string" and ["string"] also accepted
                          cloud_account_id="string",  # "string,string" and ["string"] also accepted
                          cloud_provider="string",  # "string,string" and ["string"] also accepted
                          query_name="string",
                          region="string"
                          )
print(response)

Back to Table of Contents

ExecuteFunctionDataQueryCount

A selected list of queryLanguage count queries.

PEP8 method name

execute_function_data_query_count

Endpoint

Method	Route
	/application-security/aggregates/query-function-data-count/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
field			query	string	Query fields.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_function_data_query_count(field="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionDataQueryCount(field="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("ExecuteFunctionDataQueryCount", parameters=PARAMS)

print(response)

Back to Table of Contents

ExecuteFunctionsQueryCount

A selected list of queryLanguage count queries.

PEP8 method name

execute_functions_query_count

Endpoint

Method	Route
	/application-security/aggregates/query-functions-count/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
field			query	string	Query fields.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_functions_query_count(field="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionsQueryCount(field="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("ExecuteFunctionsQueryCount", parameters=PARAMS)

print(response)

Back to Table of Contents

ExecuteFunctionData

A selected list of queryLanguage queries.

PEP8 method name

execute_function_data

Endpoint

Method	Route
	/application-security/combined/function-data/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
field			query	string	Query fields.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_function_data(field="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionData(field="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("ExecuteFunctionData", parameters=PARAMS)

print(response)

Back to Table of Contents

ExecuteFunctionsOvertime

A selected list of queryLanguage overtime queries.

PEP8 method name

execute_functions_over_time

Endpoint

Method	Route
	/application-security/combined/functions-overtime/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
field			query	string	Query fields.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_functions_over_time(field="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionsOvertime(field="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("ExecuteFunctionsOvertime", parameters=PARAMS)

print(response)

Back to Table of Contents

ExecuteFunctions

A selected list of queryLanguage services queries.

PEP8 method name

execute_functions

Endpoint

Method	Route
	/application-security/combined/functions/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
field			query	string	Query fields.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_functions(field="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctions(field="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("ExecuteFunctions", parameters=PARAMS)

print(response)

Back to Table of Contents

ExecuteFunctionDataQuery

A selected list of queryLanguage queries.

PEP8 method name

execute_function_data_query

Endpoint

Method	Route
	/application-security/combined/query-function-data/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
field			query	string	Query fields.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_function_data_query(field="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionDataQuery(field="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("ExecuteFunctionDataQuery", parameters=PARAMS)

print(response)

Back to Table of Contents

ExecuteFunctionsQueryOvertime

A selected list of queryLanguage overtime queries.

PEP8 method name

execute_functions_query_over_time

Endpoint

Method	Route
	/application-security/combined/query-functions-overtime/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
field			query	string	Query fields.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_functions_query_over_time(field="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionsQueryOvertime(field="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("ExecuteFunctionsQueryOvertime", parameters=PARAMS)

print(response)

Back to Table of Contents

ExecuteFunctionsQuery

A selected list of queryLanguage services queries.

PEP8 method name

execute_functions_query

Endpoint

Method	Route
	/application-security/combined/query-functions/v1

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
field			query	string	Query fields.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.execute_functions_query(field="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ExecuteFunctionsQuery(field="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("ExecuteFunctionsQuery", fields="string")

print(response)

Back to Table of Contents

getServiceArtifacts

Retrieve service artifacts.

PEP8 method name

get_service_artifacts

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/artifacts

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
persistent_signature			query	string	Persistent signature.
optional_time			query	string	Optional time.
revision_id			query	string	Revision ID.
limit			query	integer	Upper bound for records returned.
offset			query	integer	Starting position of records returned.
order_by			query	string or list of strings	Sort order field(s).
direction			query	string	Sort order direction. Allowed values: asc or desc.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_service_artifacts(persistent_signature="string",
                                        optional_time="string",
                                        revision_id="string",
                                        limit=integer,
                                        offset=integer,
                                        order_by="string",  # "string,string" and ["string"] also accepted
                                        direction="string"
                                        )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.getServiceArtifacts(persistent_signature="string",
                                      optional_time="string",
                                      revision_id="string",
                                      limit=integer,
                                      offset=integer,
                                      order_by="string",  # "string,string" and ["string"] also accepted
                                      direction="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("getServiceArtifacts",
                          persistent_signature="string",
                          optional_time="string",
                          revision_id="string",
                          limit=integer,
                          offset=integer,
                          order_by="string",  # "string,string" and ["string"] also accepted
                          direction="string"
                          )
print(response)

Back to Table of Contents

UpsertBusinessApplications

Create or Update Business Applications

PEP8 method name

update_business_applications

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/business_applications

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
name			body	string	Application name.
persistent_signature			body	string or list of strings	Signature to persist.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.update_business_applications(name="string", persistent_signature="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.UpsertBusinessApplications(name="string", persistent_signature="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
                      )

body_payload = {
    "name": "string",
    "persistentSignatures": [
        "string"
    ]
}

response = falcon.command("UpsertBusinessApplications", body=body_payload)
print(response)

Back to Table of Contents

GetCloudSecurityIntegrationState

Get Cloud Security integration state.

PEP8 method name

get_cloud_security_integration_state

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/cloud_security_config

Required Scope

Content-Type

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

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_cloud_security_integration_state()

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetCloudSecurityIntegrationState()

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("GetCloudSecurityIntegrationState")

print(response)

Back to Table of Contents

SetCloudSecurityIntegrationState

Set Cloud Security integration state.

PEP8 method name

set_cloud_security_integration_state

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/cloud_security_config

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	string	Full body payload as a JSON formatted dictionary.
is_enabled			body	boolean	Flag indicating if the state should be enabled.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.set_cloud_security_integration_state(is_enabled=boolean)

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.SetCloudSecurityIntegrationState(is_enabled=boolean)

print(response)

Uber class example

from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
  "isEnabled": true
}

response = falcon.command("SetCloudSecurityIntegrationState", body=body_payload)

print(response)

Back to Table of Contents

GetExecutorNodes

Get all the relay nodes

PEP8 method name

get_executor_nodes

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/executor_nodes

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
direction			query	string	Sort order direction. Allowed values: asc or desc.
executor_node_ids			query	string or list_of_strings	Executor node IDs.
executor_node_names			query	string or list_of_strings	Executor node names.
executor_node_states			query	string or list_of_strings	Executor node states.
executor_node_types			query	string or list_of_strings	Executor node types.
node_type			query	string	Relay node type.
integration_type			query	string	Integration type.
limit			query	integer	Maximum number of records to return.
offset			query	integer	Starting position from which to return records.
order_by			query	string	Field to use for sorting results. Allowed values: name, id, state and type.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_executor_nodes(direction="string",
                                     executor_node_ids="string",  # "string,string" or ["string"] also accepted
                                     executor_node_names="string",  # "string,string" or ["string"] also accepted
                                     executor_node_states="string",  # "string,string" or ["string"] also accepted
                                     executor_node_types="string",  # "string,string" or ["string"] also accepted
                                     node_type="string",
                                     integration_type="string",
                                     limit=integer,
                                     offset=integer,
                                     order_by="string"
                                     )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetExecutorNodes(direction="string",
                                   executor_node_ids="string",  # "string,string" or ["string"] also accepted
                                   executor_node_names="string",  # "string,string" or ["string"] also accepted
                                   executor_node_states="string",  # "string,string" or ["string"] also accepted
                                   executor_node_types="string",  # "string,string" or ["string"] also accepted
                                   node_type="string",
                                   integration_type="string",
                                   limit=integer,
                                   offset=integer,
                                   order_by="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("GetExecutorNodes",
                          direction="string",
                          executor_node_ids="string",  # "string,string" or ["string"] also accepted
                          executor_node_names="string",  # "string,string" or ["string"] also accepted
                          executor_node_states="string",  # "string,string" or ["string"] also accepted
                          executor_node_types="string",  # "string,string" or ["string"] also accepted
                          node_type="string",
                          integration_type="string",
                          limit=integer,
                          offset=integer,
                          order_by="string"
                          )
print(response)

Back to Table of Contents

UpdateExecutorNode

Update an existing relay node

PEP8 method name

update_executor_node

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/executor_nodes

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
additional_header			body	string	Additional headers.
current_aws_arn			body	string	AWS ARN.
dashboard_url			body	string	Dashboard URL address.
last_health_check			body	integer	Last health check.
name			body	string	Node name.
node_type			body	string	Node type.
password			body	string	Password.
pod_settings			body	dictionary	Pod settings.
proxy_address			body	string	Proxy server address.
type			body	string	Type.
use_jobs			body	boolean	Flag indicating if jobs should be used.
username			body	string	Username.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

pod_set = {
    "imageAddress": "string",
    "imagePullSecrets": [
        "string"
    ],
    "podLabels": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

response = falcon.create_executor_node(additional_header="string",
                                       current_aws_arn="string",
                                       dashboard_url="string",
                                       last_health_check=integer,
                                       name="string",
                                       node_type="string",
                                       password="string",
                                       pod_settings=pod_set,
                                       proxy_address="string",
                                       type="string",
                                       use_jobs=boolean,
                                       username="string"
                                       )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

pod_set = {
    "imageAddress": "string",
    "imagePullSecrets": [
        "string"
    ],
    "podLabels": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

response = falcon.CreateExecutorNode(additional_header="string",
                                     current_aws_arn="string",
                                     dashboard_url="string",
                                     last_health_check=integer,
                                     name="string",
                                     node_type="string",
                                     password="string",
                                     pod_settings=pod_set,
                                     proxy_address="string",
                                     type="string",
                                     use_jobs=boolean,
                                     username="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
                      )

body_payload = {
  "additional_header": "string",
  "current_aws_arn": "string",
  "dashboard_url": "string",
  "last_health_check": 0,
  "name": "string",
  "node_type": "string",
  "password": "string",
  "pod_settings": {
    "imageAddress": "string",
    "imagePullSecrets": [
      "string"
    ],
    "podLabels": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "proxy_address": "string",
  "type": "string",
  "useJobs": true,
  "username": "string"
}

response = falcon.command("UpdateExecutorNode", body=body_payload)
print(response)

Back to Table of Contents

CreateExecutorNode

Create a new relay node

PEP8 method name

create_executor_node

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/executor_nodes

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
additional_header			body	string	Additional headers.
current_aws_arn			body	string	AWS ARN.
dashboard_url			body	string	Dashboard URL address.
id			body	integer	Node ID.
last_health_check			body	integer	Last health check.
name			body	string	Node name.
node_type			body	string	Node type.
password			body	string	Password.
pod_settings			body	dictionary	Pod settings.
proxy_address			body	string	Proxy server address.
type			body	string	Type.
use_jobs			body	boolean	Flag indicating if jobs should be used.
username			body	string	Username.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

pod_set = {
    "imageAddress": "string",
    "imagePullSecrets": [
        "string"
    ],
    "podLabels": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

response = falcon.create_executor_node(additional_header="string",
                                       current_aws_arn="string",
                                       dashboard_url="string",
                                       id=integer,
                                       last_health_check=integer,
                                       name="string",
                                       node_type="string",
                                       password="string",
                                       pod_settings=pod_set,
                                       proxy_address="string",
                                       type="string",
                                       use_jobs=boolean,
                                       username="string"
                                       )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

pod_set = {
    "imageAddress": "string",
    "imagePullSecrets": [
        "string"
    ],
    "podLabels": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

response = falcon.CreateExecutorNode(additional_header="string",
                                     current_aws_arn="string",
                                     dashboard_url="string",
                                     id=integer,
                                     last_health_check=integer,
                                     name="string",
                                     node_type="string",
                                     password="string",
                                     pod_settings=pod_set,
                                     proxy_address="string",
                                     type="string",
                                     use_jobs=boolean,
                                     username="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
                      )

body_payload = {
  "additional_header": "string",
  "current_aws_arn": "string",
  "dashboard_url": "string",
  "id": 0,
  "last_health_check": 0,
  "name": "string",
  "node_type": "string",
  "password": "string",
  "pod_settings": {
    "imageAddress": "string",
    "imagePullSecrets": [
      "string"
    ],
    "podLabels": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "proxy_address": "string",
  "type": "string",
  "useJobs": true,
  "username": "string"
}

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

Back to Table of Contents

GetExecutorNodesMetadata

Get metadata about all executor nodes.

PEP8 method name

get_executor_nodes_metadata

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/executor_nodes/metadata

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
	executor_node_ids			query	string or list of strings
	executor_node_names			query	string or list of strings
	executor_node_states			query	integer or list of integers
	executor_node_types			query	string or list of strings
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_executor_nodes_metadata(executor_node_ids="string",  # "string,string" or ["string"] also accepted
                                              executor_node_names="string", # "string,string" or ["string"] also accepted
                                              executor_node_states=integer,  # [integer] also accepted
                                              executor_node_types="string"  # "string,string" or ["string"] also accepted
                                              )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetExecutorNodesMetadata(executor_node_ids="string",  # "string,string" or ["string"] also accepted
                                           executor_node_names="string", # "string,string" or ["string"] also accepted
                                           executor_node_states=integer,  # [integer] also accepted
                                           executor_node_types="string"  # "string,string" or ["string"] also accepted
                                           )
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("GetExecutorNodesMetadata",
                          executor_node_ids="string",  # "string,string" or ["string"] also accepted
                          executor_node_names="string", # "string,string" or ["string"] also accepted
                          executor_node_states=integer,  # [integer] also accepted
                          executor_node_types="string"  # "string,string" or ["string"] also accepted
                          )
print(response)

Back to Table of Contents

DeleteExecutorNode

Delete a relay node

PEP8 method name

delete_node

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/executor_nodes/{ID}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
id			path	integer	Executor node ID.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.delete_node(id=integer)
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.DeleteExecutorNode(id=integer)
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("DeleteExecutorNode", id=integer)
print(response)

Back to Table of Contents

RetrieveRelayInstances

Retrieve the relay instances in CSV format.

PEP8 method name

retrieve_relay_instances

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/executor_nodes/{ID}/instances/csv

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
additional_header			body	string	Additional header to provide.
body			body	string	Full body payload as a JSON formatted dictionary.
current_aws_arn			body	string	Current AWS ARN.
dashboard_url			body	string	URL for the related dashboard.
id			path	integer	ID of the node to retrieve.
last_health_check			body	integer	Last health check.
name			body	string	Name.
node_type			body	string	Node type.
pod_settings			body	dictionary	Related pod settings.
proxy_address			body	string	Address of the proxy.
status			body	dictionary	Current status.
type			body	string	Relay type.
use_jobs			body	boolean	Flag indicating if jobs should be used.
username			body	string	Account username.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

pod_settings = {
  "imageAddress": "string",
  "imagePullSecrets": [
    "string"
  ],
  "podLabels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

status = {
  "State": integer,
  "StateLastUpdated": integer,
  "StateReason": integer
}

response = falcon.retrieve_relay_instances(additional_header="string",
                                           current_aws_arn="string",
                                           dashboard_url="string",
                                           id=integer,
                                           last_health_check=integer,
                                           name="string",
                                           node_type="string",
                                           pod_settings=pod_settings,
                                           proxy_address="string",
                                           status=status,
                                           type="string",
                                           use_jobs=boolean,
                                           username="string"
                                           )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

pod_settings = {
  "imageAddress": "string",
  "imagePullSecrets": [
    "string"
  ],
  "podLabels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

status = {
  "State": integer,
  "StateLastUpdated": integer,
  "StateReason": integer
}

response = falcon.RetrieveRelayInstances(additional_header="string",
                                         current_aws_arn="string",
                                         dashboard_url="string",
                                         id=integer,
                                         last_health_check=integer,
                                         name="string",
                                         node_type="string",
                                         pod_settings=pod_settings,
                                         proxy_address="string",
                                         status=status,
                                         type="string",
                                         use_jobs=boolean,
                                         username="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
                      )

body_payload = {
  "additional_header": "string",
  "current_aws_arn": "string",
  "dashboard_url": "string",
  "id": integer,
  "last_health_check": integer,
  "name": "string",
  "node_type": "string",
  "password": "string",
  "pod_settings": {
    "imageAddress": "string",
    "imagePullSecrets": [
      "string"
    ],
    "podLabels": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "proxy_address": "string",
  "status": {
    "State": integer,
    "StateLastUpdated": integer,
    "StateReason": integer
  },
  "type": "string",
  "useJobs": boolean,
  "username": "string"
}

response = falcon.command("RetrieveRelayInstances", body=body_payload)

print(response)

Back to Table of Contents

GetIntegrationTasks

Get all the integration tasks

PEP8 method name

get_integration_tasks

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
integration_task_type			query	string	Integration task type.
category			query	string	Integration task category.
offset			query	integer	Starting position from which to return records.
limit			query	integer	Maximum number of records to return.
order_by			query	string	Field to use for sorting results.
direction			query	string	Sort order direction. Allowed values: asc or desc.
integration_task_types			query	integer	Integration task types.
ids			query	integer	Integration task ID to retrieve.
names			query	string	Integration task name.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_integration_tasks(integration_task_type=integer,
                                        category="string",
                                        offset=integer,
                                        limit=integer,
                                        orderBy="string",
                                        direction="string",
                                        integration_task_types=integer,
                                        ids=integer,
                                        names="string"
                                        )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetIntegrationTasks(integration_task_type=integer,
                                      category="string",
                                      offset=integer,
                                      limit=integer,
                                      orderBy="string",
                                      direction="string",
                                      integration_task_types=integer,
                                      ids=integer,
                                      names="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("GetIntegrationTasks", 
                          integration_task_type=integer,
                          category="string",
                          offset=integer,
                          limit=integer,
                          orderBy="string",
                          direction="string",
                          integration_task_types=integer,
                          ids=integer,
                          names="string"
                          )
print(response)

Back to Table of Contents

CreateIntegrationTask

Create new integration task.

PEP8 method name

create_integration_task

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
access_token			body	string	Access token.
task_id			body	integer	Task ID.
data			body	string	Task data content.
override			body	boolean	Flag indicating if this task should override other task values.
scheduled			body	boolean	Flag indicating if this task is scheduled.
id			path	dictionary	ID of the integration task to execute.
integration_task			query	integration	Full integration task detail.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

task_dictionary = {
    "access_token": "string",
    "additional_header": "string",
    "business_application": "string",
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration": {
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "name": "string",
    "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
        "imageAddress": "string",
        "imagePullSecrets": [
            "string"
        ],
        "podLabels": [
            {
            "key": "string",
            "value": "string"
            }
        ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
    },
    "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "update_time": integer
    },
    "integration_task_type": {
    "category": "string",
    "display_name": "string",
    "enabled": boolean,
    "id": integer,
    "name": "string",
    "required_integration_types": [
        {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
        }
    ]
    },
    "latest_task_run": {
    "create_time": {
        "nanos": integer,
        "seconds": integer
    },
    "events": [
        {
        "FlatData": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
            "additional_info": "string",
            "aws": {
            "accountArn": "string",
            "region": "string"
            },
            "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
            },
            "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
            },
            "cloud_function": {
            "function_name": "string"
            },
            "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
            },
            "ec2": {
            "instance_id": "string",
            "instance_name": "string"
            },
            "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
            },
            "gcp": {
            "project": "string",
            "region": "string"
            },
            "host": {
            "address": "string"
            },
            "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
            },
            "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
            },
            "remedy": {
            "content": "string",
            "url": "string"
            },
            "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
            },
            "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
            }
        },
        "flat_fields": [
            "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
            "nanos": integer,
            "seconds": integer
        },
        "status": integer
        }
    ],
    "id": integer,
    "latest_event": {
        "FlatData": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
        "additional_info": "string",
        "aws": {
            "accountArn": "string",
            "region": "string"
        },
        "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
        },
        "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
        },
        "cloud_function": {
            "function_name": "string"
        },
        "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
        },
        "ec2": {
            "instance_id": "string",
            "instance_name": "string"
        },
        "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
        },
        "gcp": {
            "project": "string",
            "region": "string"
        },
        "host": {
            "address": "string"
        },
        "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
        },
        "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
        },
        "remedy": {
            "content": "string",
            "url": "string"
        },
        "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
        },
        "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
        }
        },
        "flat_fields": [
        "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
        "nanos": integer,
        "seconds": integer
        },
        "status": integer
    },
    "metadata": {
        "collected_objects": integer,
        "end_time": {
        "nanos": integer,
        "seconds": integer
        },
        "integration_task_id": integer,
        "integration_task_name": "string",
        "integration_task_type": {
        "category": "string",
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string",
        "required_integration_types": [
            {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
            }
        ]
        },
        "start_time": {
        "nanos": integer,
        "seconds": integer
        },
        "total_objects": integer
    },
    "progress": integer,
    "scheduled": boolean,
    "trace_uuid": "string"
    },
    "name": "string",
    "next_run": {
    "nanos": integer,
    "seconds": integer
    },
    "progress": integer,
    "schedule": {
    "every": integer,
    "every_unit": integer,
    "hour": integer,
    "minute": integer,
    "startTimeTimezoneOffsetMinutes": integer,
    "start_time": {
        "nanos": integer,
        "seconds": integer
    },
    "timezone": integer,
    "weekdays": [
        integer
    ]
    },
    "schedule_every_unit_display_name": "string",
    "trigger": "string",
    "type": {
    "category": "string",
    "display_name": "string",
    "enabled": boolean,
    "id": integer,
    "name": "string",
    "required_integration_types": [
        {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
        }
    ]
    }
}

response = falcon.create_integration_task(access_token="string",
                                          task_id=integer,
                                          data="string",
                                          override=boolean,
                                          scheduled=boolean,
                                          id=integer,
                                          integration_task=task_dictionary
                                          )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

task_dictionary = {
    "access_token": "string",
    "additional_header": "string",
    "business_application": "string",
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration": {
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "name": "string",
    "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
        "imageAddress": "string",
        "imagePullSecrets": [
            "string"
        ],
        "podLabels": [
            {
            "key": "string",
            "value": "string"
            }
        ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
    },
    "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "update_time": integer
    },
    "integration_task_type": {
    "category": "string",
    "display_name": "string",
    "enabled": boolean,
    "id": integer,
    "name": "string",
    "required_integration_types": [
        {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
        }
    ]
    },
    "latest_task_run": {
    "create_time": {
        "nanos": integer,
        "seconds": integer
    },
    "events": [
        {
        "FlatData": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
            "additional_info": "string",
            "aws": {
            "accountArn": "string",
            "region": "string"
            },
            "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
            },
            "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
            },
            "cloud_function": {
            "function_name": "string"
            },
            "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
            },
            "ec2": {
            "instance_id": "string",
            "instance_name": "string"
            },
            "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
            },
            "gcp": {
            "project": "string",
            "region": "string"
            },
            "host": {
            "address": "string"
            },
            "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
            },
            "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
            },
            "remedy": {
            "content": "string",
            "url": "string"
            },
            "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
            },
            "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
            }
        },
        "flat_fields": [
            "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
            "nanos": integer,
            "seconds": integer
        },
        "status": integer
        }
    ],
    "id": integer,
    "latest_event": {
        "FlatData": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
        "additional_info": "string",
        "aws": {
            "accountArn": "string",
            "region": "string"
        },
        "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
        },
        "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
        },
        "cloud_function": {
            "function_name": "string"
        },
        "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
        },
        "ec2": {
            "instance_id": "string",
            "instance_name": "string"
        },
        "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
        },
        "gcp": {
            "project": "string",
            "region": "string"
        },
        "host": {
            "address": "string"
        },
        "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
        },
        "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
        },
        "remedy": {
            "content": "string",
            "url": "string"
        },
        "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
        },
        "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
        }
        },
        "flat_fields": [
        "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
        "nanos": integer,
        "seconds": integer
        },
        "status": integer
    },
    "metadata": {
        "collected_objects": integer,
        "end_time": {
        "nanos": integer,
        "seconds": integer
        },
        "integration_task_id": integer,
        "integration_task_name": "string",
        "integration_task_type": {
        "category": "string",
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string",
        "required_integration_types": [
            {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
            }
        ]
        },
        "start_time": {
        "nanos": integer,
        "seconds": integer
        },
        "total_objects": integer
    },
    "progress": integer,
    "scheduled": boolean,
    "trace_uuid": "string"
    },
    "name": "string",
    "next_run": {
    "nanos": integer,
    "seconds": integer
    },
    "progress": integer,
    "schedule": {
    "every": integer,
    "every_unit": integer,
    "hour": integer,
    "minute": integer,
    "startTimeTimezoneOffsetMinutes": integer,
    "start_time": {
        "nanos": integer,
        "seconds": integer
    },
    "timezone": integer,
    "weekdays": [
        integer
    ]
    },
    "schedule_every_unit_display_name": "string",
    "trigger": "string",
    "type": {
    "category": "string",
    "display_name": "string",
    "enabled": boolean,
    "id": integer,
    "name": "string",
    "required_integration_types": [
        {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
        }
    ]
    }
}

response = falcon.CreateIntegrationTask(access_token="string",
                                        task_id=integer,
                                        data="string",
                                        override=boolean,
                                        scheduled=boolean,
                                        id=integer,
                                        integration_task=task_dictionary
                                        )
print(response)

Uber class example

from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
  "integration_task": {
    "access_token": "string",
    "additional_header": "string",
    "business_application": "string",
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration": {
      "data": "string",
      "enabled": boolean,
      "id": integer,
      "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
      },
      "name": "string",
      "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
          "imageAddress": "string",
          "imagePullSecrets": [
            "string"
          ],
          "podLabels": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
      },
      "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
      },
      "update_time": integer
    },
    "integration_task_type": {
      "category": "string",
      "display_name": "string",
      "enabled": boolean,
      "id": integer,
      "name": "string",
      "required_integration_types": [
        {
          "configured": boolean,
          "display_name": "string",
          "enabled": boolean,
          "id": integer,
          "name": "string"
        }
      ]
    },
    "latest_task_run": {
      "create_time": {
        "nanos": integer,
        "seconds": integer
      },
      "events": [
        {
          "FlatData": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "additional_data": "string",
          "data": {
            "additional_info": "string",
            "aws": {
              "accountArn": "string",
              "region": "string"
            },
            "azureSite": {
              "location": "string",
              "resourceGroup": "string",
              "siteId": "string",
              "siteKind": "string",
              "siteName": "string",
              "subscriptionId": "string"
            },
            "azureVm": {
              "id": "string",
              "region": "string",
              "resourceGroup": "string",
              "subscriptionId": "string",
              "vmName": "string"
            },
            "cloud_function": {
              "function_name": "string"
            },
            "crowdstrike_cloud_security": {
              "baseUrl": "string",
              "clientId": "string",
              "cloudProvider": "string",
              "iomID": "string",
              "policyId": integer,
              "resourceId": "string",
              "resourceType": "string"
            },
            "ec2": {
              "instance_id": "string",
              "instance_name": "string"
            },
            "ecs": {
              "clusterName": "string",
              "collectionMethod": integer,
              "resourceArn": "string",
              "resourceName": "string",
              "resourceType": "string"
            },
            "gcp": {
              "project": "string",
              "region": "string"
            },
            "host": {
              "address": "string"
            },
            "k8s": {
              "container": "string",
              "namespace": "string",
              "pod_name": "string"
            },
            "lambda": {
              "lambdaArn": "string",
              "lambdaName": "string"
            },
            "remedy": {
              "content": "string",
              "url": "string"
            },
            "snyk": {
              "apiEndpointUrl": "string",
              "appEndpointUrl": "string",
              "groupId": "string"
            },
            "sonatype": {
              "CVEId": "string",
              "applicationPublicId": "string",
              "componentNameVersion": "string",
              "iqServerUrl": "string"
            }
          },
          "flat_fields": [
            "string"
          ],
          "id": integer,
          "message": "string",
          "object": "string",
          "object_type": "string",
          "send_time": {
            "nanos": integer,
            "seconds": integer
          },
          "status": integer
        }
      ],
      "id": integer,
      "latest_event": {
        "FlatData": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
          "additional_info": "string",
          "aws": {
            "accountArn": "string",
            "region": "string"
          },
          "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
          },
          "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
          },
          "cloud_function": {
            "function_name": "string"
          },
          "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
          },
          "ec2": {
            "instance_id": "string",
            "instance_name": "string"
          },
          "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
          },
          "gcp": {
            "project": "string",
            "region": "string"
          },
          "host": {
            "address": "string"
          },
          "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
          },
          "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
          },
          "remedy": {
            "content": "string",
            "url": "string"
          },
          "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
          },
          "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
          }
        },
        "flat_fields": [
          "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
          "nanos": integer,
          "seconds": integer
        },
        "status": integer
      },
      "metadata": {
        "collected_objects": integer,
        "end_time": {
          "nanos": integer,
          "seconds": integer
        },
        "integration_task_id": integer,
        "integration_task_name": "string",
        "integration_task_type": {
          "category": "string",
          "display_name": "string",
          "enabled": boolean,
          "id": integer,
          "name": "string",
          "required_integration_types": [
            {
              "configured": boolean,
              "display_name": "string",
              "enabled": boolean,
              "id": integer,
              "name": "string"
            }
          ]
        },
        "start_time": {
          "nanos": integer,
          "seconds": integer
        },
        "total_objects": integer
      },
      "progress": integer,
      "scheduled": boolean,
      "trace_uuid": "string"
    },
    "name": "string",
    "next_run": {
      "nanos": integer,
      "seconds": integer
    },
    "progress": integer,
    "schedule": {
      "every": integer,
      "every_unit": integer,
      "hour": integer,
      "minute": integer,
      "startTimeTimezoneOffsetMinutes": integer,
      "start_time": {
        "nanos": integer,
        "seconds": integer
      },
      "timezone": integer,
      "weekdays": [
        integer
      ]
    },
    "schedule_every_unit_display_name": "string",
    "trigger": "string",
    "type": {
      "category": "string",
      "display_name": "string",
      "enabled": boolean,
      "id": integer,
      "name": "string",
      "required_integration_types": [
        {
          "configured": boolean,
          "display_name": "string",
          "enabled": boolean,
          "id": integer,
          "name": "string"
        }
      ]
    }
  }
}

response = falcon.command("CreateIntegrationTask", body=body_payload)
print(response)

Back to Table of Contents

GetIntegrationTasksMetadata

Get metadata about all integration tasks.

PEP8 method name

get_integration_tasks_metadata

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks/metadata

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
category			query	string	Category.
integration_task_types			query	integer	Integration task types.
ids			query	integer	Integration task ID to retrieve.
names			query	string	Integration task name.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_integration_tasks_metadata(category="string",
                                                 integration_task_types=integer,
                                                 ids=integer,
                                                 names="string"
                                                 )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetIntegrationTasksMetadata(category="string",
                                              integration_task_types=integer,
                                              ids=integer,
                                              names="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("GetIntegrationTasksMetadata",
                          category="string",
                          integration_task_types=integer,
                          ids=integer,
                          names="string"
                          )
print(response)

Back to Table of Contents

GetIntegrationTasksV2

Get all the integration tasks.

PEP8 method name

get_integration_tasks_v2

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks/v2

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
integration_task_type			query	integer	Integration task type.
category			query	string	Category.
offset			query	integer	Starting position from which to return records.
limit			query	integer	Maximum number of records to return.
order_by			query	string	Field to use for sorting results.
direction			query	string	Sort order direction. Allowed values: asc or desc.
integration_task_types			query	integer	Integration task types.
ids			query	integer	Integration task ID to retrieve.
names			query	string	Integration task name.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_integration_tasks_v2(integration_task_type=integer,
                                           category="string",
                                           offset=integer,
                                           limit=integer,
                                           orderBy="string",
                                           direction="string",
                                           integration_task_types=integer,
                                           ids=integer,
                                           names="string"
                                           )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetIntegrationTasksV2(integration_task_type=integer,
                                        category="string",
                                        offset=integer,
                                        limit=integer,
                                        orderBy="string",
                                        direction="string",
                                        integration_task_types=integer,
                                        ids=integer,
                                        names="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("GetIntegrationTasksV2",
                          integration_task_type=integer,
                          category="string",
                          offset=integer,
                          limit=integer,
                          orderBy="string",
                          direction="string",
                          integration_task_types=integer,
                          ids=integer,
                          names="string"
                          )
print(response)

Back to Table of Contents

UpdateIntegrationTask

Update an existing integration task by its ID

PEP8 method name

update_integration_task

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks/{ID}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
access_token			body	string	Access token.
task_id			body	integer	Task ID.
data			body	string	Task data content.
override			body	boolean	Flag indicating if this task should override other task values.
scheduled			body	boolean	Flag indicating if this task is scheduled.
id			path	dictionary	ID of the integration task to execute.
integration_task			query	integration	Full integration task detail.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

task_dictionary = {
    "access_token": "string",
    "additional_header": "string",
    "business_application": "string",
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration": {
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "name": "string",
    "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
        "imageAddress": "string",
        "imagePullSecrets": [
            "string"
        ],
        "podLabels": [
            {
            "key": "string",
            "value": "string"
            }
        ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
    },
    "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "update_time": integer
    },
    "integration_task_type": {
    "category": "string",
    "display_name": "string",
    "enabled": boolean,
    "id": integer,
    "name": "string",
    "required_integration_types": [
        {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
        }
    ]
    },
    "latest_task_run": {
    "create_time": {
        "nanos": integer,
        "seconds": integer
    },
    "events": [
        {
        "FlatData": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
            "additional_info": "string",
            "aws": {
            "accountArn": "string",
            "region": "string"
            },
            "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
            },
            "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
            },
            "cloud_function": {
            "function_name": "string"
            },
            "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
            },
            "ec2": {
            "instance_id": "string",
            "instance_name": "string"
            },
            "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
            },
            "gcp": {
            "project": "string",
            "region": "string"
            },
            "host": {
            "address": "string"
            },
            "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
            },
            "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
            },
            "remedy": {
            "content": "string",
            "url": "string"
            },
            "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
            },
            "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
            }
        },
        "flat_fields": [
            "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
            "nanos": integer,
            "seconds": integer
        },
        "status": integer
        }
    ],
    "id": integer,
    "latest_event": {
        "FlatData": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
        "additional_info": "string",
        "aws": {
            "accountArn": "string",
            "region": "string"
        },
        "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
        },
        "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
        },
        "cloud_function": {
            "function_name": "string"
        },
        "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
        },
        "ec2": {
            "instance_id": "string",
            "instance_name": "string"
        },
        "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
        },
        "gcp": {
            "project": "string",
            "region": "string"
        },
        "host": {
            "address": "string"
        },
        "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
        },
        "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
        },
        "remedy": {
            "content": "string",
            "url": "string"
        },
        "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
        },
        "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
        }
        },
        "flat_fields": [
        "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
        "nanos": integer,
        "seconds": integer
        },
        "status": integer
    },
    "metadata": {
        "collected_objects": integer,
        "end_time": {
        "nanos": integer,
        "seconds": integer
        },
        "integration_task_id": integer,
        "integration_task_name": "string",
        "integration_task_type": {
        "category": "string",
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string",
        "required_integration_types": [
            {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
            }
        ]
        },
        "start_time": {
        "nanos": integer,
        "seconds": integer
        },
        "total_objects": integer
    },
    "progress": integer,
    "scheduled": boolean,
    "trace_uuid": "string"
    },
    "name": "string",
    "next_run": {
    "nanos": integer,
    "seconds": integer
    },
    "progress": integer,
    "schedule": {
    "every": integer,
    "every_unit": integer,
    "hour": integer,
    "minute": integer,
    "startTimeTimezoneOffsetMinutes": integer,
    "start_time": {
        "nanos": integer,
        "seconds": integer
    },
    "timezone": integer,
    "weekdays": [
        integer
    ]
    },
    "schedule_every_unit_display_name": "string",
    "trigger": "string",
    "type": {
    "category": "string",
    "display_name": "string",
    "enabled": boolean,
    "id": integer,
    "name": "string",
    "required_integration_types": [
        {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
        }
    ]
    }
}

response = falcon.update_integration_task(access_token="string",
                                          task_id=integer,
                                          data="string",
                                          override=boolean,
                                          scheduled=boolean,
                                          id=integer,
                                          integration_task=task_dictionary
                                          )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

task_dictionary = {
    "access_token": "string",
    "additional_header": "string",
    "business_application": "string",
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration": {
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "name": "string",
    "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
        "imageAddress": "string",
        "imagePullSecrets": [
            "string"
        ],
        "podLabels": [
            {
            "key": "string",
            "value": "string"
            }
        ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
    },
    "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "update_time": integer
    },
    "integration_task_type": {
    "category": "string",
    "display_name": "string",
    "enabled": boolean,
    "id": integer,
    "name": "string",
    "required_integration_types": [
        {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
        }
    ]
    },
    "latest_task_run": {
    "create_time": {
        "nanos": integer,
        "seconds": integer
    },
    "events": [
        {
        "FlatData": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
            "additional_info": "string",
            "aws": {
            "accountArn": "string",
            "region": "string"
            },
            "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
            },
            "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
            },
            "cloud_function": {
            "function_name": "string"
            },
            "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
            },
            "ec2": {
            "instance_id": "string",
            "instance_name": "string"
            },
            "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
            },
            "gcp": {
            "project": "string",
            "region": "string"
            },
            "host": {
            "address": "string"
            },
            "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
            },
            "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
            },
            "remedy": {
            "content": "string",
            "url": "string"
            },
            "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
            },
            "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
            }
        },
        "flat_fields": [
            "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
            "nanos": integer,
            "seconds": integer
        },
        "status": integer
        }
    ],
    "id": integer,
    "latest_event": {
        "FlatData": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
        },
        "additional_data": "string",
        "data": {
        "additional_info": "string",
        "aws": {
            "accountArn": "string",
            "region": "string"
        },
        "azureSite": {
            "location": "string",
            "resourceGroup": "string",
            "siteId": "string",
            "siteKind": "string",
            "siteName": "string",
            "subscriptionId": "string"
        },
        "azureVm": {
            "id": "string",
            "region": "string",
            "resourceGroup": "string",
            "subscriptionId": "string",
            "vmName": "string"
        },
        "cloud_function": {
            "function_name": "string"
        },
        "crowdstrike_cloud_security": {
            "baseUrl": "string",
            "clientId": "string",
            "cloudProvider": "string",
            "iomID": "string",
            "policyId": integer,
            "resourceId": "string",
            "resourceType": "string"
        },
        "ec2": {
            "instance_id": "string",
            "instance_name": "string"
        },
        "ecs": {
            "clusterName": "string",
            "collectionMethod": integer,
            "resourceArn": "string",
            "resourceName": "string",
            "resourceType": "string"
        },
        "gcp": {
            "project": "string",
            "region": "string"
        },
        "host": {
            "address": "string"
        },
        "k8s": {
            "container": "string",
            "namespace": "string",
            "pod_name": "string"
        },
        "lambda": {
            "lambdaArn": "string",
            "lambdaName": "string"
        },
        "remedy": {
            "content": "string",
            "url": "string"
        },
        "snyk": {
            "apiEndpointUrl": "string",
            "appEndpointUrl": "string",
            "groupId": "string"
        },
        "sonatype": {
            "CVEId": "string",
            "applicationPublicId": "string",
            "componentNameVersion": "string",
            "iqServerUrl": "string"
        }
        },
        "flat_fields": [
        "string"
        ],
        "id": integer,
        "message": "string",
        "object": "string",
        "object_type": "string",
        "send_time": {
        "nanos": integer,
        "seconds": integer
        },
        "status": integer
    },
    "metadata": {
        "collected_objects": integer,
        "end_time": {
        "nanos": integer,
        "seconds": integer
        },
        "integration_task_id": integer,
        "integration_task_name": "string",
        "integration_task_type": {
        "category": "string",
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string",
        "required_integration_types": [
            {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
            }
        ]
        },
        "start_time": {
        "nanos": integer,
        "seconds": integer
        },
        "total_objects": integer
    },
    "progress": integer,
    "scheduled": boolean,
    "trace_uuid": "string"
    },
    "name": "string",
    "next_run": {
    "nanos": integer,
    "seconds": integer
    },
    "progress": integer,
    "schedule": {
    "every": integer,
    "every_unit": integer,
    "hour": integer,
    "minute": integer,
    "startTimeTimezoneOffsetMinutes": integer,
    "start_time": {
        "nanos": integer,
        "seconds": integer
    },
    "timezone": integer,
    "weekdays": [
        integer
    ]
    },
    "schedule_every_unit_display_name": "string",
    "trigger": "string",
    "type": {
    "category": "string",
    "display_name": "string",
    "enabled": boolean,
    "id": integer,
    "name": "string",
    "required_integration_types": [
        {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
        }
    ]
    }
}

response = falcon.UpdateIntegrationTask(access_token="string",
                                        task_id=integer,
                                        data="string",
                                        override=boolean,
                                        scheduled=boolean,
                                        id=integer,
                                        integration_task=task_dictionary
                                        )
print(response)

Uber class example

from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "integration_task": {
        "access_token": "string",
        "additional_header": "string",
        "business_application": "string",
        "data": "string",
        "enabled": boolean,
        "id": integer,
        "integration": {
        "data": "string",
        "enabled": boolean,
        "id": integer,
        "integration_type": {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
        },
        "name": "string",
        "node": {
            "additional_header": "string",
            "current_aws_arn": "string",
            "dashboard_url": "string",
            "id": integer,
            "last_health_check": integer,
            "name": "string",
            "node_type": "string",
            "password": "string",
            "pod_settings": {
            "imageAddress": "string",
            "imagePullSecrets": [
                "string"
            ],
            "podLabels": [
                {
                "key": "string",
                "value": "string"
                }
            ]
            },
            "proxy_address": "string",
            "type": "string",
            "useJobs": boolean,
            "username": "string"
        },
        "type": {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
        },
        "update_time": integer
        },
        "integration_task_type": {
        "category": "string",
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string",
        "required_integration_types": [
            {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
            }
        ]
        },
        "latest_task_run": {
        "create_time": {
            "nanos": integer,
            "seconds": integer
        },
        "events": [
            {
            "FlatData": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
            },
            "additional_data": "string",
            "data": {
                "additional_info": "string",
                "aws": {
                "accountArn": "string",
                "region": "string"
                },
                "azureSite": {
                "location": "string",
                "resourceGroup": "string",
                "siteId": "string",
                "siteKind": "string",
                "siteName": "string",
                "subscriptionId": "string"
                },
                "azureVm": {
                "id": "string",
                "region": "string",
                "resourceGroup": "string",
                "subscriptionId": "string",
                "vmName": "string"
                },
                "cloud_function": {
                "function_name": "string"
                },
                "crowdstrike_cloud_security": {
                "baseUrl": "string",
                "clientId": "string",
                "cloudProvider": "string",
                "iomID": "string",
                "policyId": integer,
                "resourceId": "string",
                "resourceType": "string"
                },
                "ec2": {
                "instance_id": "string",
                "instance_name": "string"
                },
                "ecs": {
                "clusterName": "string",
                "collectionMethod": integer,
                "resourceArn": "string",
                "resourceName": "string",
                "resourceType": "string"
                },
                "gcp": {
                "project": "string",
                "region": "string"
                },
                "host": {
                "address": "string"
                },
                "k8s": {
                "container": "string",
                "namespace": "string",
                "pod_name": "string"
                },
                "lambda": {
                "lambdaArn": "string",
                "lambdaName": "string"
                },
                "remedy": {
                "content": "string",
                "url": "string"
                },
                "snyk": {
                "apiEndpointUrl": "string",
                "appEndpointUrl": "string",
                "groupId": "string"
                },
                "sonatype": {
                "CVEId": "string",
                "applicationPublicId": "string",
                "componentNameVersion": "string",
                "iqServerUrl": "string"
                }
            },
            "flat_fields": [
                "string"
            ],
            "id": integer,
            "message": "string",
            "object": "string",
            "object_type": "string",
            "send_time": {
                "nanos": integer,
                "seconds": integer
            },
            "status": integer
            }
        ],
        "id": integer,
        "latest_event": {
            "FlatData": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
            },
            "additional_data": "string",
            "data": {
            "additional_info": "string",
            "aws": {
                "accountArn": "string",
                "region": "string"
            },
            "azureSite": {
                "location": "string",
                "resourceGroup": "string",
                "siteId": "string",
                "siteKind": "string",
                "siteName": "string",
                "subscriptionId": "string"
            },
            "azureVm": {
                "id": "string",
                "region": "string",
                "resourceGroup": "string",
                "subscriptionId": "string",
                "vmName": "string"
            },
            "cloud_function": {
                "function_name": "string"
            },
            "crowdstrike_cloud_security": {
                "baseUrl": "string",
                "clientId": "string",
                "cloudProvider": "string",
                "iomID": "string",
                "policyId": integer,
                "resourceId": "string",
                "resourceType": "string"
            },
            "ec2": {
                "instance_id": "string",
                "instance_name": "string"
            },
            "ecs": {
                "clusterName": "string",
                "collectionMethod": integer,
                "resourceArn": "string",
                "resourceName": "string",
                "resourceType": "string"
            },
            "gcp": {
                "project": "string",
                "region": "string"
            },
            "host": {
                "address": "string"
            },
            "k8s": {
                "container": "string",
                "namespace": "string",
                "pod_name": "string"
            },
            "lambda": {
                "lambdaArn": "string",
                "lambdaName": "string"
            },
            "remedy": {
                "content": "string",
                "url": "string"
            },
            "snyk": {
                "apiEndpointUrl": "string",
                "appEndpointUrl": "string",
                "groupId": "string"
            },
            "sonatype": {
                "CVEId": "string",
                "applicationPublicId": "string",
                "componentNameVersion": "string",
                "iqServerUrl": "string"
            }
            },
            "flat_fields": [
            "string"
            ],
            "id": integer,
            "message": "string",
            "object": "string",
            "object_type": "string",
            "send_time": {
            "nanos": integer,
            "seconds": integer
            },
            "status": integer
        },
        "metadata": {
            "collected_objects": integer,
            "end_time": {
            "nanos": integer,
            "seconds": integer
            },
            "integration_task_id": integer,
            "integration_task_name": "string",
            "integration_task_type": {
            "category": "string",
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string",
            "required_integration_types": [
                {
                "configured": boolean,
                "display_name": "string",
                "enabled": boolean,
                "id": integer,
                "name": "string"
                }
            ]
            },
            "start_time": {
            "nanos": integer,
            "seconds": integer
            },
            "total_objects": integer
        },
        "progress": integer,
        "scheduled": boolean,
        "trace_uuid": "string"
        },
        "name": "string",
        "next_run": {
        "nanos": integer,
        "seconds": integer
        },
        "progress": integer,
        "schedule": {
        "every": integer,
        "every_unit": integer,
        "hour": integer,
        "minute": integer,
        "startTimeTimezoneOffsetMinutes": integer,
        "start_time": {
            "nanos": integer,
            "seconds": integer
        },
        "timezone": integer,
        "weekdays": [
            integer
        ]
        },
        "schedule_every_unit_display_name": "string",
        "trigger": "string",
        "type": {
        "category": "string",
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string",
        "required_integration_types": [
            {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
            }
        ]
        }
    }
}

response = falcon.command("UpdateIntegrationTask", body=body_payload)
print(response)

Back to Table of Contents

DeleteIntegrationTask

Delete an existing integration task by its ID

PEP8 method name

delete_integration_task

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks/{ID}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
id			path	integer	Executor node ID.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.delete_integration_task(id=integer)
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.DeleteIntegrationTask(id=integer)
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("DeleteIntegrationTask", id=integer)
print(response)

Back to Table of Contents

RunIntegrationTask

Run an integration task by its ID

PEP8 method name

run_integration_task

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks/{ID}/run

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
access_token			body	string	Access token.
task_id			body	integer	Task ID.
data			body	string	Task data content.
override			body	boolean	Flag indicating if this task should override other task values.
scheduled			body	boolean	Flag indicating if this task is scheduled.
id			path	dictionary	ID of the integration task to execute.
category			query	string	Integration task category.
body			body	dictionary	Full body payload in JSON format.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.run_integration_task(access_token="string",
                                       task_id=integer,
                                       data="string",
                                       override=boolean,
                                       scheduled=boolean,
                                       id=integer,
                                       category="string"
                                       )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.RunIntegrationTask(access_token="string",
                                     task_id=integer,
                                     data="string",
                                     override=boolean,
                                     scheduled=boolean,
                                     id=integer,
                                     category="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
                      )

body_payload = {
  "access_token": "string",
  "category": "string",
  "data": "string",
  "override": boolean,
  "scheduled": boolean,
  "task_id": integer
}

response = falcon.command("RunIntegrationTask",
                          body=body_payload,
                          id=integer,
                          category="string"
                          )
print(response)

Back to Table of Contents

RunIntegrationTaskAdmin

Run an integration task by its ID with admin scope.

PEP8 method name

run_integration_task_admin

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks/{ID}/run/admin

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
access_token			body	string	Access token.
task_id			body	integer	Task ID.
data			body	string	Task data content.
override			body	boolean	Flag indicating if this task should override other task values.
scheduled			body	boolean	Flag indicating if this task is scheduled.
id			path	dictionary	ID of the integration task to execute.
category			query	string	Integration task category.
body			body	dictionary	Full body payload in JSON format.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.run_integration_task_admin(access_token="string",
                                             task_id=integer,
                                             data="string",
                                             override=boolean,
                                             scheduled=boolean,
                                             id=integer,
                                             category="string"
                                             )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.RunIntegrationTaskAdmin(access_token="string",
                                          task_id=integer,
                                          data="string",
                                          override=boolean,
                                          scheduled=boolean,
                                          id=integer,
                                          category="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
                      )

body_payload = {
  "access_token": "string",
  "category": "string",
  "data": "string",
  "override": boolean,
  "scheduled": boolean,
  "task_id": integer
}

response = falcon.command("RunIntegrationTaskAdmin", category="string", id=integer)

print(response)

Back to Table of Contents

RunIntegrationTaskV2

Run an integration task by its ID

PEP8 method name

run_integration_task_v2

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_tasks/{ID}/run/v2

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
access_token			body	string	Access token.
task_id			body	integer	Task ID.
data			body	string	Task data content.
override			body	boolean	Flag indicating if this task should override other task values.
scheduled			body	boolean	Flag indicating if this task is scheduled.
id			path	dictionary	ID of the integration task to execute.
category			query	string	Integration task category.
body			body	dictionary	Full body payload in JSON format.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.run_integration_task_v2(access_token="string",
                                          task_id=integer,
                                          data="string",
                                          override=boolean,
                                          scheduled=boolean,
                                          id=integer,
                                          category="string"
                                          )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.RunIntegrationTaskAdminV2(access_token="string",
                                            task_id=integer,
                                            data="string",
                                            override=boolean,
                                            scheduled=boolean,
                                            id=integer,
                                            category="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
                      )

body_payload = {
  "access_token": "string",
  "category": "string",
  "data": "string",
  "override": boolean,
  "scheduled": boolean,
  "task_id": integer
}

response = falcon.command("RunIntegrationTaskV2", category="string", id=integer)

print(response)

Back to Table of Contents

GetIntegrationTypes

Get all the integration types

PEP8 method name

get_integration_types

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integration_types

Required Scope

Content-Type

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

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_integration_types()
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetIntegrationTypes()
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("GetIntegrationTypes")
print(response)

Back to Table of Contents

GetIntegrations

Get a list of all the integrations

PEP8 method name

get_integrations

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integrations

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
integration_type			query	string	Integration type.
category			query	string	Integration category.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_integrations(integration_type="string", category="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetIntegrations(integration_type="string", category="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("GetIntegrations", integration_type="string", category="string")
print(response)

Back to Table of Contents

CreateIntegration

Create a new integration

PEP8 method name

create_integration

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integrations

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
integration			body	dictionary	Integration details in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

integration = {
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "name": "string",
    "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
            "imageAddress": "string",
            "imagePullSecrets": [
                "string"
            ],
            "podLabels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
    },
    "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "update_time": integer
}

response = falcon.create_integration(integration=integration)
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!

integration = {
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "name": "string",
    "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
            "imageAddress": "string",
            "imagePullSecrets": [
                "string"
            ],
            "podLabels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
    },
    "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "update_time": integer
}


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

response = falcon.CreateIntegration(integration=integration)
print(response)

Uber class example

from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "integration": {
        "data": "string",
        "enabled": boolean,
        "id": integer,
        "integration_type": {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
        },
        "name": "string",
        "node": {
            "additional_header": "string",
            "current_aws_arn": "string",
            "dashboard_url": "string",
            "id": integer,
            "last_health_check": integer,
            "name": "string",
            "node_type": "string",
            "password": "string",
            "pod_settings": {
                "imageAddress": "string",
                "imagePullSecrets": [
                    "string"
                ],
                "podLabels": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ]
            },
            "proxy_address": "string",
            "type": "string",
            "useJobs": boolean,
            "username": "string"
        },
        "type": {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
        },
        "update_time": integer
    }
}

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

Back to Table of Contents

GetIntegrationsV2

Get a list of all the integrations.

PEP8 method name

get_integrations_v2

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integrations/v2

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
integration_type			query	integer	Integration type.
category			query	string	Category.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_integrations_v2(integration_type=integer, category="string")

print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetIntegrationsV2(integration_type=integer, category="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("GetIntegrationsV2", integration_type=integer, category="string")

print(response)

Back to Table of Contents

UpdateIntegration

Update an existing integration by its ID

PEP8 method name

update_integration

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integrations/{ID}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
parameters			query	integer	Integration ID to update.
body			body	dictionary	Full body payload in JSON format.
overwrite_fields			body	list of strings	Fields to be overwritten.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

integration = {
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "name": "string",
    "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
            "imageAddress": "string",
            "imagePullSecrets": [
                "string"
            ],
            "podLabels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
    },
    "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "update_time": integer
}
overwrite = ["string"]

response = falcon.update_integration(id=integer,
                                     overwrite_fields=overwrite,
                                     integration=integration
                                     )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

integration = {
    "data": "string",
    "enabled": boolean,
    "id": integer,
    "integration_type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "name": "string",
    "node": {
        "additional_header": "string",
        "current_aws_arn": "string",
        "dashboard_url": "string",
        "id": integer,
        "last_health_check": integer,
        "name": "string",
        "node_type": "string",
        "password": "string",
        "pod_settings": {
            "imageAddress": "string",
            "imagePullSecrets": [
                "string"
            ],
            "podLabels": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        },
        "proxy_address": "string",
        "type": "string",
        "useJobs": boolean,
        "username": "string"
    },
    "type": {
        "configured": boolean,
        "display_name": "string",
        "enabled": boolean,
        "id": integer,
        "name": "string"
    },
    "update_time": integer
}
overwrite = ["string"]

response = falcon.UpdateIntegration(id=integer,
                                    overwrite_fields=overwrite,
                                    integration=integration
                                    )
print(response)

Uber class example

from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "integration": {
        "data": "string",
        "enabled": boolean,
        "id": integer,
        "integration_type": {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
        },
        "name": "string",
        "node": {
            "additional_header": "string",
            "current_aws_arn": "string",
            "dashboard_url": "string",
            "id": integer,
            "last_health_check": integer,
            "name": "string",
            "node_type": "string",
            "password": "string",
            "pod_settings": {
                "imageAddress": "string",
                "imagePullSecrets": [
                    "string"
                ],
                "podLabels": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ]
            },
            "proxy_address": "string",
            "type": "string",
            "useJobs": boolean,
            "username": "string"
        },
        "type": {
            "configured": boolean,
            "display_name": "string",
            "enabled": boolean,
            "id": integer,
            "name": "string"
        },
        "update_time": integer
    },
    "overwriteFields": [
        "string"
    ]
}

response = falcon.command("UpdateIntegration", body=body_payload)
print(response)

Back to Table of Contents

DeleteIntegration

Delete an existing integration by its ID

PEP8 method name

delete_integration

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/integrations/{ID}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
id			path	integer	Integration ID.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.delete_integration(id=integer)
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.DeleteIntegration(id=integer)
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("DeleteIntegration", id=integer)
print(response)

Back to Table of Contents

ExecuteQuery

Execute a query. The syntax used is identical to that of the query page.

PEP8 method name

execute_query

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/query

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
paginate			body	dictionary	Pagination detail.
query			body	string	Query to execute.
select_fields			body	dictionary	Field selection detail.
timestamp			body	integer	Timestamp.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

pagination = {
    "direction": "string",
    "limit": integer,
    "offset": integer,
    "orderBy": [
      "string"
    ]
}

selected = {
    "fields": [
      "string"
    ],
    "serviceFields": [
      "string"
    ],
    "withoutServices": boolean
}
response = falcon.execute_query(paginate=pagination,
                                query="string",
                                select_fields=selected,
                                timestamp=integer
                                )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

pagination = {
    "direction": "string",
    "limit": integer,
    "offset": integer,
    "orderBy": [
      "string"
    ]
}

selected = {
    "fields": [
      "string"
    ],
    "serviceFields": [
      "string"
    ],
    "withoutServices": boolean
}

response = falcon.ExecuteQuery(paginate=pagination,
                               query="string",
                               select_fields=selected,
                               timestamp=integer
                               )
print(response)

Uber class example

from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
  "paginate": {
    "direction": "string",
    "limit": integer,
    "offset": integer,
    "orderBy": [
      "string"
    ]
  },
  "query": "string",
  "selectFields": {
    "fields": [
      "string"
    ],
    "serviceFields": [
      "string"
    ],
    "withoutServices": boolean
  },
  "timestamp": integer
}

response = falcon.command("ExecuteQuery", body=body_payload)
print(response)

Back to Table of Contents

ServiceNowGetDeployments

Retrieve ServiceNow deployments

PEP8 method name

get_servicenow_deployments

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/servicenow/deployments

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
ql_filters			query	string	Query filter.
limit			query	integer	Maximum number of records to return.
offset			query	integer	Starting position of returned records.
order_by			query	string	Sort field.
direction			query	string	Sort direction.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_servicenow_deployments(ql_filters="string",
                                             limit=integer,
                                             offset=integer,
                                             order_by="string",
                                             direction="string"
                                             )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ServiceNowGetDeployments(ql_filters="string",
                                           limit=integer,
                                           offset=integer,
                                           order_by="string",
                                           direction="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("ServiceNowGetDeployments",
                          ql_filters="string",
                          limit=integer,
                          offset=integer,
                          order_by="string",
                          direction="string"
                          )
print(response)

Back to Table of Contents

ServiceNowGetServices

Retrieve ServiceNow services.

PEP8 method name

get_servicenow_services

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/servicenow/services

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
exclude_artifacts			query	boolean	Flag indicating if artifacts should be excluded.
ql_filters			query	string	Query filter.
limit			query	integer	Maximum number of records to return.
offset			query	integer	Starting position of returned records.
order_by			query	string	Sort field.
direction			query	string	Sort direction.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_servicenow_services(exclude_artifacts=boolean,
                                          ql_filters="string",
                                          limit=integer,
                                          offset=integer,
                                          order_by="string",
                                          direction="string"
                                          )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.ServiceNowGetServices(exclude_artifacts=boolean,
                                        ql_filters="string",
                                        limit=integer,
                                        offset=integer,
                                        order_by="string",
                                        direction="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("ServiceNowGetServices",
                          exclude_artifacts=boolean,
                          ql_filters="string",
                          limit=integer,
                          offset=integer,
                          order_by="string",
                          direction="string"
                          )
print(response)

Back to Table of Contents

GetServicesCount

Get the total amount of existing services

PEP8 method name

get_services_count

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/services/count

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
deployment_tuple_filters			body	list of dictionaries	Filter excludes and includes.
nesting_level			body	integer	Nesting level.
only_count			body	boolean	Flag indicating if result totals only should be returned.
optional_time			body	integer	Optional time.
pagination			body	dictionary	Pagination.
persistent_signatures			body	string or list of strings	Persistent signatures.
ql_filters			body	string	Query filters.
related_entities			body	list of dictionaries	Related entities.
revision_id			body	integer	Revision ID.
roles_signatures			body	string	Roles signature.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

dep_filters = [
    {
      "excludes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "includes": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
]

pagination = {
    "direction": "string",
    "limit": integer,
    "offset": integer,
    "order_by": [
        "string"
    ]
}
persistent = ["string"]
related = [
    {
        "aggregation_type": integer,
        "entity_type": integer,
        "filters": {
            "include_du_services": boolean,
            "only_du_types": boolean,
            "only_get_brokers": boolean
        },
        "groupByFields": {
            "fields": [
                "string"
            ]
        }
    }
]

response = falcon.get_services_count(deployment_tuple_filters=dep_filters,
                                     nesting_level=integer,
                                     only_count=boolean,
                                     optional_time=integer,
                                     pagination=pagination,
                                     persistent_signatures=persistent,
                                     ql_filters="string",
                                     related_entities=related,
                                     revision_id=integer,
                                     roles_signature="string"
                                     )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

dep_filters = [
    {
      "excludes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "includes": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
]

pagination = {
    "direction": "string",
    "limit": integer,
    "offset": integer,
    "order_by": [
        "string"
    ]
}
persistent = ["string"]
related = [
    {
        "aggregation_type": integer,
        "entity_type": integer,
        "filters": {
            "include_du_services": boolean,
            "only_du_types": boolean,
            "only_get_brokers": boolean
        },
        "groupByFields": {
            "fields": [
                "string"
            ]
        }
    }
]
response = falcon.GetServicesCount(deployment_tuple_filters=dep_filters,
                                   nesting_level=integer,
                                   only_count=boolean,
                                   optional_time=integer,
                                   pagination=pagination,
                                   persistent_signatures=persistent,
                                   ql_filters="string",
                                   related_entities=related,
                                   revision_id=integer,
                                   roles_signature="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
                      )

body_payload = {
  "deploymentTupleFilters": [
    {
      "excludes": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "includes": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "nestingLevel": integer,
  "onlyCount": boolean,
  "optionalTime": integer,
  "pagination": {
    "direction": "string",
    "limit": integer,
    "offset": integer,
    "order_by": [
      "string"
    ]
  },
  "persistentSignatures": [
    "string"
  ],
  "qlFilters": "string",
  "relatedEntities": [
    {
      "aggregation_type": integer,
      "entity_type": integer,
      "filters": {
        "include_du_services": boolean,
        "only_du_types": boolean,
        "only_get_brokers": boolean
      },
      "groupByFields": {
        "fields": [
          "string"
        ]
      }
    }
  ],
  "revisionId": integer,
  "rolesSignature": "string"
}

response = falcon.command("GetServicesCount", body=body_payload)
print(response)

Back to Table of Contents

GetServiceViolationTypes

Get the different types of violation

PEP8 method name

get_service_violation_types

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/services/violations/types

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
filter			body	dictionary	Filter to use for search.
optional_time			body	integer	Optional time.
revision_id			body	integer	Revision ID.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

filter_dictionary = {
    "order_by": {
      "by_field": "string",
      "direction": integer
    },
    "paginate": {
      "direction": "string",
      "limit": integer,
      "offset": integer,
      "orderBy": [
        "string"
      ]
    }
}

response = falcon.get_service_violation_types(filter=filter_dictionary,
                                              optional_time=integer,
                                              revision_id=integer
                                              )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

filter_dictionary = {
    "order_by": {
      "by_field": "string",
      "direction": integer
    },
    "paginate": {
      "direction": "string",
      "limit": integer,
      "offset": integer,
      "orderBy": [
        "string"
      ]
    }
}

response = falcon.GetServiceViolationTypes(filter=filter_dictionary,
                                           optional_time=integer,
                                           revision_id=integer
                                           )
print(response)

Uber class example

from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
  "filter": {
    "order_by": {
      "by_field": "string",
      "direction": integer
    },
    "paginate": {
      "direction": "string",
      "limit": integer,
      "offset": integer,
      "orderBy": [
        "string"
      ]
    }
  },
  "optionalTime": integer,
  "revisionId": integer
}

response = falcon.command("GetServiceViolationTypes", body=body_payload)
print(response)

Back to Table of Contents

GetTags

Get all the tags

PEP8 method name

get_tags

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/tags

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
is_unique			query	boolean	Tag is unique.
limit			query	integer	Maximum number of records to return.
offset			query	integer	Starting position of returned records.
tag_name			query	string	Tag name.
name			query	string or list_of_strings	Name.
parameters			query	dictionary	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.get_tags(is_uniquye=boolean,
                           limit=integer,
                           offset=integer,
                           tag_name="string",
                           name="string"
                           )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.GetTags(is_uniquye=boolean,
                          limit=integer,
                          offset=integer,
                          tag_name="string",
                          name="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("GetTags", 
                          is_uniquye=boolean,
                          limit=integer,
                          offset=integer,
                          tag_name="string",
                          name="string"
                          )
print(response)

Back to Table of Contents

UpsertTags

Create new or update existing tag. You can update unique tags table or regular tags table

PEP8 method name

update_tags

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/tags

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
is_sensitive			body	boolean	Flag indicating if the tag is sensitive.
persistent_signature			body	string	Tag persistent signature.
value			body	string	Tag value.
name			body	string	Tag name.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.update_tags(is_sensitive=boolean,
                              persistent_signature="string",
                              value="string",
                              name="string"
                              )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.UpsertTags(is_sensitive=boolean,
                             persistent_signature="string",
                             value="string",
                             name="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
                      )

body_payload = {
  "entries": [
    {
      "isSensitive": boolean,
      "name": "string",
      "tag_type": "string",
      "value": "string"
    }
  ]
}

response = falcon.command("UpsertTags", body=body_payload)
print(response)

Back to Table of Contents

DeleteTags

Remove existing tags

PEP8 method name

delete_tags

Endpoint

Method	Route
	/aspm-api-gateway/api/v1/tags

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	dictionary	Full body payload in JSON format.
is_sensitive			body	boolean	Flag indicating if the tag is sensitive.
persistent_signature			body	string	Tag persistent signature.
value			body	string	Tag value.
name			body	string	Tag name.

Usage

Service class example (PEP8 syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.delete_tags(is_sensitive=boolean,
                              persistent_signature="string",
                              value="string",
                              name="string"
                              )
print(response)

Service class example (Operation ID syntax)

from falconpy import ASPM

# Do not hardcode API credentials!
falcon = ASPM(client_id=CLIENT_ID,
              client_secret=CLIENT_SECRET
              )

response = falcon.DeleteTags(is_sensitive=boolean,
                             persistent_signature="string",
                             value="string",
                             name="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
                      )

body_payload = {
  "entries": [
    {
      "isSensitive": boolean,
      "persistentSignature": "string",
      "value": "string"
    }
  ],
  "name": "string"
}

response = falcon.command("DeleteTags", body=body_payload)
print(response)

Back to Table of Contents