Skip to main content

CrowdStrike Cloud Security Integration Guide

Overview

The CrowdStrike Cloud Security integration allows your NINA workflows to connect with CrowdStrike Falcon platform for multi-cloud protection and cloud security posture management (cspm). This integration enables automated security operations, threat detection, and incident response directly from your automation platform.

Capabilities

This integration provides access to 15 resources with 204 operations covering:

  • A S P M: Operations for A S P M
  • Cloud Aws Registration: Operations for Cloud Aws Registration
  • Cloud Azure Registration: Operations for Cloud Azure Registration
  • Cloud Connect Aws: Operations for Cloud Connect Aws
  • Cloud Oci Registration: Operations for Cloud Oci Registration
  • Cloud Policies: Operations for Cloud Policies
  • Cloud Security: Operations for Cloud Security
  • Cloud Security Assets: Operations for Cloud Security Assets
  • Cloud Security Compliance: Operations for Cloud Security Compliance
  • Cloud Security Detections: Operations for Cloud Security Detections
  • Cloud Snapshots: Operations for Cloud Snapshots
  • Cspg Iacapi: Operations for Cspg Iacapi
  • Cspm Registration: Operations for Cspm Registration
  • D4C Registration: Operations for D4C Registration
  • Saas Security: Operations for Saas Security

Credential Configuration

Before using the CrowdStrike Cloud Security integration in your workflows, you need to configure credentials for authentication.

Authentication Method

CrowdStrike Falcon uses OAuth2 Client Credentials authentication. This is a server-to-server authentication flow where you provide a Client ID and Client Secret, and the integration automatically handles token acquisition and refresh.

FieldDescriptionRequired
Client IDYour CrowdStrike API Client IDYes
Client SecretYour CrowdStrike API Client SecretYes
Base URLCrowdStrike API endpoint for your cloud regionYes

How It Works

  1. You provide the Client ID and Client Secret when creating a credential
  2. The integration exchanges these for an OAuth2 access token automatically
  3. Tokens are refreshed automatically when they expire
  4. No redirect URLs or user interaction required

CrowdStrike Cloud Regions

Select the Base URL that matches your CrowdStrike Falcon cloud region:

Cloud RegionBase URLDescription
US-1https://api.crowdstrike.comUnited States (default)
US-2https://api.us-2.crowdstrike.comUnited States (secondary)
EU-1https://api.eu-1.crowdstrike.comEuropean Union
US-GOV-1https://api.laggar.gcw.crowdstrike.comUS Government Cloud

How to Obtain API Credentials

  1. Log in to the CrowdStrike Falcon Console
  2. Navigate to Support and resources > API Clients and Keys
  3. Click Add new API client
  4. Configure the API client:
    • Client Name: A descriptive name (e.g., "NINA Integration")
    • Description: Purpose of this API client
    • API Scopes: Select the permissions required for your use case (see Required Scopes below)
  5. Click Add to create the client
  6. Copy and securely store the Client ID and Client Secret immediately

Important: The Client Secret is only displayed once at creation time. If you lose it, you must create a new API client.

Required API Scopes

The API scopes required depend on which operations you plan to use. Common scopes include:

ScopePermissionUse Case
DetectionsRead/WriteView and manage detections
HostsRead/WriteQuery and manage endpoints
IncidentsRead/WriteView and manage incidents
IOCsRead/WriteManage indicators of compromise
Prevention PoliciesRead/WriteManage prevention policies
Real Time ResponseRead/WriteExecute RTR commands
Sensor Update PoliciesRead/WriteManage sensor updates

Refer to the CrowdStrike API documentation for a complete list of available scopes.

Creating a CrowdStrike Credential in NINA

  1. Navigate to the Credentials section in NINA
  2. Click Add New Credential
  3. Fill in the credential details:
    • Integration Service: Select "CrowdStrike Cloud Security"
    • Client ID: Paste your CrowdStrike API Client ID
    • Client Secret: Paste your CrowdStrike API Client Secret
    • Base URL: Select your CrowdStrike cloud region URL
  4. Click Test Connection to verify the credentials work
  5. Click Save to store the credential securely

Note: All CrowdStrike integrations (EDR, Intel, Platform, etc.) share the same credential. You only need to create one credential to use across all CrowdStrike modules.

Supported Resources

ResourceDescriptionOperations
A S P MOperations for A S P M54
Cloud Aws RegistrationOperations for Cloud Aws Registration5
Cloud Azure RegistrationOperations for Cloud Azure Registration7
Cloud Connect AwsOperations for Cloud Connect Aws9
Cloud Oci RegistrationOperations for Cloud Oci Registration7
Cloud PoliciesOperations for Cloud Policies22
Cloud SecurityOperations for Cloud Security6
Cloud Security AssetsOperations for Cloud Security Assets3
Cloud Security ComplianceOperations for Cloud Security Compliance2
Cloud Security DetectionsOperations for Cloud Security Detections2
Cloud SnapshotsOperations for Cloud Snapshots6
Cspg IacapiOperations for Cspg Iacapi2
Cspm RegistrationOperations for Cspm Registration38
D4C RegistrationOperations for D4C Registration20
Saas SecurityOperations for Saas Security21

Resource Details

A S P M

Operations for A S P M

Operations

OperationNameDescription
create_executor_nodeCreate Executor NodeSDK: a_s_p_m.CreateExecutorNode
create_integrationCreate IntegrationSDK: a_s_p_m.CreateIntegration
create_integration_taskCreate Integration TaskSDK: a_s_p_m.CreateIntegrationTask
delete_executor_nodeDelete Executor NodeSDK: a_s_p_m.DeleteExecutorNode
delete_group_id09Delete Group Id09SDK: a_s_p_m.DeleteGroupID09
delete_integrationDelete IntegrationSDK: a_s_p_m.DeleteIntegration
delete_integration_taskDelete Integration TaskSDK: a_s_p_m.DeleteIntegrationTask
delete_tagsDelete TagsSDK: a_s_p_m.DeleteTags
execute_function_dataExecute Function DataSDK: a_s_p_m.ExecuteFunctionData
execute_function_data_countExecute Function Data CountSDK: a_s_p_m.ExecuteFunctionDataCount
execute_functionsExecute FunctionsSDK: a_s_p_m.ExecuteFunctions
execute_functions_countExecute Functions CountSDK: a_s_p_m.ExecuteFunctionsCount
execute_functions_overtimeExecute Functions OvertimeSDK: a_s_p_m.ExecuteFunctionsOvertime
get_cloud_security_integration_stateGet Cloud Security Integration StateSDK: a_s_p_m.GetCloudSecurityIntegrationState
get_cspminventory_baservicesGet Cspminventory BaservicesSDK: a_s_p_m.GetCSPMInventoryBAServices
get_cspminventory_service_detailsGet Cspminventory Service DetailsSDK: a_s_p_m.GetCSPMInventoryServiceDetails
get_executor_nodesGet Executor NodesSDK: a_s_p_m.GetExecutorNodes
get_executor_nodes_id09instances_csvGet Executor Nodes Id09Instances CsvSDK: a_s_p_m.GetExecutorNodesID09InstancesCsv
get_executor_nodes_metadataGet Executor Nodes MetadataSDK: a_s_p_m.GetExecutorNodesMetadata
get_group_id09v2Get Group Id09V2SDK: a_s_p_m.GetGroupID09V2
get_groups_hier_v2Get Groups Hier V2SDK: a_s_p_m.GetGroupsHierV2
get_groups_list_v2Get Groups List V2SDK: a_s_p_m.GetGroupsListV2
get_integration_tasksGet Integration TasksSDK: a_s_p_m.GetIntegrationTasks
get_integration_tasks_adminGet Integration Tasks AdminSDK: a_s_p_m.GetIntegrationTasksAdmin
get_integration_tasks_metadataGet Integration Tasks MetadataSDK: a_s_p_m.GetIntegrationTasksMetadata
get_integration_tasks_v2Get Integration Tasks V2SDK: a_s_p_m.GetIntegrationTasksV2
get_integration_typesGet Integration TypesSDK: a_s_p_m.GetIntegrationTypes
get_integrationsGet IntegrationsSDK: a_s_p_m.GetIntegrations
get_integrations_v2Get Integrations V2SDK: a_s_p_m.GetIntegrationsV2
get_service_artifactsGet Service ArtifactsSDK: a_s_p_m.GetServiceArtifacts
get_service_violation_typesGet Service Violation TypesSDK: a_s_p_m.GetServiceViolationTypes
get_services_countGet Services CountSDK: a_s_p_m.GetServicesCount
get_tagsGet TagsSDK: a_s_p_m.GetTags
get_users_v2Get Users V2SDK: a_s_p_m.GetUsersV2
list_executeList ExecuteSDK: a_s_p_m.ExecuteQuery
list_execute_function_dataList Execute Function DataSDK: a_s_p_m.ExecuteFunctionDataQuery
list_execute_function_data_countList Execute Function Data CountSDK: a_s_p_m.ExecuteFunctionDataQueryCount
list_execute_functionsList Execute FunctionsSDK: a_s_p_m.ExecuteFunctionsQuery
list_execute_functions_countList Execute Functions CountSDK: a_s_p_m.ExecuteFunctionsQueryCount
list_execute_functions_overtimeList Execute Functions OvertimeSDK: a_s_p_m.ExecuteFunctionsQueryOvertime
post_group_id09update_defaultPost Group Id09Update DefaultSDK: a_s_p_m.PostGroupID09UpdateDefault
post_group_id09v2Post Group Id09V2SDK: a_s_p_m.PostGroupID09V2
post_group_v2Post Group V2SDK: a_s_p_m.PostGroupV2
run_integration_taskRun Integration TaskSDK: a_s_p_m.RunIntegrationTask
run_integration_task_adminRun Integration Task AdminSDK: a_s_p_m.RunIntegrationTaskAdmin
run_integration_task_v2Run Integration Task V2SDK: a_s_p_m.RunIntegrationTaskV2
service_now_get_deploymentsService Now Get DeploymentsSDK: a_s_p_m.ServiceNowGetDeployments
service_now_get_servicesService Now Get ServicesSDK: a_s_p_m.ServiceNowGetServices
set_cloud_security_integration_stateSet Cloud Security Integration StateSDK: a_s_p_m.SetCloudSecurityIntegrationState
update_executor_nodeUpdate Executor NodeSDK: a_s_p_m.UpdateExecutorNode
update_integrationUpdate IntegrationSDK: a_s_p_m.UpdateIntegration
update_integration_taskUpdate Integration TaskSDK: a_s_p_m.UpdateIntegrationTask
upsert_business_applicationsUpsert Business ApplicationsSDK: a_s_p_m.UpsertBusinessApplications
upsert_tagsUpsert TagsSDK: a_s_p_m.UpsertTags

Create Executor Node

SDK: a_s_p_m.CreateExecutorNode

Parameters:

NameTypeRequiredDescription
additional_headerstringNoadditional header. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...
current_aws_arnstringNocurrent aws arn. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
dashboard_urlstringNodashboard url. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idstringNo
last_health_checknumberNolast health check. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...
namestringNoname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
node_typestringNonode type. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
passwordstringNopassword. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
pod_settingsobjectNopod settings. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
proxy_addressstringNoproxy address. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
statusobjectNostatus. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
typestringNotype. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
useJobsbooleanNouse jobs
usernamestringNousername. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"additional_header": "<additional_header>",
"current_aws_arn": "<current_aws_arn>",
"dashboard_url": "<dashboard_url>",
"id": "<id>",
"last_health_check": 10,
"name": "<name>",
"node_type": "<node_type>",
"password": "<password>",
"pod_settings": {},
"proxy_address": "<proxy_address>",
"status": {},
"type": "<type>",
"useJobs": true,
"username": "<username>"
}

Create Integration

SDK: a_s_p_m.CreateIntegration

Parameters:

NameTypeRequiredDescription
integrationobjectNointegration. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"integration": {}
}

Create Integration Task

SDK: a_s_p_m.CreateIntegrationTask

Parameters:

NameTypeRequiredDescription
integration_taskobjectNointegration task. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"integration_task": {}
}

Delete Executor Node

SDK: a_s_p_m.DeleteExecutorNode

Parameters:

NameTypeRequiredDescription
idnumberNoID.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"id": 10
}

Delete Group Id09

SDK: a_s_p_m.DeleteGroupID09

Parameters:

NameTypeRequiredDescription
idnumberNoGroup ID

Example:

{
"id": 10
}

Delete Integration

SDK: a_s_p_m.DeleteIntegration

Parameters:

NameTypeRequiredDescription
idnumberNoID.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"id": 10
}

Delete Integration Task

SDK: a_s_p_m.DeleteIntegrationTask

Parameters:

NameTypeRequiredDescription
idnumberNoID.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"id": 10
}

Delete Tags

SDK: a_s_p_m.DeleteTags

Parameters:

NameTypeRequiredDescription
entriesobjectYesentries. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namestringYesname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"entries": {},
"name": "<name>"
}

Execute Function Data

SDK: a_s_p_m.ExecuteFunctionData

Parameters:

NameTypeRequiredDescription
fieldstringNoField.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"field": "<field>"
}

Execute Function Data Count

SDK: a_s_p_m.ExecuteFunctionDataCount

