Using the ASPM service collection
| Operation ID |
Description |
|
Create or Update Business Applications |
|
Get all the relay nodes |
|
Update an existing relay node |
|
Create a new relay node |
|
Delete a relay node |
|
Get all the integration tasks |
|
Create new integration task. |
|
Update an existing integration task by its ID |
|
Delete an existing integration task by its ID |
|
Run an integration task by its ID |
|
Get all the integration types |
|
Get a list of all the integrations |
|
Create a new integration |
|
Update an existing integration by its ID |
|
Delete an existing integration by its ID |
|
Execute a query. The syntax used is identical to that of the query page. |
|
Retrieve ServiceNow deployments. |
|
Retrieve ServiceNow services. |
|
Get the total amount of existing services |
|
Get the different types of violation |
|
Get all the tags |
|
Create new or update existing tag. You can update unique tags table or regular tags table |
|
Remove existing tags |
UpsertBusinessApplications
Create or Update Business Applications
update_business_applications
| Method |
Route |
 |
/aspm-api-gateway/api/v1/business_applications |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.UpsertBusinessApplications(name="string", persistent_signature="string")
print(response)from falconpy import APIHarnessV2
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)Get all the relay nodes
get_executor_nodes
| Method |
Route |
 |
/aspm-api-gateway/api/v1/executor_nodes |
- Consumes: application/json
- Produces: application/json
| Name |
Service |
Uber |
Type |
Data type |
Description |
| node_type |
|
|
query |
string |
Relay node type. |
| integration_type |
|
|
query |
string |
Integration type. |
| parameters |
|
|
query |
dictionary |
Full query string parameters payload in JSON format. |
Service class example (PEP8 syntax)
from falconpy import ASPM
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_executor_nodes(node_type="string", integration_type="string")
print(response)Service class example (Operation ID syntax)
from falconpy import ASPM
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.GetExecutorNodes(node_type="string", integration_type="string")
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("GetExecutorNodes", node_type="string", integration_type="string")
print(response)Update an existing relay node
update_executor_node
| Method |
Route |
|
/aspm-api-gateway/api/v1/executor_nodes |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Create a new relay node
create_executor_node
| Method |
Route |
 |
/aspm-api-gateway/api/v1/executor_nodes |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Delete a relay node
delete_node
| Method |
Route |
 |
/aspm-api-gateway/api/v1/executor_nodes/{ID} |
- Consumes: application/json
- Produces: application/json
| Name |
Service |
Uber |
Type |
Data type |
Description |
| id |
|
|
path |
integer |
Executor node ID. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.DeleteExecutorNode(id=integer)
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("DeleteExecutorNode", id=integer)
print(response)Get all the integration tasks
get_integration_tasks
| Method |
Route |
|
/aspm-api-gateway/api/v1/integration_tasks |
- Consumes: application/json
- Produces: application/json
| Name |
Service |
Uber |
Type |
Data type |
Description |
| integration_task_type |
|
|
query |
string |
Integration task type. |
| category |
|
|
query |
string |
Integration task category. |
| parameters |
|
|
query |
dictionary |
Full query string parameters payload in JSON format. |
Service class example (PEP8 syntax)
from falconpy import ASPM
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_integration_tasks(integration_task_type="string", category="string")
print(response)Service class example (Operation ID syntax)
from falconpy import ASPM
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.GetIntegrationTasks(integration_task_type="string", category="string")
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("GetIntegrationTasks", integration_task_type="string", category="string")
print(response)Create new integration task.
create_integration_task
| Method |
Route |
|
/aspm-api-gateway/api/v1/integration_tasks |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Update an existing integration task by its ID
update_integration_task
| Method |
Route |
|
/aspm-api-gateway/api/v1/integration_tasks/{ID} |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Delete an existing integration task by its ID
delete_integration_task
| Method |
Route |
|
/aspm-api-gateway/api/v1/integration_tasks/{ID} |
- Consumes: application/json
- Produces: application/json
| Name |
Service |
Uber |
Type |
Data type |
Description |
| id |
|
|
path |
integer |
Executor node ID. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.DeleteIntegrationTask(id=integer)
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("DeleteIntegrationTask", id=integer)
print(response)Run an integration task by its ID
run_integration_task
| Method |
Route |
|
/aspm-api-gateway/api/v1/integration_tasks/{ID}/run |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Get all the integration types
get_integration_types
| Method |
Route |
|
/aspm-api-gateway/api/v1/integration_types |
- Consumes: application/json
- Produces: application/json
No keywords or arguments accepted.
Service class example (PEP8 syntax)
from falconpy import ASPM
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
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.GetIntegrationTypes()
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("GetIntegrationTypes")
print(response)Get a list of all the integrations
get_integrations
| Method |
Route |
|
/aspm-api-gateway/api/v1/integrations |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.GetIntegrations(integration_type="string", category="string")
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("GetIntegrations", integration_type="string", category="string")
print(response)Create a new integration
create_integration
| Method |
Route |
|
/aspm-api-gateway/api/v1/integrations |
- Consumes: application/json
- Produces: application/json
| Name |
Service |
Uber |
Type |
Data type |
Description |
| body |
|
|
body |
dictionary |
Full body payload in JSON format. |
| integration |
|
|
body |
dictionary |
Integration details in JSON format. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Update an existing integration by its ID
update_integration
| Method |
Route |
|
/aspm-api-gateway/api/v1/integrations/{ID} |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Delete an existing integration by its ID
delete_integration
| Method |
Route |
|
/aspm-api-gateway/api/v1/integrations/{ID} |
- Consumes: application/json
- Produces: application/json
| Name |
Service |
Uber |
Type |
Data type |
Description |
| id |
|
|
path |
integer |
Integration ID. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.DeleteIntegration(id=integer)
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("DeleteIntegration", id=integer)
print(response)Execute a query. The syntax used is identical to that of the query page.
execute_query
| Method |
Route |
|
/aspm-api-gateway/api/v1/query |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Retrieve ServiceNow deployments
get_servicenow_deployments
| Method |
Route |
|
/aspm-api-gateway/api/v1/servicenow/deployments |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Retrieve ServiceNow services.
get_servicenow_services
| Method |
Route |
|
/aspm-api-gateway/api/v1/servicenow/services |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_servicenow_services(ql_filters="string",
limit=integer,
offset=integer,
order_by="string",
direction="string"
)
print(response)Service class example (Operation ID syntax)
from falconpy import ASPM
falcon = ASPM(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.ServiceNowGetServices(ql_filters="string",
limit=integer,
offset=integer,
order_by="string",
direction="string"
)
print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("ServiceNowGetServices",
ql_filters="string",
limit=integer,
offset=integer,
order_by="string",
direction="string"
)
print(response)Get the total amount of existing services
get_services_count
| Method |
Route |
|
/aspm-api-gateway/api/v1/services/count |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Get the different types of violation
get_service_violation_types
| Method |
Route |
|
/aspm-api-gateway/api/v1/services/violations/types |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Get all the tags
get_tags
| Method |
Route |
|
/aspm-api-gateway/api/v1/tags |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Create new or update existing tag. You can update unique tags table or regular tags table
update_tags
| Method |
Route |
|
/aspm-api-gateway/api/v1/tags |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)Remove existing tags
delete_tags
| Method |
Route |
|
/aspm-api-gateway/api/v1/tags |
- Consumes: application/json
- Produces: application/json
| 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. |
Service class example (PEP8 syntax)
from falconpy import ASPM
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
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)from falconpy import APIHarnessV2
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)
