Manage GravityZone endpoints, incidents, isolation, scans, policies, quarantine, patches, maintenance windows and reports.
Explore 98 workflow actions for Bitdefender GravityZone, including account permissions and operation limits.
43 read actions55 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add integrators
Write
addIntegrators You can use this method to assign an endpoint as an integrator for a specific integration.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add to blocklist
Write
addToBlocklist Use this method to set up one or more rules that you can use to add items to blocklists.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Apply recommendations
Write
applyRecommendations This method applies recommendations by ID and returns success and failure details for each one requested.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign incident
Write
assignIncident The assignIncident method enables bulk assignment and reassignment of EDR and XDR incidents to eligible GravityZone users.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign maintenance windows
Write
assignMaintenanceWindows This method assigns a set of maintenance windows to a policy.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign policy
Write
assignPolicy Use this method to assign a policy to one or more endpoints.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change incident priority
Write
changeIncidentPriority You can use this method to change the priority of an incident.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change incident status
Write
changeIncidentStatus This method changes the status of an incident.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Collect investigation package
Write
collectInvestigationPackage You can use this method to initiate a forensic collection task on an endpoint.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create add file to quarantine task
Write
createAddFileToQuarantineTask This method creates a new task to add a file to quarantine.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create custom group
Write
createCustomGroup This method creates a new custom group of endpoints.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create custom rule
Write
createCustomRule Method to create a custom rule.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create empty quarantine task
Write
createEmptyQuarantineTask This method creates a new task to empty the quarantine.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create isolate endpoint task
Write
createIsolateEndpointTask This method creates one or more tasks to isolate the specified endpoint or endpoints.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create patch management maintenance window
Write
createPatchManagementMaintenanceWindow This method creates a maintenance window which you can use in Patch Management.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create reconfigure client task
Write
createReconfigureClientTask This method creates a new Reconfigure Agent task.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create release quarantine exchange item task
Write
createReleaseQuarantineExchangeItemTask This method creates a new task to release items from the quarantine to their intended recipients.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create remove quarantine item task
Write
createRemoveQuarantineItemTask This method creates a new task to remove items from quarantine.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create report
Write
createReport This method creates a new instant or scheduled report, based on the parameters received, and returns the ID of the new created report.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create response action
Write
createResponseAction You can use this method to take response actions on user nodes generated in GravityZone XDR incidents or your own SOC-generated incidents.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create restore endpoint from isolation task
Write
createRestoreEndpointFromIsolationTask This method creates one or more tasks to restore the specified endpoint or endpoints from isolation.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create restore quarantine item task
Write
createRestoreQuarantineItemTask This method creates a new task to restore items from the quarantine.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create scan task
Write
createScanTask This method creates a new scan task.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create scan task by mac
Write
createScanTaskByMac Use this method to generate a scan task for managed endpoints identified by their MAC address.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create submit to sandbox analyzer task
Write
createSubmitToSandboxAnalyzerTask Use this method to create a Sandbox Analyzer task and submit up to 5 files for analysis.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete account
Write
deleteAccount You can use this method to delete a specific user account.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete custom group
Write
deleteCustomGroup This method deletes a custom group.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete custom rule
Write
deleteCustomRule Method to delete a custom rule.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete endpoint
Write
deleteEndpoint This method deletes an endpoint.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete integration
Write
deleteIntegration Use this method to delete a specific integration that was configured under the Integrations hub from a target company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete maintenance window
Write
deleteMaintenanceWindow This method deletes a maintenance window.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete package
Write
deletePackage This method deletes a package identified through the provided package ID.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete report
Write
deleteReport The method deletes a report by its ID.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete task
Write
deleteTask You can use this method to delete a specific task, based on its ID.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Edit monitored rules access
Write
editMonitoredRulesAccess You can use this method to restrict or allow access to behavioral profiles based on the recommendation generated by a specific PHASR rule.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get account details
Read
getAccountDetails Use this method to retrieve information for a specific GravityZone account.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get accounts list
Read
getAccountsList You can use this method to display all the user accounts that belong to a company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get all company identities
Read
getAllCompanyIdentities Use this method to retrieve all detected identities for a company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get all company resources
Read
getAllCompanyResources Use this method to retrieve all detected resources for a company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get api key details
Read
getApiKeyDetails This method returns details about the API key used.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get blocklist items
Read
getBlocklistItems This method lists all items present in a Blocklist.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get company details
Read
getCompanyDetails This method retrieves the details of your company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get configured integrations
Read
getConfiguredIntegrations This method allows you to get a list of all the integrations configured on a specific company under the Integrations hub .
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get custom groups list
Read
getCustomGroupsList This method retrieves the list of groups under a specified group.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get custom rules list
Read
getCustomRulesList This method retrieves the list of custom rules for your company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get endpoint tags
Read
getEndpointTags This method returns details about the endpoint tags within your company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get endpoints list
Read
getEndpointsList This method returns the list of endpoints.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get hourly usage for amazon EC2 instances
Read
getHourlyUsageForAmazonEC2Instances This method exposes the hourly usage for each Amazon instance category (micro, medium etc.).
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get incident
Read
getIncident You can use this method to retrieve information regarding a specific incident, by referencing it's ID.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get incidents by ids
Read
getIncidentsByIds You can use this method to retrieve information on multiple incidents, by referencing their IDs.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get incidents list
Read
getIncidentsList This method retrieves details about Endpoint and Organization incidents within your company based on the applied filters.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get installed patches
Read
getInstalledPatches Use this method to request a list of installed patches that are associated to specific endpoints or a specific company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get integrators
Read
getIntegrators You can use this method to retrieve a list of integrators configured for a specific integration.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get license info
Read
getLicenseInfo This method retrieves the license information for a company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get maintenance window details
Read
getMaintenanceWindowDetails This method retrieves all the information related to a maintenance window.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get maintenance windows list
Read
getMaintenanceWindowsList This method will display a list of available Maintenance Windows for a company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get managed endpoint details
Read
getManagedEndpointDetails The getManagedEndpointDetails method retrieves comprehensive information about a specific endpoint managed in GravityZone .
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get manually approved patches
Read
getManuallyApprovedPatches This method returns a list of manually approved patches from the endpoints of a specific company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get missing patches
Read
getMissingPatches Use this method to request a list of missing patches that are associated to specific endpoints or a specific company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get monitored rule data
Read
getMonitoredRuleData You can use this method to retrieved detailed information regarding a specific PHASR rule and the behavioral profiles it applies to.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get monitored rules
Read
getMonitoredRules This method displays all the monitored PHASR rules across all behavioral categories for a specific company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get monthly usage
Read
getMonthlyUsage This method exposes the monthly usage for a company in a target month.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get monthly usage per product type
Read
getMonthlyUsagePerProductType The method exposes the monthly usage of a company in a target month.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get network inventory items
Read
getNetworkInventoryItems This method returns network inventory items.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get notifications settings
Read
getNotificationsSettings This method returns the notifications settings.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get package details
Read
getPackageDetails This method retrieves information about the configuration of a specific package identified through the provided ID.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get packages list
Read
getPackagesList Returns the list of available packages.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get phasr recommendations
Read
getPhasrRecommendations Use this method to retrieve PHASR recommendations for a company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get policies list
Read
getPoliciesList This method retrieves the list of available policies.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get policy details
Read
getPolicyDetails This method retrieves all information related to a security policy.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get push event stats
Read
getPushEventStats This method gets the push event statistics and errors.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get quarantine items list
Read
getQuarantineItemsList This method retrieves the list of quarantined items available for a company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get recommendation profiles
Read
getRecommendationProfiles Use this method to retrieve information for the behavioral profiles that a specific recommendation applies to.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get reports list
Read
getReportsList This method returns the list of scheduled reports, according to the parameters received.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get response action status
Read
getResponseActionStatus You can use this method to request the status and the result of a response action.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get scan tasks list
Read
getScanTasksList This method returns the list of scan tasks.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get similar emails
Read
getSimilarEmails You can use this method to retrieve emails similar to a given email, scoped to the same company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Get task status
Read
getTaskStatus This method retrieves information about the status of a given task identified using its ID.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
Kill process (investigation)
Write
killProcess You can use this method to initiate a task that terminates a running process on a managed endpoint.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Kill process (network)
Write
killProcess Use this method to terminate an active process using it's process ID, it's path, the endpoint where it is running, and, if available, the ID of the.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Manage integration
Write
manageIntegration Use this method to enable or disable an integration configured under the Integrations hub .
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Move custom group
Write
moveCustomGroup This method moves a custom group to another custom group.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Move endpoints
Write
moveEndpoints This method moves a list of endpoints to a custom group.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove from blocklist
Write
removeFromBlocklist This method removes one or more items from the Blocklist, identified by their IDs.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove integrators
Write
removeIntegrators You can use this method to unassign a specific endpoint as an integrator.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reset push event stats
Write
resetPushEventStats This method resets the push event statistics and errors.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run gather logs task
Write
runGatherLogsTask Use this method to create a task that collects diagnostic logs from an online endpoint.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send test push event
Write
sendTestPushEvent This method sends a test event.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set endpoint label
Write
setEndpointLabel This method sets a new label to an endpoint.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set policy modules state
Write
setPolicyModulesState You can use this method to enable or disable the settings associated to a specific policy.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Start retrieve investigation file from endpoint
Write
startRetrieveInvestigationFileFromEndpoint You can use this method to retrieve a file from an endpoint within your company and upload it as an archive to a.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Start yara scan
Write
startYaraScan You can use this method to initiate an On-demand scan on the specified targets, using a YARA rule to detect files that match the rule conditions.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Take request access action
Write
takeRequestAccessAction Takes action on request access recommendations by either allowing or denying them.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unassign maintenance windows
Write
unassignMaintenanceWindows This method unassigns a set of maintenance windows from a policy.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update company details
Write
updateCompanyDetails This method updates the details of your company.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update custom rule
Write
updateCustomRule You can use this method to edit any existing custom exclusion or detection rule by referencing its Rule ID .
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update incident note
Write
updateIncidentNote This method assigns a note to an incident.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update patch management maintenance window
Write
updatePatchManagementMaintenanceWindow This method modifies a patch management maintenance window.
Permissions and limits
Account permissions
A GravityZone personal API key with the API enabled
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Bitdefender GravityZone. A saved workflow is not a completed provider action.