Parameters:

NameTypeRequiredDescription
aws_lambda_arnstringNorequired for 'aws' cloud provider
azure_function_app_namestringNorequired for 'azure' cloud provider
azure_site_resource_groupstringNorequired for 'azure' cloud provider
azure_site_subscription_idstringNorequired for 'azure' cloud provider
cloud_providerstringNoCloudProvider.
gcp_cloud_function_urlstringNorequired for 'gcp' cloud provider
query_namestringNoQueryName.

Example:

{
"aws_lambda_arn": "<aws_lambda_arn>",
"azure_function_app_name": "<azure_function_app_name>",
"azure_site_resource_group": "<azure_site_resource_group>",
"azure_site_subscription_id": "<azure_site_subscription_id>",
"cloud_provider": "<cloud_provider>",
"gcp_cloud_function_url": "<gcp_cloud_function_url>",
"query_name": "<query_name>"
}

Execute Functions

SDK: a_s_p_m.ExecuteFunctions

Parameters:

NameTypeRequiredDescription
fieldstringNoField.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"field": "<field>"
}

Execute Functions Count

SDK: a_s_p_m.ExecuteFunctionsCount

Parameters:

NameTypeRequiredDescription
cidarrayNorequired for 'azure' cloud provider
cloud_account_idarrayNorequired for 'aws' cloud provider
cloud_providerarrayNoCloudProvider.
query_namestringNoQueryName.
regionarrayNorequired for 'gcp' cloud provider

Example:

{
"cid": ["<cid>"],
"cloud_account_id": ["<cloud_account_id>"],
"cloud_provider": ["<cloud_provider>"],
"query_name": "<query_name>",
"region": ["<region>"]
}

Execute Functions Overtime

SDK: a_s_p_m.ExecuteFunctionsOvertime

Parameters:

NameTypeRequiredDescription
fieldstringNoField.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"field": "<field>"
}

Get Cloud Security Integration State

SDK: a_s_p_m.GetCloudSecurityIntegrationState

This operation has no parameters.

Example:

{
}

Get Cspminventory Baservices

SDK: a_s_p_m.GetCSPMInventoryBAServices

Parameters:

NameTypeRequiredDescription
business_application_namestringNoBusiness application name
limitnumberNoPagination limit
offsetnumberNoPagination offset

Example:

{
"business_application_name": "<business_application_name>",
"limit": 10,
"offset": 10
}

Get Cspminventory Service Details

SDK: a_s_p_m.GetCSPMInventoryServiceDetails

Parameters:

NameTypeRequiredDescription
persistent_signaturestringNoService signature

Example:

{
"persistent_signature": "<persistent_signature>"
}

Get Executor Nodes

SDK: a_s_p_m.GetExecutorNodes

Parameters:

NameTypeRequiredDescription
directionstringNoDirection.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
executor_node_idsarrayNoexecutor node ids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...
executor_node_namesarrayNoexecutor node names. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/op...
executor_node_statesarrayNoexecutor node states
executor_node_typesarrayNoexecutor node types. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/op...
integration_typenumberNoIntegrationType.
limitnumberNoLimit.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
node_typestringNoNodeType.
offsetnumberNoOffset.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
order_bystringNoOrderBy.

Example:

{
"direction": "<direction>",
"executor_node_ids": ["<executor_node_ids>"],
"executor_node_names": ["<executor_node_names>"],
"executor_node_states": ["<executor_node_states>"],
"executor_node_types": ["<executor_node_types>"],
"integration_type": 10,
"limit": 10,
"node_type": "<node_type>",
"offset": 10,
"order_by": "<order_by>"
}

Get Executor Nodes Id09Instances Csv

SDK: a_s_p_m.GetExecutorNodesID09InstancesCsv

Parameters:

NameTypeRequiredDescription
additional_headerstringNoadditional header. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...
current_aws_arnstringNocurrent aws arn. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
dashboard_urlstringNodashboard url. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idstringNo
last_health_checknumberNolast health check. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...
namestringNoname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
node_typestringNonode type. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
passwordstringNopassword. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
pod_settingsobjectNopod settings. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
proxy_addressstringNoproxy address. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
statusobjectNostatus. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
typestringNotype. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
useJobsbooleanNouse jobs
usernamestringNousername. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"additional_header": "<additional_header>",
"current_aws_arn": "<current_aws_arn>",
"dashboard_url": "<dashboard_url>",
"id": "<id>",
"last_health_check": 10,
"name": "<name>",
"node_type": "<node_type>",
"password": "<password>",
"pod_settings": {},
"proxy_address": "<proxy_address>",
"status": {},
"type": "<type>",
"useJobs": true,
"username": "<username>"
}

Get Executor Nodes Metadata

SDK: a_s_p_m.GetExecutorNodesMetadata

Parameters:

NameTypeRequiredDescription
executor_node_idsarrayNoexecutor node ids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...
executor_node_namesarrayNoexecutor node names. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/op...
executor_node_statesarrayNoexecutor node states
executor_node_typesarrayNoexecutor node types. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/op...

Example:

{
"executor_node_ids": ["<executor_node_ids>"],
"executor_node_names": ["<executor_node_names>"],
"executor_node_states": ["<executor_node_states>"],
"executor_node_types": ["<executor_node_types>"]
}

Get Group Id09V2

SDK: a_s_p_m.GetGroupID09V2

Parameters:

NameTypeRequiredDescription
idnumberNoGroup ID

Example:

{
"id": 10
}

Get Groups Hier V2

SDK: a_s_p_m.GetGroupsHierV2

This operation has no parameters.

Example:

{
}

Get Groups List V2

SDK: a_s_p_m.GetGroupsListV2

Parameters:

NameTypeRequiredDescription
typestringNoGroup types to query - can either be empty (all), parents, children

Example:

{
"type": "<type>"
}

Get Integration Tasks

SDK: a_s_p_m.GetIntegrationTasks

Parameters:

NameTypeRequiredDescription
categorystringNoCategory.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
directionstringNoDirection.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idsnumberNoIds.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_task_typenumberNoIntegrationTaskType.
integration_task_typesnumberNoIntegrationTaskTypes.
limitnumberNoLimit.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namesstringNoNames.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
offsetnumberNoOffset.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
order_bystringNoOrderBy.

Example:

{
"category": "<category>",
"direction": "<direction>",
"ids": 10,
"integration_task_type": 10,
"integration_task_types": 10,
"limit": 10,
"names": "<names>",
"offset": 10,
"order_by": "<order_by>"
}

Get Integration Tasks Admin

SDK: a_s_p_m.GetIntegrationTasksAdmin

Parameters:

NameTypeRequiredDescription
categorystringNoCategory.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
directionstringNoDirection.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idsnumberNoIds.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_task_typenumberNoIntegrationTaskType.
integration_task_typesnumberNoIntegrationTaskTypes.
limitnumberNoLimit.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namesstringNoNames.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
offsetnumberNoOffset.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
order_bystringNoOrderBy.

Example:

{
"category": "<category>",
"direction": "<direction>",
"ids": 10,
"integration_task_type": 10,
"integration_task_types": 10,
"limit": 10,
"names": "<names>",
"offset": 10,
"order_by": "<order_by>"
}

Get Integration Tasks Metadata

SDK: a_s_p_m.GetIntegrationTasksMetadata

Parameters:

NameTypeRequiredDescription
categorystringNoCategory.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idsnumberNoIds.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_task_typesnumberNoIntegrationTaskTypes.
namesstringNoNames.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"category": "<category>",
"ids": 10,
"integration_task_types": 10,
"names": "<names>"
}

Get Integration Tasks V2

SDK: a_s_p_m.GetIntegrationTasksV2

Parameters:

NameTypeRequiredDescription
categorystringNoCategory.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
directionstringNoDirection.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idsnumberNoIds.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_task_typenumberNoIntegrationTaskType.
integration_task_typesnumberNoIntegrationTaskTypes.
limitnumberNoLimit.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namesstringNoNames.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
offsetnumberNoOffset.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
order_bystringNoOrderBy.

Example:

{
"category": "<category>",
"direction": "<direction>",
"ids": 10,
"integration_task_type": 10,
"integration_task_types": 10,
"limit": 10,
"names": "<names>",
"offset": 10,
"order_by": "<order_by>"
}

Get Integration Types

SDK: a_s_p_m.GetIntegrationTypes

This operation has no parameters.

Example:

{
}

Get Integrations

SDK: a_s_p_m.GetIntegrations

Parameters:

NameTypeRequiredDescription
categorystringNoCategory.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_typenumberNoIntegrationType.

Example:

{
"category": "<category>",
"integration_type": 10
}

Get Integrations V2

SDK: a_s_p_m.GetIntegrationsV2

Parameters:

NameTypeRequiredDescription
categorystringNoCategory.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_typenumberNoIntegrationType.

Example:

{
"category": "<category>",
"integration_type": 10
}

Get Service Artifacts

SDK: a_s_p_m.GetServiceArtifacts

Parameters:

NameTypeRequiredDescription
directionstringNoDirection.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
limitnumberNoLimit.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
offsetnumberNoOffset.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
optional_timenumberNoOptionalTime.
order_byarrayNoOrderBy.
persistent_signaturestringNoPersistentSignature.
revision_idnumberNoRevisionID.

Example:

{
"direction": "<direction>",
"limit": 10,
"offset": 10,
"optional_time": 10,
"order_by": ["<order_by>"],
"persistent_signature": "<persistent_signature>",
"revision_id": 10
}

Get Service Violation Types

SDK: a_s_p_m.GetServiceViolationTypes

Parameters:

NameTypeRequiredDescription
filterobjectNofilter. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
optionalTimenumberNooptional time
revisionIdnumberNorevision Id

Example:

{
"filter": {},
"optionalTime": 10,
"revisionId": 10
}

Get Services Count

SDK: a_s_p_m.GetServicesCount

Parameters:

NameTypeRequiredDescription
cidsarrayYescids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
deploymentTupleFiltersobjectYesdeployment tuple filters
nestingLevelnumberNonesting level
onlyCountbooleanNoonly count
optionalTimenumberNooptional time
paginationobjectNopagination. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
persistentSignaturesarrayYespersistent signatures
qlFiltersstringNoql filters
relatedEntitiesobjectYesrelated entities
revisionIdnumberNorevision Id
rolesSignaturestringNoroles signature

Example:

{
"cids": ["<cids>"],
"deploymentTupleFilters": {},
"nestingLevel": 10,
"onlyCount": true,
"optionalTime": 10,
"pagination": {},
"persistentSignatures": ["<persistentSignatures>"],
"qlFilters": "<qlFilters>",
"relatedEntities": {},
"revisionId": 10,
"rolesSignature": "<rolesSignature>"
}

Get Tags

SDK: a_s_p_m.GetTags

Parameters:

NameTypeRequiredDescription
is_uniquebooleanNoIsUnique.
limitnumberNoLimit.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namearrayNoName.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
offsetnumberNoOffset.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
tag_namestringNoTagName.

Example:

{
"is_unique": true,
"limit": 10,
"name": ["<name>"],
"offset": 10,
"tag_name": "<tag_name>"
}

Get Users V2

SDK: a_s_p_m.GetUsersV2

Parameters:

NameTypeRequiredDescription
paginationstringNoURL encoded pagination JSON - limit, offset, direction, orderBy

Example:

{
"pagination": "<pagination>"
}

List Execute

SDK: a_s_p_m.ExecuteQuery

Parameters:

NameTypeRequiredDescription
paginateobjectNopaginate. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
querystringYesquery. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
revisionIdnumberNorevision Id
selectFieldsobjectNoselect fields
timestampnumberNotimestamp. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"paginate": {},
"query": "<query>",
"revisionId": 10,
"selectFields": {},
"timestamp": 10
}

List Execute Function Data

SDK: a_s_p_m.ExecuteFunctionDataQuery

Parameters:

NameTypeRequiredDescription
fieldstringNoField.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"field": "<field>"
}

List Execute Function Data Count

SDK: a_s_p_m.ExecuteFunctionDataQueryCount

Parameters:

NameTypeRequiredDescription
fieldstringNoField.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"field": "<field>"
}

List Execute Functions

SDK: a_s_p_m.ExecuteFunctionsQuery

Parameters:

NameTypeRequiredDescription
fieldstringNoField.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"field": "<field>"
}

List Execute Functions Count

SDK: a_s_p_m.ExecuteFunctionsQueryCount

Parameters:

NameTypeRequiredDescription
fieldstringNoField.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"field": "<field>"
}

List Execute Functions Overtime

SDK: a_s_p_m.ExecuteFunctionsQueryOvertime

Parameters:

NameTypeRequiredDescription
fieldstringNoField.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"field": "<field>"
}

Post Group Id09Update Default

SDK: a_s_p_m.PostGroupID09UpdateDefault

Parameters:

NameTypeRequiredDescription
idnumberNoGroup ID

Example:

{
"id": 10
}

Post Group Id09V2

SDK: a_s_p_m.PostGroupID09V2

Parameters:

NameTypeRequiredDescription
childrenarrayYeschildren. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
descriptionstringNodescription. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
groupIdnumberNogroup Id
groupTypestringNogroup type
isDefaultbooleanNois default
namestringNoname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
parentIdnumberNoparent Id
scopestringNoscope. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"children": ["<children>"],
"description": "<description>",
"groupId": 10,
"groupType": "<groupType>",
"isDefault": true,
"name": "<name>",
"parentId": 10,
"scope": "<scope>"
}

Post Group V2

SDK: a_s_p_m.PostGroupV2

Parameters:

NameTypeRequiredDescription
childrenarrayYeschildren. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
descriptionstringNodescription. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
groupTypestringNogroup type
isDefaultbooleanNois default
namestringNoname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
parentIdnumberNoparent Id
scopestringNoscope. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"children": ["<children>"],
"description": "<description>",
"groupType": "<groupType>",
"isDefault": true,
"name": "<name>",
"parentId": 10,
"scope": "<scope>"
}

Run Integration Task

SDK: a_s_p_m.RunIntegrationTask

Parameters:

NameTypeRequiredDescription
access_tokenstringNoaccess token. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
categorystringNocategory. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
datastringNodata. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
overridebooleanNooverride. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
scheduledbooleanNoscheduled. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
task_idnumberNotask id. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"access_token": "<access_token>",
"category": "<category>",
"data": "<data>",
"override": true,
"scheduled": true,
"task_id": 10
}

Run Integration Task Admin

SDK: a_s_p_m.RunIntegrationTaskAdmin

Parameters:

NameTypeRequiredDescription
access_tokenstringNoaccess token. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
categorystringNocategory. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
datastringNodata. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
overridebooleanNooverride. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
scheduledbooleanNoscheduled. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
task_idnumberNotask id. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"access_token": "<access_token>",
"category": "<category>",
"data": "<data>",
"override": true,
"scheduled": true,
"task_id": 10
}

Run Integration Task V2

SDK: a_s_p_m.RunIntegrationTaskV2

Parameters:

NameTypeRequiredDescription
access_tokenstringNoaccess token. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
categorystringNocategory. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
datastringNodata. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
overridebooleanNooverride. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
scheduledbooleanNoscheduled. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
task_idnumberNotask id. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"access_token": "<access_token>",
"category": "<category>",
"data": "<data>",
"override": true,
"scheduled": true,
"task_id": 10
}

Service Now Get Deployments

SDK: a_s_p_m.ServiceNowGetDeployments

Parameters:

NameTypeRequiredDescription
directionstringNoDirection.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
limitnumberNoLimit.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
offsetnumberNoOffset.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
order_bystringNoOrderBy.
ql_filtersstringNoQlFilters.

Example:

{
"direction": "<direction>",
"limit": 10,
"offset": 10,
"order_by": "<order_by>",
"ql_filters": "<ql_filters>"
}

Service Now Get Services

SDK: a_s_p_m.ServiceNowGetServices

Parameters:

NameTypeRequiredDescription
directionstringNoDirection.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
exclude_artifactsbooleanNoExcludeArtifacts.
limitnumberNoLimit.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
offsetnumberNoOffset.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
order_bystringNoOrderBy.
ql_filtersstringNoQlFilters.

Example:

{
"direction": "<direction>",
"exclude_artifacts": true,
"limit": 10,
"offset": 10,
"order_by": "<order_by>",
"ql_filters": "<ql_filters>"
}

Set Cloud Security Integration State

SDK: a_s_p_m.SetCloudSecurityIntegrationState

Parameters:

NameTypeRequiredDescription
isEnabledbooleanYesis enabled

Example:

{
"isEnabled": true
}

Update Executor Node

SDK: a_s_p_m.UpdateExecutorNode

Parameters:

NameTypeRequiredDescription
additional_headerstringNoadditional header. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...
current_aws_arnstringNocurrent aws arn. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
dashboard_urlstringNodashboard url. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idstringNo
last_health_checknumberNolast health check. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/open...
namestringNoname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
node_typestringNonode type. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
passwordstringNopassword. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
pod_settingsobjectNopod settings. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
proxy_addressstringNoproxy address. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
statusobjectNostatus. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
typestringNotype. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
useJobsbooleanNouse jobs
usernamestringNousername. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"additional_header": "<additional_header>",
"current_aws_arn": "<current_aws_arn>",
"dashboard_url": "<dashboard_url>",
"id": "<id>",
"last_health_check": 10,
"name": "<name>",
"node_type": "<node_type>",
"password": "<password>",
"pod_settings": {},
"proxy_address": "<proxy_address>",
"status": {},
"type": "<type>",
"useJobs": true,
"username": "<username>"
}

Update Integration

SDK: a_s_p_m.UpdateIntegration

Parameters:

NameTypeRequiredDescription
integrationobjectNointegration. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
overwriteFieldsarrayYesoverwrite fields

Example:

{
"integration": {},
"overwriteFields": ["<overwriteFields>"]
}

Update Integration Task

SDK: a_s_p_m.UpdateIntegrationTask

Parameters:

NameTypeRequiredDescription
integration_taskobjectNointegration task. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"integration_task": {}
}

Upsert Business Applications

SDK: a_s_p_m.UpsertBusinessApplications

Parameters:

NameTypeRequiredDescription
namestringYesname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
persistentSignaturesarrayYespersistent signatures

Example:

{
"name": "<name>",
"persistentSignatures": ["<persistentSignatures>"]
}

Upsert Tags

SDK: a_s_p_m.UpsertTags

Parameters:

NameTypeRequiredDescription
entriesobjectYesentries. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"entries": {}
}

Cloud Aws Registration

Operations for Cloud Aws Registration

Operations

OperationNameDescription
cloud_registration_aws_create_accountCloud Registration Aws Create AccountSDK: cloud_aws_registration.CloudRegistrationAwsCreateAccount
cloud_registration_aws_delete_accountCloud Registration Aws Delete AccountSDK: cloud_aws_registration.CloudRegistrationAwsDeleteAccount
cloud_registration_aws_get_accountsCloud Registration Aws Get AccountsSDK: cloud_aws_registration.CloudRegistrationAwsGetAccounts
cloud_registration_aws_update_accountCloud Registration Aws Update AccountSDK: cloud_aws_registration.CloudRegistrationAwsUpdateAccount
list_cloud_registration_aws_accountsList Cloud Registration Aws AccountsSDK: cloud_aws_registration.CloudRegistrationAwsQueryAccounts

Cloud Registration Aws Create Account

SDK: cloud_aws_registration.CloudRegistrationAwsCreateAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Cloud Registration Aws Delete Account

SDK: cloud_aws_registration.CloudRegistrationAwsDeleteAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoAWS account IDs to remove
organization_idsarrayNoAWS organization IDs to remove

Example:

{
"ids": ["<ids>"],
"organization_ids": ["<organization_ids>"]
}

Cloud Registration Aws Get Accounts

SDK: cloud_aws_registration.CloudRegistrationAwsGetAccounts

Parameters:

NameTypeRequiredDescription
idsarrayNoAWS account IDs to filter

Example:

{
"ids": ["<ids>"]
}

Cloud Registration Aws Update Account

SDK: cloud_aws_registration.CloudRegistrationAwsUpdateAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

List Cloud Registration Aws Accounts

SDK: cloud_aws_registration.CloudRegistrationAwsQueryAccounts

Parameters:

NameTypeRequiredDescription
account_statusstringNoAccount status to filter results by.
featuresarrayNoFeatures registered for an account
group_bystringNoField to group by.
limitnumberNoThe maximum number of items to return. When not specified or 0, 100 is used. When larger than 500...
offsetnumberNoThe offset to start retrieving records from.
organization_idsarrayNoOrganization IDs used to filter accounts
productsarrayNoProducts registered for an account

Example:

{
"account_status": "<account_status>",
"features": ["<features>"],
"group_by": "<group_by>",
"limit": 10,
"offset": 10,
"organization_ids": ["<organization_ids>"],
"products": ["<products>"]
}

Cloud Azure Registration

Operations for Cloud Azure Registration

Operations

OperationNameDescription
cloud_registration_azure_create_registrationCloud Registration Azure Create RegistrationSDK: cloud_azure_registration.CloudRegistrationAzureCreateRegistration
cloud_registration_azure_delete_registrationCloud Registration Azure Delete RegistrationSDK: cloud_azure_registration.CloudRegistrationAzureDeleteRegistration
cloud_registration_azure_download_scriptCloud Registration Azure Download ScriptSDK: cloud_azure_registration.CloudRegistrationAzureDownloadScript
cloud_registration_azure_get_registrationCloud Registration Azure Get RegistrationSDK: cloud_azure_registration.CloudRegistrationAzureGetRegistration
cloud_registration_azure_trigger_health_checkCloud Registration Azure Trigger Health CheckSDK: cloud_azure_registration.CloudRegistrationAzureTriggerHealthCheck
cloud_registration_azure_update_registrationCloud Registration Azure Update RegistrationSDK: cloud_azure_registration.CloudRegistrationAzureUpdateRegistration
download_azure_scriptDownload Azure ScriptSDK: cloud_azure_registration.DownloadAzureScript

Cloud Registration Azure Create Registration

SDK: cloud_azure_registration.CloudRegistrationAzureCreateRegistration

Parameters:

NameTypeRequiredDescription
resourceobjectYesresource. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"resource": {}
}

Cloud Registration Azure Delete Registration

SDK: cloud_azure_registration.CloudRegistrationAzureDeleteRegistration

Parameters:

NameTypeRequiredDescription
tenant_idsarrayNoAzure tenant IDs

Example:

{
"tenant_ids": ["<tenant_ids>"]
}

Cloud Registration Azure Download Script

SDK: cloud_azure_registration.CloudRegistrationAzureDownloadScript

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Cloud Registration Azure Get Registration

SDK: cloud_azure_registration.CloudRegistrationAzureGetRegistration

Parameters:

NameTypeRequiredDescription
tenant_idstringNoTenant ID. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"tenant_id": "<tenant_id>"
}

Cloud Registration Azure Trigger Health Check

SDK: cloud_azure_registration.CloudRegistrationAzureTriggerHealthCheck

Parameters:

NameTypeRequiredDescription
tenant_idsarrayNoAzure tenant IDs

Example:

{
"tenant_ids": ["<tenant_ids>"]
}

Cloud Registration Azure Update Registration

SDK: cloud_azure_registration.CloudRegistrationAzureUpdateRegistration

Parameters:

NameTypeRequiredDescription
resourceobjectYesresource. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"resource": {}
}

Download Azure Script

SDK: cloud_azure_registration.DownloadAzureScript

Parameters:

NameTypeRequiredDescription
tenant_idstringNoAzure tenant ID

Example:

{
"tenant_id": "<tenant_id>"
}

Cloud Connect Aws

Operations for Cloud Connect Aws

Operations

OperationNameDescription
create_or_update_awssettingsCreate Or Update AwssettingsSDK: cloud_connect_aws.CreateOrUpdateAWSSettings
delete_awsaccountsDelete AwsaccountsSDK: cloud_connect_aws.DeleteAWSAccounts
get_awsaccountsGet AwsaccountsSDK: cloud_connect_aws.GetAWSAccounts
get_awssettingsGet AwssettingsSDK: cloud_connect_aws.GetAWSSettings
list_awsaccountsList AwsaccountsSDK: cloud_connect_aws.QueryAWSAccounts
list_awsaccounts_for_idsList Awsaccounts For IdsSDK: cloud_connect_aws.QueryAWSAccountsForIDs
provision_awsaccountsProvision AwsaccountsSDK: cloud_connect_aws.ProvisionAWSAccounts
update_awsaccountsUpdate AwsaccountsSDK: cloud_connect_aws.UpdateAWSAccounts
verify_awsaccount_accessVerify Awsaccount AccessSDK: cloud_connect_aws.VerifyAWSAccountAccess

Create Or Update Awssettings

SDK: cloud_connect_aws.CreateOrUpdateAWSSettings

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Delete Awsaccounts

SDK: cloud_connect_aws.DeleteAWSAccounts

Parameters:

NameTypeRequiredDescription
idsarrayNoIDs of accounts to remove

Example:

{
"ids": ["<ids>"]
}

Get Awsaccounts

SDK: cloud_connect_aws.GetAWSAccounts

Parameters:

NameTypeRequiredDescription
idsarrayNoIDs of accounts to retrieve details

Example:

{
"ids": ["<ids>"]
}

Get Awssettings

SDK: cloud_connect_aws.GetAWSSettings

This operation has no parameters.

Example:

{
}

List Awsaccounts

SDK: cloud_connect_aws.QueryAWSAccounts

Parameters:

NameTypeRequiredDescription
filterstringNoThe filter expression that should be used to limit the results
limitnumberNoThe maximum records to return. [1-1000]. Defaults to 100. Default: 100
offsetnumberNoThe offset to start retrieving records from
sortstringNoThe property to sort by (e.g. alias.desc or state.asc)

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Awsaccounts For Ids

SDK: cloud_connect_aws.QueryAWSAccountsForIDs

Parameters:

NameTypeRequiredDescription
filterstringNoThe filter expression that should be used to limit the results
limitnumberNoThe maximum records to return. [1-1000]. Defaults to 100. Default: 100
offsetnumberNoThe offset to start retrieving records from
sortstringNoThe property to sort by (e.g. alias.desc or state.asc)

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Provision Awsaccounts

SDK: cloud_connect_aws.ProvisionAWSAccounts

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Update Awsaccounts

SDK: cloud_connect_aws.UpdateAWSAccounts

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Verify Awsaccount Access

SDK: cloud_connect_aws.VerifyAWSAccountAccess

Parameters:

NameTypeRequiredDescription
idsarrayNoIDs of accounts to verify access on

Example:

{
"ids": ["<ids>"]
}

Cloud Oci Registration

Operations for Cloud Oci Registration

Operations

OperationNameDescription
cloud_security_registration_oci_create_accountCloud Security Registration Oci Create AccountSDK: cloud_oci_registration.CloudSecurityRegistrationOciCreateAccount
cloud_security_registration_oci_delete_accountCloud Security Registration Oci Delete AccountSDK: cloud_oci_registration.CloudSecurityRegistrationOciDeleteAccount
cloud_security_registration_oci_download_scriptCloud Security Registration Oci Download ScriptSDK: cloud_oci_registration.CloudSecurityRegistrationOciDownloadScript
cloud_security_registration_oci_get_accountCloud Security Registration Oci Get AccountSDK: cloud_oci_registration.CloudSecurityRegistrationOciGetAccount
cloud_security_registration_oci_rotate_keyCloud Security Registration Oci Rotate KeySDK: cloud_oci_registration.CloudSecurityRegistrationOciRotateKey
cloud_security_registration_oci_update_accountCloud Security Registration Oci Update AccountSDK: cloud_oci_registration.CloudSecurityRegistrationOciUpdateAccount
cloud_security_registration_oci_validate_tenancyCloud Security Registration Oci Validate TenancySDK: cloud_oci_registration.CloudSecurityRegistrationOciValidateTenancy

Cloud Security Registration Oci Create Account

SDK: cloud_oci_registration.CloudSecurityRegistrationOciCreateAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Cloud Security Registration Oci Delete Account

SDK: cloud_oci_registration.CloudSecurityRegistrationOciDeleteAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoOCI tenancy ocids to remove

Example:

{
"ids": ["<ids>"]
}

Cloud Security Registration Oci Download Script

SDK: cloud_oci_registration.CloudSecurityRegistrationOciDownloadScript

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Cloud Security Registration Oci Get Account

SDK: cloud_oci_registration.CloudSecurityRegistrationOciGetAccount

Parameters:

NameTypeRequiredDescription
filterstringNoFQL (Falcon Query Language) string for filtering results. Allowed filters are Set{tenancy_name, ...
limitnumberNoMaximum number of records to return (default: 100, max: 10000) Default: 100
next_tokenstringNoToken for cursor-based pagination. Currently unsupported.
offsetnumberNoStarting index of result
sortstringNoField and direction for sorting results - allowed sort fields are Set{updated_at, tenancy_ocid, ...

Example:

{
"filter": "<filter>",
"limit": 10,
"next_token": "<next_token>",
"offset": 10,
"sort": "<sort>"
}

Cloud Security Registration Oci Rotate Key

SDK: cloud_oci_registration.CloudSecurityRegistrationOciRotateKey

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Cloud Security Registration Oci Update Account

SDK: cloud_oci_registration.CloudSecurityRegistrationOciUpdateAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Cloud Security Registration Oci Validate Tenancy

SDK: cloud_oci_registration.CloudSecurityRegistrationOciValidateTenancy

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Cloud Policies

Operations for Cloud Policies

Operations

OperationNameDescription
create_compliance_controlCreate Compliance ControlSDK: cloud_policies.CreateComplianceControl
create_compliance_frameworkCreate Compliance FrameworkSDK: cloud_policies.CreateComplianceFramework
create_rule_mixin0Create Rule Mixin0SDK: cloud_policies.CreateRuleMixin0
create_rule_overrideCreate Rule OverrideSDK: cloud_policies.CreateRuleOverride
delete_compliance_controlDelete Compliance ControlSDK: cloud_policies.DeleteComplianceControl
delete_compliance_frameworkDelete Compliance FrameworkSDK: cloud_policies.DeleteComplianceFramework
delete_rule_mixin0Delete Rule Mixin0SDK: cloud_policies.DeleteRuleMixin0
delete_rule_overrideDelete Rule OverrideSDK: cloud_policies.DeleteRuleOverride
get_compliance_controlsGet Compliance ControlsSDK: cloud_policies.GetComplianceControls
get_compliance_frameworksGet Compliance FrameworksSDK: cloud_policies.GetComplianceFrameworks
get_evaluation_resultGet Evaluation ResultSDK: cloud_policies.GetEvaluationResult
get_ruleGet RuleSDK: cloud_policies.GetRule
get_rule_overrideGet Rule OverrideSDK: cloud_policies.GetRuleOverride
list_compliance_controlsList Compliance ControlsSDK: cloud_policies.QueryComplianceControls
list_compliance_frameworksList Compliance FrameworksSDK: cloud_policies.QueryComplianceFrameworks
list_ruleList RuleSDK: cloud_policies.QueryRule
rename_section_compliance_frameworkRename Section Compliance FrameworkSDK: cloud_policies.RenameSectionComplianceFramework
replace_control_rulesReplace Control RulesSDK: cloud_policies.ReplaceControlRules
update_compliance_controlUpdate Compliance ControlSDK: cloud_policies.UpdateComplianceControl
update_compliance_frameworkUpdate Compliance FrameworkSDK: cloud_policies.UpdateComplianceFramework
update_ruleUpdate RuleSDK: cloud_policies.UpdateRule
update_rule_overrideUpdate Rule OverrideSDK: cloud_policies.UpdateRuleOverride

Create Compliance Control

SDK: cloud_policies.CreateComplianceControl

Parameters:

NameTypeRequiredDescription
descriptionstringYesdescription. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
framework_idstringYesframework id. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namestringYesname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
section_namestringYessection name. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"description": "<description>",
"framework_id": "<framework_id>",
"name": "<name>",
"section_name": "<section_name>"
}

Create Compliance Framework

SDK: cloud_policies.CreateComplianceFramework

Parameters:

NameTypeRequiredDescription
activebooleanNoactive. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
descriptionstringYesdescription. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namestringYesname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"active": true,
"description": "<description>",
"name": "<name>"
}

Create Rule Mixin0

SDK: cloud_policies.CreateRuleMixin0

Parameters:

NameTypeRequiredDescription
alert_infostringNoalert info. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
attack_typesstringNoattack types. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
controlsobjectYescontrols. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
descriptionstringYesdescription. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
domainstringYesdomain. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
logicstringYeslogic. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namestringYesname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
parent_rule_idstringYesparent rule id. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
platformstringYesplatform. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
providerstringYesprovider. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
remediation_infostringNoremediation info. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
remediation_urlstringNoremediation url. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
resource_typestringYesresource type. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
severitynumberNoseverity. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
subdomainstringYessubdomain. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"alert_info": "<alert_info>",
"attack_types": "<attack_types>",
"controls": {},
"description": "<description>",
"domain": "<domain>",
"logic": "<logic>",
"name": "<name>",
"parent_rule_id": "<parent_rule_id>",
"platform": "<platform>",
"provider": "<provider>",
"remediation_info": "<remediation_info>",
"remediation_url": "<remediation_url>",
"resource_type": "<resource_type>",
"severity": 10,
"subdomain": "<subdomain>"
}

Create Rule Override

SDK: cloud_policies.CreateRuleOverride

Parameters:

NameTypeRequiredDescription
overridesobjectYesoverrides. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"overrides": {}
}

Delete Compliance Control

SDK: cloud_policies.DeleteComplianceControl

Parameters:

NameTypeRequiredDescription
idsarrayNoThe uuids of compliance control to delete

Example:

{
"ids": ["<ids>"]
}

Delete Compliance Framework

SDK: cloud_policies.DeleteComplianceFramework

Parameters:

NameTypeRequiredDescription
idsstringNoThe uuids of compliance framework to delete

Example:

{
"ids": "<ids>"
}

Delete Rule Mixin0

SDK: cloud_policies.DeleteRuleMixin0

Parameters:

NameTypeRequiredDescription
idsarrayNoThe uuids of rules to delete

Example:

{
"ids": ["<ids>"]
}

Delete Rule Override

SDK: cloud_policies.DeleteRuleOverride

Parameters:

NameTypeRequiredDescription
idsarrayNoThe uuids of rule overrides to delete

Example:

{
"ids": ["<ids>"]
}

Get Compliance Controls

SDK: cloud_policies.GetComplianceControls

Parameters:

NameTypeRequiredDescription
idsarrayNoThe uuids of compliance controls to retrieve

Example:

{
"ids": ["<ids>"]
}

Get Compliance Frameworks

SDK: cloud_policies.GetComplianceFrameworks

Parameters:

NameTypeRequiredDescription
idsarrayNoThe uuids of compliance frameworks to retrieve

Example:

{
"ids": ["<ids>"]
}

Get Evaluation Result

SDK: cloud_policies.GetEvaluationResult

Parameters:

NameTypeRequiredDescription
logicstringYeslogic. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"logic": "<logic>"
}

Get Rule

SDK: cloud_policies.GetRule

Parameters:

NameTypeRequiredDescription
idsarrayNoThe uuids of rules to retrieve

Example:

{
"ids": ["<ids>"]
}

Get Rule Override

SDK: cloud_policies.GetRuleOverride

Parameters:

NameTypeRequiredDescription
idsarrayNoThe uuids of rule overrides to retrieve

Example:

{
"ids": ["<ids>"]
}

List Compliance Controls

SDK: cloud_policies.QueryComplianceControls

Parameters:

NameTypeRequiredDescription
filterstringNoFQL filter, allowed props: compliance_control_name compliance_control_authority *compliance_c...
limitnumberNoThe maximum number of resources to return. The maximum allowed is 500. Default: 100
offsetnumberNoThe number of results to skip before starting to return results.
sortstringNoField to sort on. Sortable fields: compliance_control_name compliance_control_authority *comp...

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Compliance Frameworks

SDK: cloud_policies.QueryComplianceFrameworks

Parameters:

NameTypeRequiredDescription
filterstringNoFQL filter, allowed properties: compliance_framework_name compliance_framework_version *compl...
limitnumberNoThe maximum number of resources to return. The maximum allowed is 500. Default: 100
offsetnumberNoThe number of results to skip before starting to return results.
sortstringNoField to sort on. Sortable fields: compliance_framework_name compliance_framework_version *co...

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

List Rule

SDK: cloud_policies.QueryRule

Parameters:

NameTypeRequiredDescription
filterstringNorule_domain rule_status rule_severity rule_short_code rule_service rule_resource_type...
limitnumberNoThe maximum number of resources to return. The maximum allowed is 500. Default: 100
offsetnumberNoThe number of results to skip before starting to return results.
sortstringNorule_severity rule_short_code rule_service rule_resource_type rule_provider *rule_subdo...

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Rename Section Compliance Framework

SDK: cloud_policies.RenameSectionComplianceFramework

Parameters:

NameTypeRequiredDescription
section_namestringYessection name. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"section_name": "<section_name>"
}

Replace Control Rules

SDK: cloud_policies.ReplaceControlRules

Parameters:

NameTypeRequiredDescription
rule_idsarrayYesrule ids. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"rule_ids": ["<rule_ids>"]
}

Update Compliance Control

SDK: cloud_policies.UpdateComplianceControl

Parameters:

NameTypeRequiredDescription
descriptionstringYesdescription. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namestringYesname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"description": "<description>",
"name": "<name>"
}

Update Compliance Framework

SDK: cloud_policies.UpdateComplianceFramework

Parameters:

NameTypeRequiredDescription
activebooleanNoactive. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
descriptionstringYesdescription. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namestringYesname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"active": true,
"description": "<description>",
"name": "<name>"
}

Update Rule

SDK: cloud_policies.UpdateRule

Parameters:

NameTypeRequiredDescription
alert_infostringNoalert info. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
attack_typesarrayYesattack types. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
categorystringNocategory. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
controlsobjectYescontrols. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
descriptionstringNodescription. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
namestringNoname. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
rule_logic_listobjectYesrule logic list. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
severitynumberNoseverity. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
uuidstringYesuuid. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"alert_info": "<alert_info>",
"attack_types": ["<attack_types>"],
"category": "<category>",
"controls": {},
"description": "<description>",
"name": "<name>",
"rule_logic_list": {},
"severity": 10,
"uuid": "<uuid>"
}

Update Rule Override

SDK: cloud_policies.UpdateRuleOverride

Parameters:

NameTypeRequiredDescription
overridesobjectYesoverrides. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"overrides": {}
}

Cloud Security

Operations for Cloud Security

Operations

OperationNameDescription
create_cloud_group_externalCreate Cloud Group ExternalSDK: cloud_security.CreateCloudGroupExternal
delete_cloud_groups_externalDelete Cloud Groups ExternalSDK: cloud_security.DeleteCloudGroupsExternal
list_cloud_group_ids_externalList Cloud Group Ids ExternalSDK: cloud_security.ListCloudGroupIDsExternal
list_cloud_groups_by_idexternalList Cloud Groups By IdexternalSDK: cloud_security.ListCloudGroupsByIDExternal
list_cloud_groups_externalList Cloud Groups ExternalSDK: cloud_security.ListCloudGroupsExternal
update_cloud_group_externalUpdate Cloud Group ExternalSDK: cloud_security.UpdateCloudGroupExternal

Create Cloud Group External

SDK: cloud_security.CreateCloudGroupExternal

Parameters:

NameTypeRequiredDescription
business_impactstringNoBusiness Impact is one of the "business context" field of the group.
business_unitstringNoBusiness Unit is one of the "business context" field of the group. Max Length: 100
descriptionstringNodescription Max Length: 1000
environmentstringNoEnvironment is one of the "business context" field of the group.
namestringYesGroup name is unique and case insensitive. Max Length: 100
ownersarrayYesThe owners field contains a list of user emails.
selectorsobjectNoThe Selectors for the cloud group.

Example:

{
"business_impact": "<business_impact>",
"business_unit": "<business_unit>",
"description": "<description>",
"environment": "<environment>",
"name": "<name>",
"owners": ["<owners>"],
"selectors": {}
}

Delete Cloud Groups External

SDK: cloud_security.DeleteCloudGroupsExternal

Parameters:

NameTypeRequiredDescription
idsarrayNoCloud Groups UUIDs to delete

Example:

{
"ids": ["<ids>"]
}

List Cloud Group Ids External

SDK: cloud_security.ListCloudGroupIDsExternal

Parameters:

NameTypeRequiredDescription
filterstringNo- name - description - created_at - updated_at Selector properties: - cloud_provider - ...
limitstringNoThe maximum number of cloud groups to retrieve. Format: int64 Default: "100"
offsetstringNoThe starting position of the list operation. Format: int64 Default: "0"
sortstringNoA valid sort string. Default: "name

Example:

{
"filter": "<filter>",
"limit": "<limit>",
"offset": "<offset>",
"sort": "<sort>"
}

List Cloud Groups By Idexternal

SDK: cloud_security.ListCloudGroupsByIDExternal

Parameters:

NameTypeRequiredDescription
idsarrayNoIds.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"ids": ["<ids>"]
}

List Cloud Groups External

SDK: cloud_security.ListCloudGroupsExternal

Parameters:

NameTypeRequiredDescription
filterstringNo- name - description - created_at - updated_at Selector properties: - cloud_provider - ...
limitstringNoThe maximum number of cloud groups to retrieve. Format: int64 Default: "100"
offsetstringNoThe starting position of the list operation. Format: int64 Default: "0"
sortstringNoA valid sort string. Default: "name

Example:

{
"filter": "<filter>",
"limit": "<limit>",
"offset": "<offset>",
"sort": "<sort>"
}

Update Cloud Group External

SDK: cloud_security.UpdateCloudGroupExternal

Parameters:

NameTypeRequiredDescription
groupobjectNoGroup.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"group": {}
}

Cloud Security Assets

Operations for Cloud Security Assets

Operations

OperationNameDescription
cloud_security_assets_combined_compliance_by_accountCloud Security Assets Combined Compliance By AccountSDK: cloud_security_assets.CloudSecurityAssetsCombinedComplianceByAccount
cloud_security_assets_entities_getCloud Security Assets Entities GetSDK: cloud_security_assets.CloudSecurityAssetsEntitiesGet
cloud_security_assets_queriesCloud Security Assets QueriesSDK: cloud_security_assets.CloudSecurityAssetsQueries

Cloud Security Assets Combined Compliance By Account

SDK: cloud_security_assets.CloudSecurityAssetsCombinedComplianceByAccount

Parameters:

NameTypeRequiredDescription
afterstringNotoken-based pagination. use for paginating through an entire result set. Use only one of 'offset'...
filterstringNo- control.benchmark.name - control.benchmark.version - control.extension.status - `control....
include_failing_iom_severity_countsbooleanNoInclude counts of failing IOMs by severity level
limitnumberNoThe maximum number of items to return. When not specified or 0, 20 is used. When larger than 1000...
offsetnumberNoOffset returned controls. Use only one of 'offset' and 'after' parameter for paginating. 'offset'...
sortstringNo- assessment_id - cloud_provider - control.benchmark.name - control.benchmark.version - `...

Example:

{
"after": "<after>",
"filter": "<filter>",
"include_failing_iom_severity_counts": true,
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Cloud Security Assets Entities Get

SDK: cloud_security_assets.CloudSecurityAssetsEntitiesGet

Parameters:

NameTypeRequiredDescription
idsarrayNoList of assets to return (maximum 100 IDs allowed). Use POST method with same path if more entiti...

Example:

{
"ids": ["<ids>"]
}

Cloud Security Assets Queries

SDK: cloud_security_assets.CloudSecurityAssetsQueries

Parameters:

NameTypeRequiredDescription
afterstringNotoken-based pagination. use for paginating through an entire result set. Use only one of 'offset'...
filterstringNo- service_category - severity - snapshot_detections - ssm_managed - status - tag_key ...
limitnumberNoThe maximum number of items to return. When not specified or 0, 500 is used. When larger than 100...
offsetnumberNoOffset returned assets. Use only one of 'offset' and 'after' parameter for paginating. 'offset' c...
sortstringNo- service_category - ssm_managed - status - tenancy_name - tenancy_ocid - `tenancy_type...

Example:

{
"after": "<after>",
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Cloud Security Compliance

Operations for Cloud Security Compliance

Operations

OperationNameDescription
cloud_compliance_framework_posture_summariesCloud Compliance Framework Posture SummariesSDK: cloud_security_compliance.CloudComplianceFrameworkPostureSummaries
cloud_compliance_rule_posture_summariesCloud Compliance Rule Posture SummariesSDK: cloud_security_compliance.CloudComplianceRulePostureSummaries

Cloud Compliance Framework Posture Summaries

SDK: cloud_security_compliance.CloudComplianceFrameworkPostureSummaries

Parameters:

NameTypeRequiredDescription
filterstringNoFQL filter, supported properties: - account_id - account_name - business_impact - `cloud_la...
idsarrayNoThe uuids of compliance frameworks to retrieve (maximum 20 IDs allowed).

Example:

{
"filter": "<filter>",
"ids": ["<ids>"]
}

Cloud Compliance Rule Posture Summaries

SDK: cloud_security_compliance.CloudComplianceRulePostureSummaries

Parameters:

NameTypeRequiredDescription
filterstringNoFQL filter, supported properties: - account_id - account_name - business_impact - `cloud_la...
idsarrayNoThe uuids of compliance rules to retrieve (maximum 350 IDs allowed).

Example:

{
"filter": "<filter>",
"ids": ["<ids>"]
}

Cloud Security Detections

Operations for Cloud Security Detections

Operations

OperationNameDescription
cspm_evaluations_iom_entitiesCspm Evaluations Iom EntitiesSDK: cloud_security_detections.CspmEvaluationsIomEntities
cspm_evaluations_iom_queriesCspm Evaluations Iom QueriesSDK: cloud_security_detections.CspmEvaluationsIomQueries

Cspm Evaluations Iom Entities

SDK: cloud_security_detections.CspmEvaluationsIomEntities

Parameters:

NameTypeRequiredDescription
idsarrayNoList of IOMs to return (maximum 100 IDs allowed). Use POST method with same path if more entities...

Example:

{
"ids": ["<ids>"]
}

Cspm Evaluations Iom Queries

SDK: cloud_security_detections.CspmEvaluationsIomQueries

Parameters:

NameTypeRequiredDescription
afterstringNotoken-based pagination. Use for paginating through an entire result set. Use only one of 'offset'...
filterstringNo- rule_id - rule_name - rule_origin - rule_remediation - section - service - `service...
limitnumberNoThe maximum number of items to return. When not specified or 0, 500 is used. When larger than 100...
offsetnumberNoOffset returned assets
sortstringNo- rule_id - rule_name - rule_origin - rule_remediation - section - service - `service...

Example:

{
"after": "<after>",
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Cloud Snapshots

Operations for Cloud Snapshots

Operations

OperationNameDescription
create_deployment_entityCreate Deployment EntitySDK: cloud_snapshots.CreateDeploymentEntity
get_credentials_mixin0mixin60Get Credentials Mixin0Mixin60SDK: cloud_snapshots.GetCredentialsMixin0Mixin60
get_scan_reportGet Scan ReportSDK: cloud_snapshots.GetScanReport
read_deployments_combinedRead Deployments CombinedSDK: cloud_snapshots.ReadDeploymentsCombined
read_deployments_entitiesRead Deployments EntitiesSDK: cloud_snapshots.ReadDeploymentsEntities
registerRegisterSDK: cloud_snapshots.Register

Create Deployment Entity

SDK: cloud_snapshots.CreateDeploymentEntity

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Get Credentials Mixin0Mixin60

SDK: cloud_snapshots.GetCredentialsMixin0Mixin60

This operation has no parameters.

Example:

{
}

Get Scan Report

SDK: cloud_snapshots.GetScanReport

Parameters:

NameTypeRequiredDescription
idsarrayNothe instance identifiers to fetch the report for

Example:

{
"ids": ["<ids>"]
}

Read Deployments Combined

SDK: cloud_snapshots.ReadDeploymentsCombined

Parameters:

NameTypeRequiredDescription
filterstringNoSearch snapshot jobs using a query in Falcon Query Language (FQL). Supported filters: account_id,...
limitnumberNoThe upper-bound on the number of records to retrieve.
offsetnumberNoThe offset from where to begin.
sortstringNoThe fields to sort the records on. Supported columns: [account_id asset_identifier cloud_provider...

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Read Deployments Entities

SDK: cloud_snapshots.ReadDeploymentsEntities

Parameters:

NameTypeRequiredDescription
idsarrayNoSearch snapshot jobs by ids - The maximum amount is 100 IDs

Example:

{
"ids": ["<ids>"]
}

Register

SDK: cloud_snapshots.Register

Parameters:

NameTypeRequiredDescription
aws_accountsobjectYesaws accounts. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"aws_accounts": {}
}

Cspg Iacapi

Operations for Cspg Iacapi

Operations

OperationNameDescription
combined_detectionsCombined DetectionsSDK: cspg_iacapi.CombinedDetections
get_credentials_mixin0Get Credentials Mixin0SDK: cspg_iacapi.GetCredentialsMixin0

Combined Detections

SDK: cspg_iacapi.CombinedDetections

Parameters:

NameTypeRequiredDescription
filterstringNoSearch IaC detections using a query in Falcon Query Language (FQL). Supported filters: detection_...
limitnumberNothe upper-bound on the number of records to retrieve
offsetnumberNoThe offset from where to begin.
sortstringNofields to sort the records on. Supported columns: [detection_uuid file_name last_detected platfor...

Example:

{
"filter": "<filter>",
"limit": 10,
"offset": 10,
"sort": "<sort>"
}

Get Credentials Mixin0

SDK: cspg_iacapi.GetCredentialsMixin0

This operation has no parameters.

Example:

{
}

Cspm Registration

Operations for Cspm Registration

Operations

OperationNameDescription
azure_download_certificateAzure Download CertificateSDK: cspm_registration.AzureDownloadCertificate
azure_refresh_certificateAzure Refresh CertificateSDK: cspm_registration.AzureRefreshCertificate
connect_cspmgcpaccountConnect CspmgcpaccountSDK: cspm_registration.ConnectCSPMGCPAccount
create_cspmaws_accountCreate Cspmaws AccountSDK: cspm_registration.CreateCSPMAwsAccount
create_cspmazure_accountCreate Cspmazure AccountSDK: cspm_registration.CreateCSPMAzureAccount
create_cspmazure_management_groupCreate Cspmazure Management GroupSDK: cspm_registration.CreateCSPMAzureManagementGroup
create_cspmgcpaccountCreate CspmgcpaccountSDK: cspm_registration.CreateCSPMGCPAccount
delete_cspmaws_accountDelete Cspmaws AccountSDK: cspm_registration.DeleteCSPMAwsAccount
delete_cspmazure_accountDelete Cspmazure AccountSDK: cspm_registration.DeleteCSPMAzureAccount
delete_cspmazure_management_groupDelete Cspmazure Management GroupSDK: cspm_registration.DeleteCSPMAzureManagementGroup
delete_cspmgcpaccountDelete CspmgcpaccountSDK: cspm_registration.DeleteCSPMGCPAccount
getGetSDK: cspm_registration.GetConfigurationDetectionEntities
get_behavior_detectionsGet Behavior DetectionsSDK: cspm_registration.GetBehaviorDetections
get_cloud_event_idsGet Cloud Event IdsSDK: cspm_registration.GetCloudEventIDs
get_configuration_detection_ids_v2Get Configuration Detection Ids V2SDK: cspm_registration.GetConfigurationDetectionIDsV2
get_configuration_detectionsGet Configuration DetectionsSDK: cspm_registration.GetConfigurationDetections
get_cspmaws_accountGet Cspmaws AccountSDK: cspm_registration.GetCSPMAwsAccount
get_cspmaws_console_setup_urlsGet Cspmaws Console Setup UrlsSDK: cspm_registration.GetCSPMAwsConsoleSetupURLs
get_cspmazure_accountGet Cspmazure AccountSDK: cspm_registration.GetCSPMAzureAccount
get_cspmazure_management_groupGet Cspmazure Management GroupSDK: cspm_registration.GetCSPMAzureManagementGroup
get_cspmazure_user_scripts_attachmentGet Cspmazure User Scripts AttachmentSDK: cspm_registration.GetCSPMAzureUserScriptsAttachment
get_cspmcgpaccountGet CspmcgpaccountSDK: cspm_registration.GetCSPMCGPAccount
get_cspmgcpservice_accounts_extGet Cspmgcpservice Accounts ExtSDK: cspm_registration.GetCSPMGCPServiceAccountsExt
get_cspmgcpuser_scripts_attachmentGet Cspmgcpuser Scripts AttachmentSDK: cspm_registration.GetCSPMGCPUserScriptsAttachment
get_cspmgcpvalidate_accounts_extGet Cspmgcpvalidate Accounts ExtSDK: cspm_registration.GetCSPMGCPValidateAccountsExt
get_cspmpolicies_detailsGet Cspmpolicies DetailsSDK: cspm_registration.GetCSPMPoliciesDetails
get_cspmpolicyGet CspmpolicySDK: cspm_registration.GetCSPMPolicy
get_cspmpolicy_settingsGet Cspmpolicy SettingsSDK: cspm_registration.GetCSPMPolicySettings
get_cspmscan_scheduleGet Cspmscan ScheduleSDK: cspm_registration.GetCSPMScanSchedule
update_cspmaws_accountUpdate Cspmaws AccountSDK: cspm_registration.PatchCSPMAwsAccount
update_cspmazure_accountUpdate Cspmazure AccountSDK: cspm_registration.UpdateCSPMAzureAccount
update_cspmazure_account_client_idUpdate Cspmazure Account Client IdSDK: cspm_registration.UpdateCSPMAzureAccountClientID
update_cspmazure_tenant_default_subscription_idUpdate Cspmazure Tenant Default Subscription IdSDK: cspm_registration.UpdateCSPMAzureTenantDefaultSubscriptionID
update_cspmgcpaccountUpdate CspmgcpaccountSDK: cspm_registration.UpdateCSPMGCPAccount
update_cspmgcpservice_accounts_extUpdate Cspmgcpservice Accounts ExtSDK: cspm_registration.UpdateCSPMGCPServiceAccountsExt
update_cspmpolicy_settingsUpdate Cspmpolicy SettingsSDK: cspm_registration.UpdateCSPMPolicySettings
update_cspmscan_scheduleUpdate Cspmscan ScheduleSDK: cspm_registration.UpdateCSPMScanSchedule
validate_cspmgcpservice_account_extValidate Cspmgcpservice Account ExtSDK: cspm_registration.ValidateCSPMGCPServiceAccountExt

Azure Download Certificate

SDK: cspm_registration.AzureDownloadCertificate

Parameters:

NameTypeRequiredDescription
tenant_idarrayNoAzure Tenant ID

Example:

{
"tenant_id": ["<tenant_id>"]
}

Azure Refresh Certificate

SDK: cspm_registration.AzureRefreshCertificate

Parameters:

NameTypeRequiredDescription
tenant_idarrayNoAzure Tenant ID
years_validstringNoYears the certificate should be valid. Max 2 Default: "1"

Example:

{
"tenant_id": ["<tenant_id>"],
"years_valid": "<years_valid>"
}

Connect Cspmgcpaccount

SDK: cspm_registration.ConnectCSPMGCPAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Create Cspmaws Account

SDK: cspm_registration.CreateCSPMAwsAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Create Cspmazure Account

SDK: cspm_registration.CreateCSPMAzureAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Create Cspmazure Management Group

SDK: cspm_registration.CreateCSPMAzureManagementGroup

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Create Cspmgcpaccount

SDK: cspm_registration.CreateCSPMGCPAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Delete Cspmaws Account

SDK: cspm_registration.DeleteCSPMAwsAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoAWS account IDs to remove
organization_idsarrayNoAWS organization IDs to remove

Example:

{
"ids": ["<ids>"],
"organization_ids": ["<organization_ids>"]
}

Delete Cspmazure Account

SDK: cspm_registration.DeleteCSPMAzureAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoAzure subscription IDs to remove
retain_tenantstringNoRetainTenant.
tenant_idsarrayNoTenant ids to remove

Example:

{
"ids": ["<ids>"],
"retain_tenant": "<retain_tenant>",
"tenant_ids": ["<tenant_ids>"]
}

Delete Cspmazure Management Group

SDK: cspm_registration.DeleteCSPMAzureManagementGroup

Parameters:

NameTypeRequiredDescription
tenant_idsarrayNoTenant ids to remove

Example:

{
"tenant_ids": ["<tenant_ids>"]
}

Delete Cspmgcpaccount

SDK: cspm_registration.DeleteCSPMGCPAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoHierarchical Resource IDs of accounts

Example:

{
"ids": ["<ids>"]
}

Get

SDK: cspm_registration.GetConfigurationDetectionEntities

Parameters:

NameTypeRequiredDescription
idsarrayNodetection ids

Example:

{
"ids": ["<ids>"]
}

Get Behavior Detections

SDK: cspm_registration.GetBehaviorDetections

Parameters:

NameTypeRequiredDescription
account_idstringNoCloud Account ID (e.g.: AWS accountID, Azure subscriptionID)
aws_account_idstringNoAWS Account ID. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
azure_subscription_idstringNoAzure Subscription ID
azure_tenant_idstringNoAzure Tenant ID. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
cloud_providerstringNoCloud Provider (e.g.: aws
date_time_sincestringNoFilter to get all events after this date, in format RFC3339 : e.g. 2006-01-02T15:04:05Z07:00
limitnumberNoThe maximum records to return. [1-500]
next_tokenstringNoString to get next page of results, is associated with a previous execution of GetBehaviorDetecti...
resource_idarrayNoResource ID. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
resource_uuidarrayNoResource UUID. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
servicestringNoCloud Service (e.g. EC2
severitystringNoPolicy Severity
sincestringNoFilter events using a duration string (e.g. 24h) Default: "24h"
statestringNoState (e.g.: open

Example:

{
"account_id": "<account_id>",
"aws_account_id": "<aws_account_id>",
"azure_subscription_id": "<azure_subscription_id>",
"azure_tenant_id": "<azure_tenant_id>",
"cloud_provider": "<cloud_provider>",
"date_time_since": "<date_time_since>",
"limit": 10,
"next_token": "<next_token>",
"resource_id": ["<resource_id>"],
"resource_uuid": ["<resource_uuid>"],
"service": "<service>",
"severity": "<severity>",
"since": "<since>",
"state": "<state>"
}

Get Cloud Event Ids

SDK: cspm_registration.GetCloudEventIDs

Parameters:

NameTypeRequiredDescription
xcsuseruuidstringNoRequester User UUID
idstringNoIOA Aggregate Event ID

Example:

{
"xcsuseruuid": "<xcsuseruuid>",
"id": "<id>"
}

Get Configuration Detection Ids V2

SDK: cspm_registration.GetConfigurationDetectionIDsV2

Parameters:

NameTypeRequiredDescription
filterstringNouse_current_scan_ids - *use this to get records for latest scans (ignored when next_token is set)...
limitnumberNoThe max number of detections to return Default: 500
next_tokenstringNoString to get next page of results. Cannot be combined with any filter except limit.
offsetnumberNoOffset returned detections. Cannot be combined with next_token filter
sortstringNoaccount_name account_id attack_types azure_subscription_id cloud_provider cloud_service_keyword s...

Example:

{
"filter": "<filter>",
"limit": 10,
"next_token": "<next_token>",
"offset": 10,
"sort": "<sort>"
}

Get Configuration Detections

SDK: cspm_registration.GetConfigurationDetections

Parameters:

NameTypeRequiredDescription
account_idstringNoAWS account ID or GCP Project Number or Azure subscription ID
azure_subscription_idstringNoAzure Subscription ID
azure_tenant_idstringNoAzure Tenant ID. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
cloud_providerstringNoCloud Provider (e.g.: aws
limitnumberNoThe maximum records to return. [1-500]
next_tokenstringNoString to get next page of results, is associated with a previous execution of GetConfigurationDe...
regionstringNoCloud Provider Region
servicestringNoCloud Service (e.g.: EBS
severitystringNoPolicy Severity
statusstringNoStatus (e.g.: new

Example:

{
"account_id": "<account_id>",
"azure_subscription_id": "<azure_subscription_id>",
"azure_tenant_id": "<azure_tenant_id>",
"cloud_provider": "<cloud_provider>",
"limit": 10,
"next_token": "<next_token>",
"region": "<region>",
"service": "<service>",
"severity": "<severity>",
"status": "<status>"
}

Get Cspmaws Account

SDK: cspm_registration.GetCSPMAwsAccount

Parameters:

NameTypeRequiredDescription
cspm_litestringNoOnly return CSPM Lite accounts
group_bystringNoField to group by.
iam_role_arnsarrayNoAWS IAM role ARNs
idsarrayNoAWS account IDs
limitnumberNoThe maximum records to return. Defaults to 100. Default: 100
migratedstringNoOnly return migrated d4c accounts
offsetnumberNoThe offset to start retrieving records from
organization_idsarrayNoAWS organization IDs
scan_typestringNoType of scan, dry or full, to perform on selected accounts
statusstringNoAccount status to filter results by.

Example:

{
"cspm_lite": "<cspm_lite>",
"group_by": "<group_by>",
"iam_role_arns": ["<iam_role_arns>"],
"ids": ["<ids>"],
"limit": 10,
"migrated": "<migrated>",
"offset": 10,
"organization_ids": ["<organization_ids>"],
"scan_type": "<scan_type>",
"status": "<status>"
}

Get Cspmaws Console Setup Urls

SDK: cspm_registration.GetCSPMAwsConsoleSetupURLs

Parameters:

NameTypeRequiredDescription
idsarrayNoAWS account IDs
regionstringNoRegion. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
tagsstringNoBase64 encoded JSON string to be used as AWS tags
templatestringNoTemplate to be rendered
use_existing_cloudtrailstringNoUseExistingCloudtrail.

Example:

{
"ids": ["<ids>"],
"region": "<region>",
"tags": "<tags>",
"template": "<template>",
"use_existing_cloudtrail": "<use_existing_cloudtrail>"
}

Get Cspmazure Account

SDK: cspm_registration.GetCSPMAzureAccount

Parameters:

NameTypeRequiredDescription
cspm_litestringNoOnly return CSPM Lite accounts
idsarrayNoSubscriptionIDs of accounts to select for this status operation. If this is empty then all accoun...
limitnumberNoThe maximum records to return. Defaults to 100. Default: 100
offsetnumberNoThe offset to start retrieving records from
scan_typestringNoType of scan, dry or full, to perform on selected accounts
statusstringNoAccount status to filter results by.
tenant_idsarrayNoTenant ids to filter azure accounts

Example:

{
"cspm_lite": "<cspm_lite>",
"ids": ["<ids>"],
"limit": 10,
"offset": 10,
"scan_type": "<scan_type>",
"status": "<status>",
"tenant_ids": ["<tenant_ids>"]
}

Get Cspmazure Management Group

SDK: cspm_registration.GetCSPMAzureManagementGroup

Parameters:

NameTypeRequiredDescription
limitnumberNoThe maximum records to return. Defaults to 100. Default: 100
offsetnumberNoThe offset to start retrieving records from
tenant_idsarrayNoTenant ids to filter azure accounts

Example:

{
"limit": 10,
"offset": 10,
"tenant_ids": ["<tenant_ids>"]
}

Get Cspmazure User Scripts Attachment

SDK: cspm_registration.GetCSPMAzureUserScriptsAttachment

Parameters:

NameTypeRequiredDescription
account_typestringNoAccountType.
azure_management_groupbooleanNoUse Azure Management Group
subscription_idsarrayNoSubscription IDs to generate script for. Defaults to all.
templatestringNoTemplate to be rendered
tenant_idstringNoTenant ID to generate script for. Defaults to most recently registered tenant.

Example:

{
"account_type": "<account_type>",
"azure_management_group": true,
"subscription_ids": ["<subscription_ids>"],
"template": "<template>",
"tenant_id": "<tenant_id>"
}

Get Cspmcgpaccount

SDK: cspm_registration.GetCSPMCGPAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoHierarchical Resource IDs of accounts
limitnumberNoThe maximum records to return. Defaults to 100. Default: 100
offsetnumberNoThe offset to start retrieving records from
parent_typestringNoGCP Hierarchy Parent Type, organization/folder/project
scan_typestringNoType of scan, dry or full, to perform on selected accounts
sortstringNoOrder fields in ascending or descending order. Ex: parent_type
statusstringNoAccount status to filter results by.

Example:

{
"ids": ["<ids>"],
"limit": 10,
"offset": 10,
"parent_type": "<parent_type>",
"scan_type": "<scan_type>",
"sort": "<sort>",
"status": "<status>"
}

Get Cspmgcpservice Accounts Ext

SDK: cspm_registration.GetCSPMGCPServiceAccountsExt

Parameters:

NameTypeRequiredDescription
idstringNoService Account ID

Example:

{
"id": "<id>"
}

Get Cspmgcpuser Scripts Attachment

SDK: cspm_registration.GetCSPMGCPUserScriptsAttachment

Parameters:

NameTypeRequiredDescription
idsarrayNoHierarchical Resource IDs of accounts
parent_typestringNoGCP Hierarchy Parent Type, organization/folder/project

Example:

{
"ids": ["<ids>"],
"parent_type": "<parent_type>"
}

Get Cspmgcpvalidate Accounts Ext

SDK: cspm_registration.GetCSPMGCPValidateAccountsExt

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Get Cspmpolicies Details

SDK: cspm_registration.GetCSPMPoliciesDetails

Parameters:

NameTypeRequiredDescription
idsarrayNoPolicy IDs

Example:

{
"ids": ["<ids>"]
}

Get Cspmpolicy

SDK: cspm_registration.GetCSPMPolicy

Parameters:

NameTypeRequiredDescription
idsnumberNoPolicy ID

Example:

{
"ids": 10
}

Get Cspmpolicy Settings

SDK: cspm_registration.GetCSPMPolicySettings

Parameters:

NameTypeRequiredDescription
cloud_platformstringNoCloud Platform (e.g.: aws
policy_idstringNoPolicy ID. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
servicestringNoService type to filter policy settings by.

Example:

{
"cloud_platform": "<cloud_platform>",
"policy_id": "<policy_id>",
"service": "<service>"
}

Get Cspmscan Schedule

SDK: cspm_registration.GetCSPMScanSchedule

Parameters:

NameTypeRequiredDescription
cloud_platformarrayNoCloud Platform. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"cloud_platform": ["<cloud_platform>"]
}

Update Cspmaws Account

SDK: cspm_registration.PatchCSPMAwsAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Update Cspmazure Account

SDK: cspm_registration.UpdateCSPMAzureAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Update Cspmazure Account Client Id

SDK: cspm_registration.UpdateCSPMAzureAccountClientID

Parameters:

NameTypeRequiredDescription
idstringNoClientID to use for the Service Principal associated with the customer's Azure account
tenant_idstringNoTenant ID to update client ID for. Required if multiple tenants are registered.

Example:

{
"id": "<id>",
"tenant_id": "<tenant_id>"
}

Update Cspmazure Tenant Default Subscription Id

SDK: cspm_registration.UpdateCSPMAzureTenantDefaultSubscriptionID

Parameters:

NameTypeRequiredDescription
subscription_idstringNoDefault Subscription ID to patch for all subscriptions belonged to a tenant.
tenant_idstringNoTenant ID to update client ID for. Required if multiple tenants are registered.

Example:

{
"subscription_id": "<subscription_id>",
"tenant_id": "<tenant_id>"
}

Update Cspmgcpaccount

SDK: cspm_registration.UpdateCSPMGCPAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Update Cspmgcpservice Accounts Ext

SDK: cspm_registration.UpdateCSPMGCPServiceAccountsExt

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Update Cspmpolicy Settings

SDK: cspm_registration.UpdateCSPMPolicySettings

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Update Cspmscan Schedule

SDK: cspm_registration.UpdateCSPMScanSchedule

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Validate Cspmgcpservice Account Ext

SDK: cspm_registration.ValidateCSPMGCPServiceAccountExt

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

D4C Registration

Operations for D4C Registration

Operations

OperationNameDescription
connect_d4cgcpaccountConnect D4CgcpaccountSDK: d4c_registration.ConnectD4CGCPAccount
create_d4caws_accountCreate D4Caws AccountSDK: d4c_registration.CreateD4CAwsAccount
create_d4cgcp_accountCreate D4Cgcp AccountSDK: d4c_registration.CreateD4CGcpAccount
create_discover_cloud_azure_accountCreate Discover Cloud Azure AccountSDK: d4c_registration.CreateDiscoverCloudAzureAccount
delete_d4caws_accountDelete D4Caws AccountSDK: d4c_registration.DeleteD4CAwsAccount
delete_d4cgcpaccountDelete D4CgcpaccountSDK: d4c_registration.DeleteD4CGCPAccount
get_d4caws_accountGet D4Caws AccountSDK: d4c_registration.GetD4CAwsAccount
get_d4caws_console_setup_urlsGet D4Caws Console Setup UrlsSDK: d4c_registration.GetD4CAwsConsoleSetupURLs
get_d4cawsaccount_scripts_attachmentGet D4Cawsaccount Scripts AttachmentSDK: d4c_registration.GetD4CAWSAccountScriptsAttachment
get_d4cgcp_accountGet D4Cgcp AccountSDK: d4c_registration.GetD4CGcpAccount
get_d4cgcp_user_scriptsGet D4Cgcp User ScriptsSDK: d4c_registration.GetD4CGcpUserScripts
get_d4cgcpservice_accounts_extGet D4Cgcpservice Accounts ExtSDK: d4c_registration.GetD4CGCPServiceAccountsExt
get_d4cgcpuser_scripts_attachmentGet D4Cgcpuser Scripts AttachmentSDK: d4c_registration.GetD4CGCPUserScriptsAttachment
get_discover_cloud_azure_accountGet Discover Cloud Azure AccountSDK: d4c_registration.GetDiscoverCloudAzureAccount
get_discover_cloud_azure_tenant_idsGet Discover Cloud Azure Tenant IdsSDK: d4c_registration.GetDiscoverCloudAzureTenantIDs
get_discover_cloud_azure_user_scriptsGet Discover Cloud Azure User ScriptsSDK: d4c_registration.GetDiscoverCloudAzureUserScripts
get_discover_cloud_azure_user_scripts_attachmentGet Discover Cloud Azure User Scripts AttachmentSDK: d4c_registration.GetDiscoverCloudAzureUserScriptsAttachment
get_horizon_d4cscriptsGet Horizon D4CscriptsSDK: d4c_registration.GetHorizonD4CScripts
update_d4cgcpservice_accounts_extUpdate D4Cgcpservice Accounts ExtSDK: d4c_registration.UpdateD4CGCPServiceAccountsExt
update_discover_cloud_azure_account_client_idUpdate Discover Cloud Azure Account Client IdSDK: d4c_registration.UpdateDiscoverCloudAzureAccountClientID

Connect D4Cgcpaccount

SDK: d4c_registration.ConnectD4CGCPAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Create D4Caws Account

SDK: d4c_registration.CreateD4CAwsAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Create D4Cgcp Account

SDK: d4c_registration.CreateD4CGcpAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Create Discover Cloud Azure Account

SDK: d4c_registration.CreateDiscoverCloudAzureAccount

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Delete D4Caws Account

SDK: d4c_registration.DeleteD4CAwsAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoAWS account IDs to remove
organization_idsarrayNoAWS organization IDs to remove

Example:

{
"ids": ["<ids>"],
"organization_ids": ["<organization_ids>"]
}

Delete D4Cgcpaccount

SDK: d4c_registration.DeleteD4CGCPAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoHierarchical Resource IDs of accounts

Example:

{
"ids": ["<ids>"]
}

Get D4Caws Account

SDK: d4c_registration.GetD4CAwsAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoAWS account IDs
limitnumberNoThe maximum records to return. Defaults to 100. Default: 100
migratedstringNoOnly return migrated d4c accounts
offsetnumberNoThe offset to start retrieving records from
organization_idsarrayNoAWS organization IDs
scan_typestringNoType of scan, dry or full, to perform on selected accounts
statusstringNoAccount status to filter results by.

Example:

{
"ids": ["<ids>"],
"limit": 10,
"migrated": "<migrated>",
"offset": 10,
"organization_ids": ["<organization_ids>"],
"scan_type": "<scan_type>",
"status": "<status>"
}

Get D4Caws Console Setup Urls

SDK: d4c_registration.GetD4CAwsConsoleSetupURLs

Parameters:

NameTypeRequiredDescription
regionstringNoRegion. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"region": "<region>"
}

Get D4Cawsaccount Scripts Attachment

SDK: d4c_registration.GetD4CAWSAccountScriptsAttachment

Parameters:

NameTypeRequiredDescription
accountsarrayNoThe list of accounts to register
aws_profilestringNoThe AWS profile to be used during registration
aws_regionstringNoThe AWS region to be used during registration
behavior_assessment_enabledstringNoBehaviorAssessmentEnabled.
dspm_enabledstringNoDspmEnabled.
dspm_host_account_idstringNoDspmHostAccountID.
dspm_host_integration_role_namestringNoDspmHostIntegrationRoleName.
dspm_host_scanner_role_namestringNoDspmHostScannerRoleName.
dspm_regionsarrayNoDspmRegions.
dspm_rolestringNoDspmRole.
falcon_client_idstringNoThe Falcon client ID used during registration
iam_role_arnstringNoThe custom IAM role to be used during registration
idp_enabledstringNoSet to true to enable Identity Protection feature
idsarrayNoAWS account IDs
organization_idstringNoThe AWS organization ID to be registered
organizational_unit_idsarrayNoThe AWS Organizational Unit IDs to be registered
sensor_management_enabledstringNoSensorManagementEnabled.
tagsstringNoBase64 encoded JSON string to be used as AWS tags
templatestringNoTemplate to be rendered Default: "aws-bash"
use_existing_cloudtrailstringNoUseExistingCloudtrail.

Example:

{
"accounts": ["<accounts>"],
"aws_profile": "<aws_profile>",
"aws_region": "<aws_region>",
"behavior_assessment_enabled": "<behavior_assessment_enabled>",
"dspm_enabled": "<dspm_enabled>",
"dspm_host_account_id": "<dspm_host_account_id>",
"dspm_host_integration_role_name": "<dspm_host_integration_role_name>",
"dspm_host_scanner_role_name": "<dspm_host_scanner_role_name>",
"dspm_regions": ["<dspm_regions>"],
"dspm_role": "<dspm_role>",
"falcon_client_id": "<falcon_client_id>",
"iam_role_arn": "<iam_role_arn>",
"idp_enabled": "<idp_enabled>",
"ids": ["<ids>"],
"organization_id": "<organization_id>",
"organizational_unit_ids": ["<organizational_unit_ids>"],
"sensor_management_enabled": "<sensor_management_enabled>",
"tags": "<tags>",
"template": "<template>",
"use_existing_cloudtrail": "<use_existing_cloudtrail>"
}

Get D4Cgcp Account

SDK: d4c_registration.GetD4CGcpAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoHierarchical Resource IDs of accounts
limitnumberNoThe maximum records to return. Defaults to 100. Default: 100
offsetnumberNoThe offset to start retrieving records from
parent_typestringNoGCP Hierarchy Parent Type, organization/folder/project
scan_typestringNoType of scan, dry or full, to perform on selected accounts
sortstringNoOrder fields in ascending or descending order. Ex: parent_type
statusstringNoAccount status to filter results by.

Example:

{
"ids": ["<ids>"],
"limit": 10,
"offset": 10,
"parent_type": "<parent_type>",
"scan_type": "<scan_type>",
"sort": "<sort>",
"status": "<status>"
}

Get D4Cgcp User Scripts

SDK: d4c_registration.GetD4CGcpUserScripts

Parameters:

NameTypeRequiredDescription
parent_typestringNoGCP Hierarchy Parent Type, organization/folder/project

Example:

{
"parent_type": "<parent_type>"
}

Get D4Cgcpservice Accounts Ext

SDK: d4c_registration.GetD4CGCPServiceAccountsExt

Parameters:

NameTypeRequiredDescription
idstringNoService Account ID

Example:

{
"id": "<id>"
}

Get D4Cgcpuser Scripts Attachment

SDK: d4c_registration.GetD4CGCPUserScriptsAttachment

Parameters:

NameTypeRequiredDescription
idsarrayNoHierarchical Resource IDs of accounts
parent_typestringNoGCP Hierarchy Parent Type, organization/folder/project
statusstringNoAccount status to filter results by.

Example:

{
"ids": ["<ids>"],
"parent_type": "<parent_type>",
"status": "<status>"
}

Get Discover Cloud Azure Account

SDK: d4c_registration.GetDiscoverCloudAzureAccount

Parameters:

NameTypeRequiredDescription
idsarrayNoSubscriptionIDs of accounts to select for this status operation. If this is empty then all accoun...
limitnumberNoThe maximum records to return. Defaults to 100. Default: 100
offsetnumberNoThe offset to start retrieving records from
scan_typestringNoType of scan, dry or full, to perform on selected accounts
statusstringNoAccount status to filter results by.
tenant_idsarrayNoTenant ids to filter azure accounts

Example:

{
"ids": ["<ids>"],
"limit": 10,
"offset": 10,
"scan_type": "<scan_type>",
"status": "<status>",
"tenant_ids": ["<tenant_ids>"]
}

Get Discover Cloud Azure Tenant Ids

SDK: d4c_registration.GetDiscoverCloudAzureTenantIDs

This operation has no parameters.

Example:

{
}

Get Discover Cloud Azure User Scripts

SDK: d4c_registration.GetDiscoverCloudAzureUserScripts

This operation has no parameters.

Example:

{
}

Get Discover Cloud Azure User Scripts Attachment

SDK: d4c_registration.GetDiscoverCloudAzureUserScriptsAttachment

Parameters:

NameTypeRequiredDescription
azure_management_groupbooleanNoUse Azure Management Group
subscription_idsarrayNoAzure Subscription ID
templatestringNoTemplate to be rendered
tenant_idarrayNoAzure Tenant ID

Example:

{
"azure_management_group": true,
"subscription_ids": ["<subscription_ids>"],
"template": "<template>",
"tenant_id": ["<tenant_id>"]
}

Get Horizon D4Cscripts

SDK: d4c_registration.GetHorizonD4CScripts

Parameters:

NameTypeRequiredDescription
account_typestringNoAccount type (e.g.: commercial,gov) Only applicable when registering AWS commercial account in a ...
deletestringNoDelete.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
organization_idstringNoAWS organization ID
single_accountstringNoGet static script for single account

Example:

{
"account_type": "<account_type>",
"delete": "<delete>",
"organization_id": "<organization_id>",
"single_account": "<single_account>"
}

Update D4Cgcpservice Accounts Ext

SDK: d4c_registration.UpdateD4CGCPServiceAccountsExt

Parameters:

NameTypeRequiredDescription
resourcesarrayYesBatch operation - array of JSON strings. Each item should be: {"field1":"value1","field2":"value...

Example:

{
"resources": ["<resources>"]
}

Update Discover Cloud Azure Account Client Id

SDK: d4c_registration.UpdateDiscoverCloudAzureAccountClientID

Parameters:

NameTypeRequiredDescription
idstringNoClientID to use for the Service Principal associated with the customer's Azure account
object_idstringNoObject ID to use for the Service Principal associated with the customer's Azure account
tenant_idstringNoTenant ID to update client ID for. Required if multiple tenants are registered.

Example:

{
"id": "<id>",
"object_id": "<object_id>",
"tenant_id": "<tenant_id>"
}

Saas Security

Operations for Saas Security

Operations

OperationNameDescription
dismiss_affected_entity_v3Dismiss Affected Entity V3SDK: saas_security.DismissAffectedEntityV3
dismiss_security_check_v3Dismiss Security Check V3SDK: saas_security.DismissSecurityCheckV3
get_activity_monitor_v3Get Activity Monitor V3SDK: saas_security.GetActivityMonitorV3
get_alerts_v3Get Alerts V3SDK: saas_security.GetAlertsV3
get_app_inventoryGet App InventorySDK: saas_security.GetAppInventory
get_app_inventory_usersGet App Inventory UsersSDK: saas_security.GetAppInventoryUsers
get_asset_inventory_v3Get Asset Inventory V3SDK: saas_security.GetAssetInventoryV3
get_device_inventory_v3Get Device Inventory V3SDK: saas_security.GetDeviceInventoryV3
get_integrations_v3Get Integrations V3SDK: saas_security.GetIntegrationsV3
get_metrics_v3Get Metrics V3SDK: saas_security.GetMetricsV3
get_security_check_affected_v3Get Security Check Affected V3SDK: saas_security.GetSecurityCheckAffectedV3
get_security_check_compliance_v3Get Security Check Compliance V3SDK: saas_security.GetSecurityCheckComplianceV3
get_security_checks_v3Get Security Checks V3SDK: saas_security.GetSecurityChecksV3
get_supported_saas_v3Get Supported Saas V3SDK: saas_security.GetSupportedSaasV3
get_system_logs_v3Get System Logs V3SDK: saas_security.GetSystemLogsV3
get_system_users_v3Get System Users V3SDK: saas_security.GetSystemUsersV3
get_user_inventory_v3Get User Inventory V3SDK: saas_security.GetUserInventoryV3
integration_builder_end_transaction_v3Integration Builder End Transaction V3SDK: saas_security.IntegrationBuilderEndTransactionV3
integration_builder_get_status_v3Integration Builder Get Status V3SDK: saas_security.IntegrationBuilderGetStatusV3
integration_builder_reset_v3Integration Builder Reset V3SDK: saas_security.IntegrationBuilderResetV3
integration_builder_upload_v3Integration Builder Upload V3SDK: saas_security.IntegrationBuilderUploadV3

Dismiss Affected Entity V3

SDK: saas_security.DismissAffectedEntityV3

Parameters:

NameTypeRequiredDescription
idstringNoSecurity Check ID

Example:

{
"id": "<id>"
}

Dismiss Security Check V3

SDK: saas_security.DismissSecurityCheckV3

Parameters:

NameTypeRequiredDescription
idstringNoSecurity Check ID

Example:

{
"id": "<id>"
}

Get Activity Monitor V3

SDK: saas_security.GetActivityMonitorV3

Parameters:

NameTypeRequiredDescription
actorstringNoActor. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
categorystringNoComma separated list of categories
integration_idstringNoIntegration ID. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
limitnumberNoMax number of logs to fetch
projectionstringNoComma separated list of projections
skipnumberNoNumber of logs to skip

Example:

{
"actor": "<actor>",
"category": "<category>",
"integration_id": "<integration_id>",
"limit": 10,
"projection": "<projection>",
"skip": 10
}

Get Alerts V3

SDK: saas_security.GetAlertsV3

Parameters:

NameTypeRequiredDescription
ascendingbooleanNoAscending.. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idstringNoAlert ID
integration_idstringNoComma separated list of integration ID's of the alert you want to get
last_idstringNoThe last id of the alert you want to get
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results
typestringNoThe type of alert you want to get

Example:

{
"ascending": true,
"id": "<id>",
"integration_id": "<integration_id>",
"last_id": "<last_id>",
"limit": 10,
"offset": 10,
"type": "<type>"
}

Get App Inventory

SDK: saas_security.GetAppInventory

Parameters:

NameTypeRequiredDescription
access_levelstringNoComma separated list of access levels
groupsstringNoComma separated list of groups
integration_idstringNoComma separated list of integration IDs
last_activitystringNoLast activity was within or was not within the last 'value' days. Format: 'was value' or 'was not...
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results
scopesstringNoComma separated list of scopes
statusstringNoComma separated list of application statuses (approved, in review, rejected, unclassified)
typestringNoComma separated list of app types
usersstringNoUsers. Format: 'is equal value' or 'contains value' or 'value' (implies 'is equal value')

Example:

{
"access_level": "<access_level>",
"groups": "<groups>",
"integration_id": "<integration_id>",
"last_activity": "<last_activity>",
"limit": 10,
"offset": 10,
"scopes": "<scopes>",
"status": "<status>",
"type": "<type>",
"users": "<users>"
}

Get App Inventory Users

SDK: saas_security.GetAppInventoryUsers

Parameters:

NameTypeRequiredDescription
item_idstringNoItem ID in format: 'integration_id

Example:

{
"item_id": "<item_id>"
}

Get Asset Inventory V3

SDK: saas_security.GetAssetInventoryV3

Parameters:

NameTypeRequiredDescription
access_levelstringNoComma separated list of access levels
integration_idstringNoComma separated list of integration IDs
last_accessedstringNoLast accessed date was within or was not within the last 'value' days. Format: 'was value' or 'wa...
last_modifiedstringNoLast modified date was within or was not within the last 'value' days. Format: 'was value' or 'wa...
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results
password_protectedbooleanNoPassword protected. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/ope...
resource_namestringNoResource name contains 'value' (case insensitive)
resource_ownerstringNoResource owner contains 'value' (case insensitive)
resource_owner_enabledbooleanNoResource owner enabled
resource_typestringNoComma separated list of resource types
unmanaged_domainstringNoComma separated list of unmanaged domains

Example:

{
"access_level": "<access_level>",
"integration_id": "<integration_id>",
"last_accessed": "<last_accessed>",
"last_modified": "<last_modified>",
"limit": 10,
"offset": 10,
"password_protected": true,
"resource_name": "<resource_name>",
"resource_owner": "<resource_owner>",
"resource_owner_enabled": true,
"resource_type": "<resource_type>",
"unmanaged_domain": "<unmanaged_domain>"
}

Get Device Inventory V3

SDK: saas_security.GetDeviceInventoryV3

Parameters:

NameTypeRequiredDescription
emailstringNoEmail. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_idstringNoComma separated integration ID's
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results
privileged_onlybooleanNoPrivileged Only. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
unassociated_devicesbooleanNoUnassociated Devices

Example:

{
"email": "<email>",
"integration_id": "<integration_id>",
"limit": 10,
"offset": 10,
"privileged_only": true,
"unassociated_devices": true
}

Get Integrations V3

SDK: saas_security.GetIntegrationsV3

Parameters:

NameTypeRequiredDescription
saas_idstringNoComma separated SaaS ID's

Example:

{
"saas_id": "<saas_id>"
}

Get Metrics V3

SDK: saas_security.GetMetricsV3

Parameters:

NameTypeRequiredDescription
check_typestringNoCheck Type. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
compliancebooleanNoCompliance. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
impactstringNoImpact. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_idstringNoComma separated list of integration IDs
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results
statusstringNoExposure status

Example:

{
"check_type": "<check_type>",
"compliance": true,
"impact": "<impact>",
"integration_id": "<integration_id>",
"limit": 10,
"offset": 10,
"status": "<status>"
}

Get Security Check Affected V3

SDK: saas_security.GetSecurityCheckAffectedV3

Parameters:

NameTypeRequiredDescription
idstringNoSecurity Check ID
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results

Example:

{
"id": "<id>",
"limit": 10,
"offset": 10
}

Get Security Check Compliance V3

SDK: saas_security.GetSecurityCheckComplianceV3

Parameters:

NameTypeRequiredDescription
idstringNoSecurity Check ID

Example:

{
"id": "<id>"
}

Get Security Checks V3

SDK: saas_security.GetSecurityChecksV3

Parameters:

NameTypeRequiredDescription
check_typestringNoCheck Type. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
compliancebooleanNoCompliance. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
idstringNoSecurity Check ID
impactstringNoImpact. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_idstringNoComma separated list of integration IDs
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results
statusstringNoExposure status

Example:

{
"check_type": "<check_type>",
"compliance": true,
"id": "<id>",
"impact": "<impact>",
"integration_id": "<integration_id>",
"limit": 10,
"offset": 10,
"status": "<status>"
}

Get Supported Saas V3

SDK: saas_security.GetSupportedSaasV3

This operation has no parameters.

Example:

{
}

Get System Logs V3

SDK: saas_security.GetSystemLogsV3

Parameters:

NameTypeRequiredDescription
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results
total_countbooleanNoFetch Total Count?

Example:

{
"limit": 10,
"offset": 10,
"total_count": true
}

Get System Users V3

SDK: saas_security.GetSystemUsersV3

This operation has no parameters.

Example:

{
}

Get User Inventory V3

SDK: saas_security.GetUserInventoryV3

Parameters:

NameTypeRequiredDescription
emailstringNoEmail. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/
integration_idstringNoComma separated integration ID's
limitnumberNoThe maximum number of objects to return
offsetnumberNoThe starting index of the results
privileged_onlybooleanNoPrivileged Only. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/openapi/

Example:

{
"email": "<email>",
"integration_id": "<integration_id>",
"limit": 10,
"offset": 10,
"privileged_only": true
}

Integration Builder End Transaction V3

SDK: saas_security.IntegrationBuilderEndTransactionV3

Parameters:

NameTypeRequiredDescription
idstringNoIntegration ID

Example:

{
"id": "<id>"
}

Integration Builder Get Status V3

SDK: saas_security.IntegrationBuilderGetStatusV3

Parameters:

NameTypeRequiredDescription
idstringNoIntegration ID

Example:

{
"id": "<id>"
}

Integration Builder Reset V3

SDK: saas_security.IntegrationBuilderResetV3

Parameters:

NameTypeRequiredDescription
idstringNoIntegration ID

Example:

{
"id": "<id>"
}

Integration Builder Upload V3

SDK: saas_security.IntegrationBuilderUploadV3

Parameters:

NameTypeRequiredDescription
datastringYesData Min Length: 1. See CrowdStrike API documentation: https://developer.crowdstrike.com/docs/ope...

Example:

{
"data": "<data>"
}

Best Practices

  1. Use Appropriate Filters: Leverage FQL (Falcon Query Language) filters to narrow down results and improve performance.

  2. Implement Pagination: For operations returning large datasets, use limit and offset parameters to paginate results.

  3. Handle Rate Limits: CrowdStrike APIs have rate limits. Implement appropriate delays and retry logic in your workflows.

  4. Secure Credentials: Never log or expose API credentials. Use NINA's credential management for secure storage.

  5. Use Specific Scopes: When creating API clients, only request the minimum required API scopes.

  6. Monitor API Usage: Track your API usage to avoid hitting rate limits during critical operations.

  7. Validate IDs: Always validate resource IDs before using them in update or delete operations.

  8. Error Handling: Implement comprehensive error handling for API failures and unexpected responses.

Troubleshooting

IssuePossible Solution
401 UnauthorizedVerify Client ID and Client Secret are correct; check if credentials have expired
403 ForbiddenEnsure API client has required scopes for the operation
404 Not FoundVerify the resource ID exists and is accessible with your credentials
429 Too Many RequestsRate limit exceeded; implement delays between requests
Invalid FilterCheck FQL syntax; refer to CrowdStrike FQL documentation
Connection TimeoutVerify network connectivity and correct Base URL for your region
Empty ResultsVerify filter criteria; check if resources exist in your environment

Support

For issues with this integration, please contact support with:

  • The operation you were attempting
  • Any error messages received
  • The parameters used (excluding sensitive data)
  • Your CrowdStrike cloud region

For CrowdStrike API documentation, visit: CrowdStrike Developer Portal

Updated: 2026-02-05