Package Information
Downloads: 455 weekly / 493 monthly
Latest Version: 0.1.11
Author: AvantGuard LLC
Available Nodes
Documentation
SentinelOne n8n Node
SentinelOne Management Console API specification.
Table of Contents
Installation
Follow the n8n community node installation guide.
Or install directly via npm:
npm install @avantguardllc/n8n-nodes-sentinelone
Authentication
This node authenticates using an API Key.
| Setting | Value |
|---|---|
| Type | API Key |
| Base URL | https://domain.sentinelone.net (editable in credentials) |
Tip: The Base URL can be changed in the credential settings if your instance uses a different host.
Resources & Operations
Base URL: https://domain.sentinelone.net
Accounts
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/accounts/{account_id}/policy |
Account Policy |
🟡 PUT |
/web/api/v2.1/accounts/{account_id}/policy |
Update Account Policy |
🟢 POST |
/web/api/v2.1/accounts/{account_id}/uninstall-password/generate |
GenerateRegenerate Uninstall Password |
🔵 GET |
/web/api/v2.1/accounts/{account_id}/uninstall-password/metadata |
Get Uninstall Password Metadata |
🟢 POST |
/web/api/v2.1/accounts/{account_id}/uninstall-password/revoke |
Revoke Uninstall Password |
🔵 GET |
/web/api/v2.1/accounts/{account_id}/uninstall-password/view |
Get Uninstall Password |
🔵 GET |
/web/api/v2.1/accounts/{account_id} |
Get Account by ID |
🟡 PUT |
/web/api/v2.1/accounts/{account_id} |
Update Account |
🟢 POST |
/web/api/v2.1/accounts/{account_id}/expire-now |
Expire an Account |
🟡 PUT |
/web/api/v2.1/accounts/{account_id}/reactivate |
Reactivate Account |
🟡 PUT |
/web/api/v2.1/accounts/{account_id}/revert-policy |
Revert Policy |
🔵 GET |
/web/api/v2.1/accounts |
Get Accounts |
🟢 POST |
/web/api/v2.1/accounts |
Create Account |
🔵 GET |
/web/api/v2.1/private/accounts |
Get accounts private |
🔵 GET |
/web/api/v2.1/private/accounts/name-available |
Available Name |
🔵 GET |
/web/api/v2.1/private/navigation/accounts |
Get Accounts for Navigation |
🔵 GET |
/web/api/v2.1/private/navigation/accounts/{scope_id} |
Get One Account |
Policy
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/accounts/{account_id}/policy |
Account Policy |
🟡 PUT |
/web/api/v2.1/accounts/{account_id}/policy |
Update Account Policy |
🔵 GET |
/web/api/v2.1/groups/{group_id}/policy |
Group Policy |
🟡 PUT |
/web/api/v2.1/groups/{group_id}/policy |
Update Group Policy |
🔵 GET |
/web/api/v2.1/private/policy |
Get Policy |
🟢 POST |
/web/api/v2.1/private/policy |
Create Policy |
🔵 GET |
/web/api/v2.1/sites/{site_id}/policy |
Site Policy |
🟡 PUT |
/web/api/v2.1/sites/{site_id}/policy |
Update Site Policy |
UninstallPassword
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/accounts/{account_id}/uninstall-password/generate |
GenerateRegenerate Uninstall Password |
🔵 GET |
/web/api/v2.1/accounts/{account_id}/uninstall-password/metadata |
Get Uninstall Password Metadata |
🟢 POST |
/web/api/v2.1/accounts/{account_id}/uninstall-password/revoke |
Revoke Uninstall Password |
🔵 GET |
/web/api/v2.1/accounts/{account_id}/uninstall-password/view |
Get Uninstall Password |
Activities
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/activities |
Get Activities |
🔵 GET |
/web/api/v2.1/activities/types |
Get Activity Types |
Agents
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/agents/actions/abort-scan |
Abort Scan |
🟢 POST |
/web/api/v2.1/agents/actions/approve-uninstall |
Approve Uninstall |
🟢 POST |
/web/api/v2.1/agents/actions/broadcast |
Broadcast Message |
🟢 POST |
/web/api/v2.1/agents/actions/can-start-remote-shell |
Can run Remote Shell |
🟢 POST |
/web/api/v2.1/agents/actions/clear-remote-shell-session |
Clear Remote Shell |
🟢 POST |
/web/api/v2.1/agents/actions/connect |
Connect to Network |
🟢 POST |
/web/api/v2.1/agents/actions/decommission |
Decommission |
🟢 POST |
/web/api/v2.1/agents/actions/disable-agent |
Disable Agent |
🟢 POST |
/web/api/v2.1/agents/actions/disconnect |
Disconnect from Network |
🟢 POST |
/web/api/v2.1/agents/actions/enable-agent |
Enable Agent |
🟢 POST |
/web/api/v2.1/agents/actions/fetch-firewall-rules |
Fetch Firewall Rules |
🟢 POST |
/web/api/v2.1/agents/actions/fetch-installed-apps |
Get Installed Apps for agent |
🟢 POST |
/web/api/v2.1/agents/actions/fetch-logs |
Fetch Logs |
🟢 POST |
/web/api/v2.1/agents/actions/firewall-logging |
Fetch Firewall Logs |
🟢 POST |
/web/api/v2.1/agents/actions/initiate-scan |
Initiate Scan |
🟢 POST |
/web/api/v2.1/agents/actions/mark-up-to-date |
Mark as uptodate |
🟢 POST |
/web/api/v2.1/agents/actions/move-to-console |
Move to Console |
🟢 POST |
/web/api/v2.1/agents/actions/move-to-site |
Move between Sites |
🟢 POST |
/web/api/v2.1/agents/actions/randomize-uuid |
Randomize UUID |
🟢 POST |
/web/api/v2.1/agents/actions/ranger-disable |
Disable Ranger |
🟢 POST |
/web/api/v2.1/agents/actions/ranger-enable |
Enable Ranger |
🟢 POST |
/web/api/v2.1/agents/actions/reject-uninstall |
Reject uninstall |
🟢 POST |
/web/api/v2.1/agents/actions/reset-local-config |
Reset Local Config |
🟢 POST |
/web/api/v2.1/agents/actions/restart-machine |
Restart |
🟢 POST |
/web/api/v2.1/agents/actions/set-config |
Set Persistent Configuration Overrides |
🟢 POST |
/web/api/v2.1/agents/actions/set-external-id |
Set External ID |
🟢 POST |
/web/api/v2.1/agents/actions/shutdown |
Shutdown |
🟢 POST |
/web/api/v2.1/agents/actions/start-profiling |
Start Remote Profiling |
🟢 POST |
/web/api/v2.1/agents/actions/start-remote-shell |
Start Remote Shell |
🟢 POST |
/web/api/v2.1/agents/actions/stop-profiling |
Stop Remote Profiling |
🟢 POST |
/web/api/v2.1/agents/actions/terminate-remote-shell |
Terminate Remote Shell |
🟢 POST |
/web/api/v2.1/agents/actions/uninstall |
Uninstall |
🟢 POST |
/web/api/v2.1/agents/actions/update-software |
Update Software |
🟢 POST |
/web/api/v2.1/agents/{agent_id}/actions/fetch-files |
Fetch Files |
🔵 GET |
/web/api/v2.1/agents/{agent_id}/uploads/{activity_id} |
Export Agent Logs |
🔵 GET |
/web/api/v2.1/agents |
Get Agents |
🔵 GET |
/web/api/v2.1/agents/applications |
Get Application |
🔵 GET |
/web/api/v2.1/agents/count |
Count Agents |
🔵 GET |
/web/api/v2.1/agents/passphrases |
Get Passphrase |
🔵 GET |
/web/api/v2.1/agents/processes |
Processes |
🔵 GET |
/web/api/v2.1/private/agents/available-actions |
DEPRECATED Get Agent Available Actions |
🟢 POST |
/web/api/v2.1/private/agents/available-actions |
Get Agent Available Actions |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/events-throttling |
Event Throttling |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/flush-events-queue |
Flush Event Queue |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/protect |
Protect |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-crash-dumps |
Purge Crash Dumps |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-db |
Purge DB |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-research-data |
Purge Research Data |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/reload |
Reload |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/restart |
Restart |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/revoke-token |
Revoke Token |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/send-crash-dumps |
Send Crash Dumps |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/send-research-data |
Send Research Data |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/unprotect |
Unprotect |
🟢 POST |
/web/api/v2.1/private/agents/actions/randomize-dv-host |
Randomize DV Host |
🔵 GET |
/web/api/v2.1/private/agents/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/agents/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/agents/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/agents/summary |
Count Summary |
🔵 GET |
/web/api/v2.1/private/agents/{agent_id}/support-actions/configuration |
Get config |
Actions
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/agents/actions/abort-scan |
Abort Scan |
🟢 POST |
/web/api/v2.1/agents/actions/approve-uninstall |
Approve Uninstall |
🟢 POST |
/web/api/v2.1/agents/actions/broadcast |
Broadcast Message |
🟢 POST |
/web/api/v2.1/agents/actions/can-start-remote-shell |
Can run Remote Shell |
🟢 POST |
/web/api/v2.1/agents/actions/clear-remote-shell-session |
Clear Remote Shell |
🟢 POST |
/web/api/v2.1/agents/actions/connect |
Connect to Network |
🟢 POST |
/web/api/v2.1/agents/actions/decommission |
Decommission |
🟢 POST |
/web/api/v2.1/agents/actions/disable-agent |
Disable Agent |
🟢 POST |
/web/api/v2.1/agents/actions/disconnect |
Disconnect from Network |
🟢 POST |
/web/api/v2.1/agents/actions/enable-agent |
Enable Agent |
🟢 POST |
/web/api/v2.1/agents/actions/fetch-firewall-rules |
Fetch Firewall Rules |
🟢 POST |
/web/api/v2.1/agents/actions/fetch-installed-apps |
Get Installed Apps for agent |
🟢 POST |
/web/api/v2.1/agents/actions/fetch-logs |
Fetch Logs |
🟢 POST |
/web/api/v2.1/agents/actions/firewall-logging |
Fetch Firewall Logs |
🟢 POST |
/web/api/v2.1/agents/actions/initiate-scan |
Initiate Scan |
🟢 POST |
/web/api/v2.1/agents/actions/mark-up-to-date |
Mark as uptodate |
🟢 POST |
/web/api/v2.1/agents/actions/move-to-console |
Move to Console |
🟢 POST |
/web/api/v2.1/agents/actions/move-to-site |
Move between Sites |
🟢 POST |
/web/api/v2.1/agents/actions/randomize-uuid |
Randomize UUID |
🟢 POST |
/web/api/v2.1/agents/actions/ranger-disable |
Disable Ranger |
🟢 POST |
/web/api/v2.1/agents/actions/ranger-enable |
Enable Ranger |
🟢 POST |
/web/api/v2.1/agents/actions/reject-uninstall |
Reject uninstall |
🟢 POST |
/web/api/v2.1/agents/actions/reset-local-config |
Reset Local Config |
🟢 POST |
/web/api/v2.1/agents/actions/restart-machine |
Restart |
🟢 POST |
/web/api/v2.1/agents/actions/set-config |
Set Persistent Configuration Overrides |
🟢 POST |
/web/api/v2.1/agents/actions/set-external-id |
Set External ID |
🟢 POST |
/web/api/v2.1/agents/actions/shutdown |
Shutdown |
🟢 POST |
/web/api/v2.1/agents/actions/start-profiling |
Start Remote Profiling |
🟢 POST |
/web/api/v2.1/agents/actions/start-remote-shell |
Start Remote Shell |
🟢 POST |
/web/api/v2.1/agents/actions/stop-profiling |
Stop Remote Profiling |
🟢 POST |
/web/api/v2.1/agents/actions/terminate-remote-shell |
Terminate Remote Shell |
🟢 POST |
/web/api/v2.1/agents/actions/uninstall |
Uninstall |
🟢 POST |
/web/api/v2.1/agents/actions/update-software |
Update Software |
Applications
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/applications/{application_id}/forensics |
Application Forensics |
🔵 GET |
/web/api/v2.1/applications/{application_id}/forensics/connections |
Application Connections |
🔵 GET |
/web/api/v2.1/applications/{application_id}/forensics/details |
Application Forensics Detailed |
🔵 GET |
/web/api/v2.1/applications/{application_id}/forensics/export/{export_format} |
Export Application |
🔵 GET |
/web/api/v2.1/singularity-marketplace/applications |
Get Marketplace Applications |
🟢 POST |
/web/api/v2.1/singularity-marketplace/applications |
Install Applications |
🟡 PUT |
/web/api/v2.1/singularity-marketplace/applications |
Update Application Configuration |
🔴 DELETE |
/web/api/v2.1/singularity-marketplace/applications |
Delete Marketplace Application |
🔵 GET |
/web/api/v2.1/singularity-marketplace/applications/{application_id}/config |
Get Configuration fields for Catalog Application |
🟢 POST |
/web/api/v2.1/singularity-marketplace/applications/{mode} |
Enable or Disable application |
CloudDetection
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/cloud-detection/alerts |
Get alerts |
🟢 POST |
/web/api/v2.1/cloud-detection/alerts/analyst-verdict |
Update Alert Analyst Verdict |
🟢 POST |
/web/api/v2.1/cloud-detection/alerts/incident |
Updated Threat Incident |
🔵 GET |
/web/api/v2.1/cloud-detection/rules |
Get Rules |
🟢 POST |
/web/api/v2.1/cloud-detection/rules |
Create Rule |
🔴 DELETE |
/web/api/v2.1/cloud-detection/rules |
Delete Rules |
🟡 PUT |
/web/api/v2.1/cloud-detection/rules/disable |
Disable Rules |
🟡 PUT |
/web/api/v2.1/cloud-detection/rules/enable |
Activate Rules |
🟡 PUT |
/web/api/v2.1/cloud-detection/rules/{rule_id} |
Update Rule |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/agents-connect |
Reconnect agent to network |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/agents-disconnect |
Disconnect agents from network |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/available-actions |
Available Actions |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/free-text-filters |
FreeText Filters |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/mark-as-threat |
Mark alert as threat with sype suspiciousmelicious |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/available-actions |
Available Actions |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/wizardOptions |
Get Rule Wizard |
Alerts
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/cloud-detection/alerts |
Get alerts |
🟢 POST |
/web/api/v2.1/cloud-detection/alerts/analyst-verdict |
Update Alert Analyst Verdict |
🟢 POST |
/web/api/v2.1/cloud-detection/alerts/incident |
Updated Threat Incident |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/agents-connect |
Reconnect agent to network |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/agents-disconnect |
Disconnect agents from network |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/available-actions |
Available Actions |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/free-text-filters |
FreeText Filters |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/mark-as-threat |
Mark alert as threat with sype suspiciousmelicious |
Rules
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/cloud-detection/rules |
Get Rules |
🟢 POST |
/web/api/v2.1/cloud-detection/rules |
Create Rule |
🔴 DELETE |
/web/api/v2.1/cloud-detection/rules |
Delete Rules |
🟡 PUT |
/web/api/v2.1/cloud-detection/rules/disable |
Disable Rules |
🟡 PUT |
/web/api/v2.1/cloud-detection/rules/enable |
Activate Rules |
🟡 PUT |
/web/api/v2.1/cloud-detection/rules/{rule_id} |
Update Rule |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/available-actions |
Available Actions |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/wizardOptions |
Get Rule Wizard |
ConfigOverride
| Endpoint | Description | |
|---|---|---|
🟡 PUT |
/web/api/v2.1/config-override/{override_id} |
Update Config Override |
🔴 DELETE |
/web/api/v2.1/config-override/{override_id} |
Delete Config Override |
🔵 GET |
/web/api/v2.1/config-override |
Get Config Overrides |
🟢 POST |
/web/api/v2.1/config-override |
Create Config Override |
🔴 DELETE |
/web/api/v2.1/config-override |
Delete Config Overrides |
DeviceControl
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/device-control/configuration |
Get Configuration |
🟡 PUT |
/web/api/v2.1/device-control/configuration |
Update Configuration |
🔵 GET |
/web/api/v2.1/device-control |
Get Device Rules |
🟢 POST |
/web/api/v2.1/device-control |
Create Device Control Rule |
🔴 DELETE |
/web/api/v2.1/device-control |
Delete Rules |
🟢 POST |
/web/api/v2.1/device-control/copy-rules |
Copy Rules |
🟡 PUT |
/web/api/v2.1/device-control/enable |
EnableDisable Rules |
🔵 GET |
/web/api/v2.1/device-control/events |
Get Device Control Events |
🔵 GET |
/web/api/v2.1/device-control/export |
Export Rules |
🟢 POST |
/web/api/v2.1/device-control/import |
Import Rules |
🟢 POST |
/web/api/v2.1/device-control/move-rules |
Move rules |
🟡 PUT |
/web/api/v2.1/device-control/reorder |
Reorder Rules |
🟡 PUT |
/web/api/v2.1/device-control/{rule_id} |
Update Device Rule |
🔵 GET |
/web/api/v2.1/private/device-control/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/device-control/interfaces |
Get Interfaces |
🔵 GET |
/web/api/v2.1/private/device-control/unscoped |
Get Unscoped Rules |
Configuration
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/device-control/configuration |
Get Configuration |
🟡 PUT |
/web/api/v2.1/device-control/configuration |
Update Configuration |
🔵 GET |
/web/api/v2.1/firewall-control/configuration |
Get Configuration |
🟡 PUT |
/web/api/v2.1/firewall-control/configuration |
Update Configuration |
🔵 GET |
/web/api/v2.1/firewall-control/{firewall_rule_category}/configuration |
Get Configuration |
🟡 PUT |
/web/api/v2.1/firewall-control/{firewall_rule_category}/configuration |
Update Configuration |
🔵 GET |
/web/api/v2.1/system/configuration |
Get System Config |
🟡 PUT |
/web/api/v2.1/system/configuration |
Set System Config |
Dv
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/dv/events |
Get Events |
🔵 GET |
/web/api/v2.1/dv/events/{event_type} |
Get Events By Type |
🟢 POST |
/web/api/v2.1/dv/cancel-query |
Cancel Running Query |
🔵 GET |
/web/api/v2.1/dv/fetch-file |
Download source process file |
🟢 POST |
/web/api/v2.1/dv/init-query |
Create Query and Get QueryId |
🔵 GET |
/web/api/v2.1/dv/process-state |
Get Process State |
🔵 GET |
/web/api/v2.1/dv/query-status |
Get Query Status |
🟡 PUT |
/web/api/v2.1/filters/dv/{filter_id} |
Update Deep Visibility Filter |
🔴 DELETE |
/web/api/v2.1/filters/dv/{filter_id} |
Delete Deep Visibility Filter |
🔵 GET |
/web/api/v2.1/filters/dv |
Get Deep Visibility Filters |
🟢 POST |
/web/api/v2.1/filters/dv |
Save Deep Visibility Filter |
Events
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/dv/events |
Get Events |
🔵 GET |
/web/api/v2.1/dv/events/{event_type} |
Get Events By Type |
Exclusions
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/exclusions |
Get Exclusions |
🟢 POST |
/web/api/v2.1/exclusions |
Create Exclusion |
🟡 PUT |
/web/api/v2.1/exclusions |
Update Exclusions |
🔴 DELETE |
/web/api/v2.1/exclusions |
Delete Exclusions |
🟢 POST |
/web/api/v2.1/exclusions/validate |
Validate Exclusion Item |
🔵 GET |
/web/api/v2.1/private/exclusions/applications-catalog |
Get Catalog Exclusions |
🟢 POST |
/web/api/v2.1/private/exclusions/applications-catalog |
Add Exclusions from catalog |
🔵 GET |
/web/api/v2.1/private/exclusions/filters-autocomplete |
Auto complete |
🔵 GET |
/web/api/v2.1/private/exclusions/filters-count |
Count Exclusions by Filters |
🔵 GET |
/web/api/v2.1/private/exclusions/free-text-filters |
Freetext filters |
Export
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/export/threats/{threat_id}/explore/events |
Export Events |
🔵 GET |
/web/api/v2.1/export/threats/{threat_id}/timeline |
Export Threat Timeline |
🔵 GET |
/web/api/v2.1/export/activities |
Export Activities |
🔵 GET |
/web/api/v2.1/export/agents |
Export Agents |
🔵 GET |
/web/api/v2.1/export/installed-applications |
List Installed Applications |
Filters
| Endpoint | Description | |
|---|---|---|
🟡 PUT |
/web/api/v2.1/filters/dv/{filter_id} |
Update Deep Visibility Filter |
🔴 DELETE |
/web/api/v2.1/filters/dv/{filter_id} |
Delete Deep Visibility Filter |
🔵 GET |
/web/api/v2.1/filters/dv |
Get Deep Visibility Filters |
🟢 POST |
/web/api/v2.1/filters/dv |
Save Deep Visibility Filter |
🟡 PUT |
/web/api/v2.1/filters/{filter_id} |
Update Filter |
🔴 DELETE |
/web/api/v2.1/filters/{filter_id} |
Delete Filter |
🔵 GET |
/web/api/v2.1/filters |
Get Filters |
🟢 POST |
/web/api/v2.1/filters |
Save Filter |
FirewallControl
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/firewall-control/configuration |
Get Configuration |
🟡 PUT |
/web/api/v2.1/firewall-control/configuration |
Update Configuration |
🔵 GET |
/web/api/v2.1/firewall-control/{firewall_rule_category}/configuration |
Get Configuration |
🟡 PUT |
/web/api/v2.1/firewall-control/{firewall_rule_category}/configuration |
Update Configuration |
🔵 GET |
/web/api/v2.1/firewall-control/{firewall_rule_category} |
Get Firewall Rules |
🟢 POST |
/web/api/v2.1/firewall-control/{firewall_rule_category} |
Create Firewall Rule |
🟡 PUT |
/web/api/v2.1/firewall-control/{firewall_rule_category} |
Update Firewall Rule |
🔴 DELETE |
/web/api/v2.1/firewall-control/{firewall_rule_category} |
Delete Rules |
🟢 POST |
/web/api/v2.1/firewall-control/{firewall_rule_category}/add-tags |
Add Rule Tags |
🟢 POST |
/web/api/v2.1/firewall-control/{firewall_rule_category}/copy-rules |
Copy Rules |
🟡 PUT |
/web/api/v2.1/firewall-control/{firewall_rule_category}/enable |
EnableDisable Rules |
🔵 GET |
/web/api/v2.1/firewall-control/{firewall_rule_category}/export |
Export Rules |
🟢 POST |
/web/api/v2.1/firewall-control/{firewall_rule_category}/import |
Import Rules |
🟢 POST |
/web/api/v2.1/firewall-control/{firewall_rule_category}/move-rules |
Move Rules |
🔵 GET |
/web/api/v2.1/firewall-control/{firewall_rule_category}/protocols |
Get Protocols |
🟢 POST |
/web/api/v2.1/firewall-control/{firewall_rule_category}/remove-tags |
Remove Rule Tags |
🟡 PUT |
/web/api/v2.1/firewall-control/{firewall_rule_category}/reorder |
Reorder Rules |
🟢 POST |
/web/api/v2.1/firewall-control/{firewall_rule_category}/set-location |
Set Location |
🔵 GET |
/web/api/v2.1/firewall-control |
Get Firewall Rules |
🟢 POST |
/web/api/v2.1/firewall-control |
Create Firewall Rule |
🔴 DELETE |
/web/api/v2.1/firewall-control |
Delete Rules |
🟢 POST |
/web/api/v2.1/firewall-control/add-tags |
Add Rule Tags |
🟢 POST |
/web/api/v2.1/firewall-control/copy-rules |
Copy Rules |
🟡 PUT |
/web/api/v2.1/firewall-control/enable |
EnableDisable Rules |
🔵 GET |
/web/api/v2.1/firewall-control/export |
Export Rules |
🟢 POST |
/web/api/v2.1/firewall-control/import |
Import Rules |
🟢 POST |
/web/api/v2.1/firewall-control/move-rules |
Move Rules |
🔵 GET |
/web/api/v2.1/firewall-control/protocols |
Get Protocols |
🟢 POST |
/web/api/v2.1/firewall-control/remove-tags |
Remove Rule Tags |
🟡 PUT |
/web/api/v2.1/firewall-control/reorder |
Reorder Rules |
🟢 POST |
/web/api/v2.1/firewall-control/set-location |
Set Location |
🔵 GET |
/web/api/v2.1/firewall-control/tag-rules/{tag_id} |
Get Tag Firewall Rules |
🔵 GET |
/web/api/v2.1/private/firewall-control/{firewall_rule_category}/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/firewall-control/{firewall_rule_category}/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/{firewall_rule_category}/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/{firewall_rule_category}/unscoped |
Get Unscoped Rules |
🔵 GET |
/web/api/v2.1/private/firewall-control/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/firewall-control/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/unscoped |
Get Unscoped Rules |
Groups
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/groups/{group_id}/policy |
Group Policy |
🟡 PUT |
/web/api/v2.1/groups/{group_id}/policy |
Update Group Policy |
🔵 GET |
/web/api/v2.1/groups/{group_id} |
Get Group by ID |
🟡 PUT |
/web/api/v2.1/groups/{group_id} |
Update Group |
🔴 DELETE |
/web/api/v2.1/groups/{group_id} |
Delete Group |
🟡 PUT |
/web/api/v2.1/groups/{group_id}/move-agents |
Move Agents |
🟡 PUT |
/web/api/v2.1/groups/{group_id}/regenerate-key |
Regenerate Group Token |
🟡 PUT |
/web/api/v2.1/groups/{group_id}/revert-policy |
Revert Policy |
🔵 GET |
/web/api/v2.1/groups |
Get Groups |
🟢 POST |
/web/api/v2.1/groups |
Create Group |
🟡 PUT |
/web/api/v2.1/groups/ranks |
Update Ranks |
🔵 GET |
/web/api/v2.1/private/navigation/groups |
Get Groups |
🔵 GET |
/web/api/v2.1/private/navigation/groups/{scope_id} |
Get One Group |
Hashes
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/hashes/{hash}/classification |
Hash classification |
🔵 GET |
/web/api/v2.1/hashes/{hash}/reputation |
Hash Reputation |
InstalledApplications
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/installed-applications |
Get Installed Applications |
🔵 GET |
/web/api/v2.1/installed-applications/cves |
Get CVEs |
🔵 GET |
/web/api/v2.1/private/installed-applications/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/installed-applications/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/installed-applications/free-text-filters |
Freetext filters |
🔵 GET |
/web/api/v2.1/private/installed-applications/risk-levels-count |
Count by Risk Levels |
🔵 GET |
/web/api/v2.1/private/installed-applications/{agent_application_id}/cves |
Get Application CVEs |
Locations
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/locations |
Get Locations |
🟢 POST |
/web/api/v2.1/locations |
Create Location |
🔴 DELETE |
/web/api/v2.1/locations |
Delete Locations |
🟡 PUT |
/web/api/v2.1/locations/{location_id} |
Update Location |
🔵 GET |
/web/api/v2.1/private/locations/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/locations/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/locations/free-text-filters |
FreeText Filters |
Private
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/accounts |
Get accounts private |
🔵 GET |
/web/api/v2.1/private/accounts/name-available |
Available Name |
🔵 GET |
/web/api/v2.1/private/agents/available-actions |
DEPRECATED Get Agent Available Actions |
🟢 POST |
/web/api/v2.1/private/agents/available-actions |
Get Agent Available Actions |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/events-throttling |
Event Throttling |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/flush-events-queue |
Flush Event Queue |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/protect |
Protect |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-crash-dumps |
Purge Crash Dumps |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-db |
Purge DB |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-research-data |
Purge Research Data |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/reload |
Reload |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/restart |
Restart |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/revoke-token |
Revoke Token |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/send-crash-dumps |
Send Crash Dumps |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/send-research-data |
Send Research Data |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/unprotect |
Unprotect |
🟢 POST |
/web/api/v2.1/private/agents/actions/randomize-dv-host |
Randomize DV Host |
🔵 GET |
/web/api/v2.1/private/agents/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/agents/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/agents/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/agents/summary |
Count Summary |
🔵 GET |
/web/api/v2.1/private/agents/{agent_id}/support-actions/configuration |
Get config |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/agents-connect |
Reconnect agent to network |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/agents-disconnect |
Disconnect agents from network |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/available-actions |
Available Actions |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/alerts/free-text-filters |
FreeText Filters |
🟢 POST |
/web/api/v2.1/private/cloud-detection/alerts/mark-as-threat |
Mark alert as threat with sype suspiciousmelicious |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/available-actions |
Available Actions |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/cloud-detection/rules/wizardOptions |
Get Rule Wizard |
🔵 GET |
/web/api/v2.1/private/device-control/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/device-control/interfaces |
Get Interfaces |
🔵 GET |
/web/api/v2.1/private/device-control/unscoped |
Get Unscoped Rules |
🔵 GET |
/web/api/v2.1/private/exclusions/applications-catalog |
Get Catalog Exclusions |
🟢 POST |
/web/api/v2.1/private/exclusions/applications-catalog |
Add Exclusions from catalog |
🔵 GET |
/web/api/v2.1/private/exclusions/filters-autocomplete |
Auto complete |
🔵 GET |
/web/api/v2.1/private/exclusions/filters-count |
Count Exclusions by Filters |
🔵 GET |
/web/api/v2.1/private/exclusions/free-text-filters |
Freetext filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/{firewall_rule_category}/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/firewall-control/{firewall_rule_category}/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/{firewall_rule_category}/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/{firewall_rule_category}/unscoped |
Get Unscoped Rules |
🔵 GET |
/web/api/v2.1/private/firewall-control/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/firewall-control/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/firewall-control/unscoped |
Get Unscoped Rules |
🔵 GET |
/web/api/v2.1/private/installed-applications/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/installed-applications/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/installed-applications/free-text-filters |
Freetext filters |
🔵 GET |
/web/api/v2.1/private/installed-applications/risk-levels-count |
Count by Risk Levels |
🔵 GET |
/web/api/v2.1/private/installed-applications/{agent_application_id}/cves |
Get Application CVEs |
🔵 GET |
/web/api/v2.1/private/locations/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/locations/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/locations/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/navigation/accounts |
Get Accounts for Navigation |
🔵 GET |
/web/api/v2.1/private/navigation/accounts/{scope_id} |
Get One Account |
🔵 GET |
/web/api/v2.1/private/navigation/groups |
Get Groups |
🔵 GET |
/web/api/v2.1/private/navigation/groups/{scope_id} |
Get One Group |
🔵 GET |
/web/api/v2.1/private/navigation/sites |
Get Sites for Navigation |
🔵 GET |
/web/api/v2.1/private/navigation/sites/{scope_id} |
Get One Site |
🔵 GET |
/web/api/v2.1/private/navigation/search |
Search for Scope Objects |
🔵 GET |
/web/api/v2.1/private/navigation/top-level/totals |
Get Top Level Count |
🔵 GET |
/web/api/v2.1/private/navigation/totals |
Get Total Children and Endpoints |
🔵 GET |
/web/api/v2.1/private/policy |
Get Policy |
🟢 POST |
/web/api/v2.1/private/policy |
Create Policy |
🔵 GET |
/web/api/v2.1/private/ranger/auto-deploy/get-deployers |
Get Cred group details |
🟢 POST |
/web/api/v2.1/private/ranger/auto-deploy/masterphrase-attempt |
Masterphrase attempt |
🔵 GET |
/web/api/v2.1/private/ranger/auto-deploy/start |
Get Cred group details |
🔵 GET |
/web/api/v2.1/private/ranger/cred-groups/domains |
Get agent domains and cred group usage |
🔵 GET |
/web/api/v2.1/private/ranger/cred-groups/{cred_group_id}/details |
Get Cred group details |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/dashboard |
Ranger Network Dashboard |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/export/csv |
Ranger Network Export |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/ranger/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/ranger/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/ranger/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/ranger/review-reasons |
Get reasons |
🔵 GET |
/web/api/v2.1/private/ranger/scan-data |
Get Scan Raw Data |
🔵 GET |
/web/api/v2.1/private/ranger/scan-report |
Get a Scan Report |
🔵 GET |
/web/api/v2.1/private/ranger/snapshot-status |
Get Snapshot Status |
🔵 GET |
/web/api/v2.1/private/restrictions/filters-autocomplete |
Auto complete |
🔵 GET |
/web/api/v2.1/private/restrictions/filters-count |
Count Exclusions by Filters |
🔵 GET |
/web/api/v2.1/private/restrictions/free-text-filters |
Freetext filters |
🔵 GET |
/web/api/v2.1/private/rogues/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/rogues/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/rogues/networks/dashboard |
Rogues Network Dashboard |
🔵 GET |
/web/api/v2.1/private/rogues/ranger/filters-count |
Count by Filters |
🟢 POST |
/web/api/v2.1/private/rogues/sign-eula |
Sign Rogues EULA |
🔵 GET |
/web/api/v2.1/private/rogues/snapshot-status |
Get Snapshot Status |
🔵 GET |
/web/api/v2.1/private/rogues/status |
Get Rogues Status |
🔵 GET |
/web/api/v2.1/private/settings/system-configuration |
Get System Config |
🔵 GET |
/web/api/v2.1/private/settings/unauthenticated |
Get Settings without Authentication |
🔵 GET |
/web/api/v2.1/private/tasks |
Get tasks |
🟢 POST |
/web/api/v2.1/private/tasks/cancel-task |
Cancel Tasks |
🔵 GET |
/web/api/v2.1/private/tasks/filters-autocomplete |
Auto complete |
🔵 GET |
/web/api/v2.1/private/tasks/filters-count |
Count Tasks by Filters |
🔵 GET |
/web/api/v2.1/private/tasks/free-text-filters |
Freetext filters |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/all-events |
Get Enriched Events |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/count-by-type |
Count Events by Type |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/event |
Get Process Event |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/prefetch-events |
Prefetch events |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/timeline |
Get Timeline Limits |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/tree |
Get Tree |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/analysis |
Threat Analysis |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/appearances |
Threat Appearances |
🟢 POST |
/web/api/v2.1/private/threats/agents-connect |
Connect Agents |
🟢 POST |
/web/api/v2.1/private/threats/agents-disconnect |
Disconnect Agents |
🔵 GET |
/web/api/v2.1/private/threats/available-actions |
Get Threat Available Actions |
🟢 POST |
/web/api/v2.1/private/threats/create-slim-threat |
Create Slim Threat |
🟢 POST |
/web/api/v2.1/private/threats/dv-add-to-blacklist |
Add to Blacklist Deep Visibility |
🟢 POST |
/web/api/v2.1/private/threats/dv-mark-as-threat |
Mark as Threat Deep Visibility |
🔵 GET |
/web/api/v2.1/private/threats/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/threats/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/threats/free-text-filters |
FreeText Filters |
🟢 POST |
/web/api/v2.1/private/threats/ioc-create-threats |
Create Deep Visibility Threat |
🟢 POST |
/web/api/v2.1/private/threats/multiple-actions |
Multiple actions for Threats |
🔵 GET |
/web/api/v2.1/private/threats/summary |
Threat Summary |
🔵 GET |
/web/api/v2.1/private/threats/timeline-categories |
Get Timeline Categories |
🟢 POST |
/web/api/v2.1/private/users/iframe-token-details |
iFrame Token Details |
🟢 POST |
/web/api/v2.1/private/users/login/by-iframe-token |
Login by iFrame Token |
🔵 GET |
/web/api/v2.1/private/users/my-token |
Get Token |
🟢 POST |
/web/api/v2.1/private/users/revoke-iframe-token |
Revoke iFrame Token |
🟢 POST |
/web/api/v2.1/private/account-with-admin |
Create Account and User |
🔵 GET |
/web/api/v2.1/private/bulk-tasks |
Get tasks |
🔵 GET |
/web/api/v2.1/private/dashboard |
Dashboard Overview |
🔵 GET |
/web/api/v2.1/private/dv/translate-query |
Translating S1QL query into Scalyr query |
🔵 GET |
/web/api/v2.1/private/filters/enriched |
Filters with Metadata |
🔵 GET |
/web/api/v2.1/private/group-count |
Group Counts |
🔵 GET |
/web/api/v2.1/private/groups-default |
Get Site Default Group |
🔵 GET |
/web/api/v2.1/private/hashes/scopes |
Hash Scopes |
🔵 GET |
/web/api/v2.1/private/my-user |
My User for UI |
🔵 GET |
/web/api/v2.1/private/rbac/user-permissions |
Get Console Permissions |
🔵 GET |
/web/api/v2.1/private/singularity-marketplace/availability |
Get Singularity Marketplace availability |
🟢 POST |
/web/api/v2.1/private/star/manage/update-limits |
Update rule and alert limits per scope |
🔵 GET |
/web/api/v2.1/private/system/enabled-features |
User Information |
🔵 GET |
/web/api/v2.1/private/threat-groups |
Grouped Threats |
🔵 GET |
/web/api/v2.1/private/user-info |
User info |
AvailableActions
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/agents/available-actions |
DEPRECATED Get Agent Available Actions |
🟢 POST |
/web/api/v2.1/private/agents/available-actions |
Get Agent Available Actions |
SupportActions
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/private/agents/support-actions/events-throttling |
Event Throttling |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/flush-events-queue |
Flush Event Queue |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/protect |
Protect |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-crash-dumps |
Purge Crash Dumps |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-db |
Purge DB |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/purge-research-data |
Purge Research Data |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/reload |
Reload |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/restart |
Restart |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/revoke-token |
Revoke Token |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/send-crash-dumps |
Send Crash Dumps |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/send-research-data |
Send Research Data |
🟢 POST |
/web/api/v2.1/private/agents/support-actions/unprotect |
Unprotect |
ApplicationsCatalog
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/exclusions/applications-catalog |
Get Catalog Exclusions |
🟢 POST |
/web/api/v2.1/private/exclusions/applications-catalog |
Add Exclusions from catalog |
🔵 GET |
/web/api/v2.1/singularity-marketplace/applications-catalog |
Get Applications Catalog |
🔵 GET |
/web/api/v2.1/singularity-marketplace/applications-catalog/{application_catalog_id}/config |
Get Configuration Fields |
Navigation
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/navigation/accounts |
Get Accounts for Navigation |
🔵 GET |
/web/api/v2.1/private/navigation/accounts/{scope_id} |
Get One Account |
🔵 GET |
/web/api/v2.1/private/navigation/groups |
Get Groups |
🔵 GET |
/web/api/v2.1/private/navigation/groups/{scope_id} |
Get One Group |
🔵 GET |
/web/api/v2.1/private/navigation/sites |
Get Sites for Navigation |
🔵 GET |
/web/api/v2.1/private/navigation/sites/{scope_id} |
Get One Site |
🔵 GET |
/web/api/v2.1/private/navigation/search |
Search for Scope Objects |
🔵 GET |
/web/api/v2.1/private/navigation/top-level/totals |
Get Top Level Count |
🔵 GET |
/web/api/v2.1/private/navigation/totals |
Get Total Children and Endpoints |
Sites
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/navigation/sites |
Get Sites for Navigation |
🔵 GET |
/web/api/v2.1/private/navigation/sites/{scope_id} |
Get One Site |
🔵 GET |
/web/api/v2.1/sites/{site_id}/policy |
Site Policy |
🟡 PUT |
/web/api/v2.1/sites/{site_id}/policy |
Update Site Policy |
🔵 GET |
/web/api/v2.1/sites/{site_id} |
Get Site by ID |
🟡 PUT |
/web/api/v2.1/sites/{site_id} |
Update Site |
🔴 DELETE |
/web/api/v2.1/sites/{site_id} |
Delete Site |
🟢 POST |
/web/api/v2.1/sites/{site_id}/expire-now |
Expire Site |
🟡 PUT |
/web/api/v2.1/sites/{site_id}/reactivate |
Reactivate Site |
🟡 PUT |
/web/api/v2.1/sites/{site_id}/regenerate-key |
Regenerate Site Key |
🟡 PUT |
/web/api/v2.1/sites/{site_id}/revert-policy |
Revert Policy |
🔵 GET |
/web/api/v2.1/sites |
Get Sites |
🟢 POST |
/web/api/v2.1/sites |
Create Site |
🟢 POST |
/web/api/v2.1/sites/duplicate-site |
Create duplicate site |
Ranger
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/ranger/auto-deploy/get-deployers |
Get Cred group details |
🟢 POST |
/web/api/v2.1/private/ranger/auto-deploy/masterphrase-attempt |
Masterphrase attempt |
🔵 GET |
/web/api/v2.1/private/ranger/auto-deploy/start |
Get Cred group details |
🔵 GET |
/web/api/v2.1/private/ranger/cred-groups/domains |
Get agent domains and cred group usage |
🔵 GET |
/web/api/v2.1/private/ranger/cred-groups/{cred_group_id}/details |
Get Cred group details |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/dashboard |
Ranger Network Dashboard |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/export/csv |
Ranger Network Export |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/ranger/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/ranger/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/ranger/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/ranger/review-reasons |
Get reasons |
🔵 GET |
/web/api/v2.1/private/ranger/scan-data |
Get Scan Raw Data |
🔵 GET |
/web/api/v2.1/private/ranger/scan-report |
Get a Scan Report |
🔵 GET |
/web/api/v2.1/private/ranger/snapshot-status |
Get Snapshot Status |
🟡 PUT |
/web/api/v2.1/ranger/cred-groups/details/{detail_id} |
Update Cred Group Details |
🔴 DELETE |
/web/api/v2.1/ranger/cred-groups/details/{detail_id} |
Delete Cred Group Detail |
🔵 GET |
/web/api/v2.1/ranger/cred-groups/details |
Get Cred group details |
🟢 POST |
/web/api/v2.1/ranger/cred-groups/details |
Add cred details |
🟡 PUT |
/web/api/v2.1/ranger/cred-groups/{cred_group_id} |
Update Cred Group |
🔴 DELETE |
/web/api/v2.1/ranger/cred-groups/{cred_group_id} |
Delete Cred Group |
🔵 GET |
/web/api/v2.1/ranger/cred-groups |
Get Cred groups |
🟢 POST |
/web/api/v2.1/ranger/cred-groups |
Create Cred Group |
🟢 POST |
/web/api/v2.1/ranger/device-review |
Change Device Review in Bulk |
🟡 PUT |
/web/api/v2.1/ranger/device-review/{inventory_id} |
Change Device Review |
🔵 GET |
/web/api/v2.1/ranger/gateways |
Get Gateways |
🟢 POST |
/web/api/v2.1/ranger/gateways/update |
Update Gateways |
🟡 PUT |
/web/api/v2.1/ranger/gateways/{gateway_id} |
Update Gateway |
🔵 GET |
/web/api/v2.1/ranger/settings |
Get Ranger Settings |
🟡 PUT |
/web/api/v2.1/ranger/settings |
Update Ranger Settings |
🔵 GET |
/web/api/v2.1/ranger/{inventory_id}/json |
JSON Raw Data |
🔵 GET |
/web/api/v2.1/ranger/{inventory_id}/json/export |
Export JSON Raw Data |
🟢 POST |
/web/api/v2.1/ranger/auto-deploy/deploy |
Add new deploy command for device from agent from Task Infra |
🔵 GET |
/web/api/v2.1/ranger/report/csv |
Export Ranger Data |
🔵 GET |
/web/api/v2.1/ranger/table-view |
Get Ranger Table |
🟢 POST |
/web/api/v2.1/ranger/tags |
Change Device Tags |
AutoDeploy
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/ranger/auto-deploy/get-deployers |
Get Cred group details |
🟢 POST |
/web/api/v2.1/private/ranger/auto-deploy/masterphrase-attempt |
Masterphrase attempt |
🔵 GET |
/web/api/v2.1/private/ranger/auto-deploy/start |
Get Cred group details |
CredGroups
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/ranger/cred-groups/domains |
Get agent domains and cred group usage |
🔵 GET |
/web/api/v2.1/private/ranger/cred-groups/{cred_group_id}/details |
Get Cred group details |
🟡 PUT |
/web/api/v2.1/ranger/cred-groups/details/{detail_id} |
Update Cred Group Details |
🔴 DELETE |
/web/api/v2.1/ranger/cred-groups/details/{detail_id} |
Delete Cred Group Detail |
🔵 GET |
/web/api/v2.1/ranger/cred-groups/details |
Get Cred group details |
🟢 POST |
/web/api/v2.1/ranger/cred-groups/details |
Add cred details |
🟡 PUT |
/web/api/v2.1/ranger/cred-groups/{cred_group_id} |
Update Cred Group |
🔴 DELETE |
/web/api/v2.1/ranger/cred-groups/{cred_group_id} |
Delete Cred Group |
🔵 GET |
/web/api/v2.1/ranger/cred-groups |
Get Cred groups |
🟢 POST |
/web/api/v2.1/ranger/cred-groups |
Create Cred Group |
Gateways
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/ranger/gateways/dashboard |
Ranger Network Dashboard |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/export/csv |
Ranger Network Export |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/ranger/gateways/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/ranger/gateways |
Get Gateways |
🟢 POST |
/web/api/v2.1/ranger/gateways/update |
Update Gateways |
🟡 PUT |
/web/api/v2.1/ranger/gateways/{gateway_id} |
Update Gateway |
Restrictions
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/restrictions/filters-autocomplete |
Auto complete |
🔵 GET |
/web/api/v2.1/private/restrictions/filters-count |
Count Exclusions by Filters |
🔵 GET |
/web/api/v2.1/private/restrictions/free-text-filters |
Freetext filters |
🔵 GET |
/web/api/v2.1/restrictions |
Get Blacklist |
🟢 POST |
/web/api/v2.1/restrictions |
Create Blacklist Item |
🟡 PUT |
/web/api/v2.1/restrictions |
Update Blacklist Item |
🔴 DELETE |
/web/api/v2.1/restrictions |
Delete Blacklist Item |
🟢 POST |
/web/api/v2.1/restrictions/validate |
Validate Blacklist Item |
Rogues
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/rogues/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/rogues/free-text-filters |
FreeText Filters |
🔵 GET |
/web/api/v2.1/private/rogues/networks/dashboard |
Rogues Network Dashboard |
🔵 GET |
/web/api/v2.1/private/rogues/ranger/filters-count |
Count by Filters |
🟢 POST |
/web/api/v2.1/private/rogues/sign-eula |
Sign Rogues EULA |
🔵 GET |
/web/api/v2.1/private/rogues/snapshot-status |
Get Snapshot Status |
🔵 GET |
/web/api/v2.1/private/rogues/status |
Get Rogues Status |
🔵 GET |
/web/api/v2.1/rogues/settings |
Get Rogues Settings |
🟡 PUT |
/web/api/v2.1/rogues/settings |
Update Rogues Settings |
🔵 GET |
/web/api/v2.1/rogues/report/csv |
Export Rogues Data |
🔵 GET |
/web/api/v2.1/rogues/table-view |
Get Rogues Table |
Settings
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/settings/system-configuration |
Get System Config |
🔵 GET |
/web/api/v2.1/private/settings/unauthenticated |
Get Settings without Authentication |
🔵 GET |
/web/api/v2.1/ranger/settings |
Get Ranger Settings |
🟡 PUT |
/web/api/v2.1/ranger/settings |
Update Ranger Settings |
🔵 GET |
/web/api/v2.1/rogues/settings |
Get Rogues Settings |
🟡 PUT |
/web/api/v2.1/rogues/settings |
Update Rogues Settings |
🔵 GET |
/web/api/v2.1/settings/active-directory/scope-mapping |
Get AD FQDNs |
🟡 PUT |
/web/api/v2.1/settings/active-directory/scope-mapping |
Set AD FQDNs |
🔵 GET |
/web/api/v2.1/settings/active-directory |
Get AD Settings |
🟡 PUT |
/web/api/v2.1/settings/active-directory |
Set AD Settings |
🟢 POST |
/web/api/v2.1/settings/active-directory/test |
Test AD Settings |
🔵 GET |
/web/api/v2.1/settings/microsoft |
Get Microsoft Settings |
🟡 PUT |
/web/api/v2.1/settings/microsoft |
Set Microsoft Settings |
🟢 POST |
/web/api/v2.1/settings/microsoft/test |
Test Microsoft Settings |
🔵 GET |
/web/api/v2.1/settings/notifications |
Get Notification Settings |
🟡 PUT |
/web/api/v2.1/settings/notifications |
Set Notification Settings |
🟢 POST |
/web/api/v2.1/settings/notifications/cancel-pending-emails |
Clear Pending Emails |
🔵 GET |
/web/api/v2.1/settings/recipients |
Get Notification Recipients |
🟡 PUT |
/web/api/v2.1/settings/recipients |
Set Notification Recipients |
🔴 DELETE |
/web/api/v2.1/settings/recipients/{recipient_id} |
Delete Notification Recipient |
🔵 GET |
/web/api/v2.1/settings/sms |
Get SMS Settings |
🟡 PUT |
/web/api/v2.1/settings/sms |
Set SMS Settings |
🔵 GET |
/web/api/v2.1/settings/smtp |
Get SMTP Settings |
🟡 PUT |
/web/api/v2.1/settings/smtp |
Set SMTP Settings |
🟢 POST |
/web/api/v2.1/settings/smtp/test |
Test SMTP Settings |
🔵 GET |
/web/api/v2.1/settings/sso |
Get SSO Settings |
🟡 PUT |
/web/api/v2.1/settings/sso |
Set SSO Settings |
🟢 POST |
/web/api/v2.1/settings/sso/test |
Test SSO Settings |
🔵 GET |
/web/api/v2.1/settings/syslog |
Get Syslog Settings |
🟡 PUT |
/web/api/v2.1/settings/syslog |
Set Syslog Settings |
🟢 POST |
/web/api/v2.1/settings/syslog/test |
Test Syslog Settings |
Tasks
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/tasks |
Get tasks |
🟢 POST |
/web/api/v2.1/private/tasks/cancel-task |
Cancel Tasks |
🔵 GET |
/web/api/v2.1/private/tasks/filters-autocomplete |
Auto complete |
🔵 GET |
/web/api/v2.1/private/tasks/filters-count |
Count Tasks by Filters |
🔵 GET |
/web/api/v2.1/private/tasks/free-text-filters |
Freetext filters |
Threats
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/all-events |
Get Enriched Events |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/count-by-type |
Count Events by Type |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/event |
Get Process Event |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/prefetch-events |
Prefetch events |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/timeline |
Get Timeline Limits |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/tree |
Get Tree |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/analysis |
Threat Analysis |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/appearances |
Threat Appearances |
🟢 POST |
/web/api/v2.1/private/threats/agents-connect |
Connect Agents |
🟢 POST |
/web/api/v2.1/private/threats/agents-disconnect |
Disconnect Agents |
🔵 GET |
/web/api/v2.1/private/threats/available-actions |
Get Threat Available Actions |
🟢 POST |
/web/api/v2.1/private/threats/create-slim-threat |
Create Slim Threat |
🟢 POST |
/web/api/v2.1/private/threats/dv-add-to-blacklist |
Add to Blacklist Deep Visibility |
🟢 POST |
/web/api/v2.1/private/threats/dv-mark-as-threat |
Mark as Threat Deep Visibility |
🔵 GET |
/web/api/v2.1/private/threats/filters-autocomplete |
Auto Complete |
🔵 GET |
/web/api/v2.1/private/threats/filters-count |
Count by Filters |
🔵 GET |
/web/api/v2.1/private/threats/free-text-filters |
FreeText Filters |
🟢 POST |
/web/api/v2.1/private/threats/ioc-create-threats |
Create Deep Visibility Threat |
🟢 POST |
/web/api/v2.1/private/threats/multiple-actions |
Multiple actions for Threats |
🔵 GET |
/web/api/v2.1/private/threats/summary |
Threat Summary |
🔵 GET |
/web/api/v2.1/private/threats/timeline-categories |
Get Timeline Categories |
🟡 PUT |
/web/api/v2.1/threats/{threat_id}/notes/{note_id} |
Update Threat Note |
🔴 DELETE |
/web/api/v2.1/threats/{threat_id}/notes/{note_id} |
Delete Threat Note |
🔵 GET |
/web/api/v2.1/threats/{threat_id}/notes |
Get Threat Notes |
🔵 GET |
/web/api/v2.1/threats/{threat_id}/download-from-cloud |
Download from cloud |
🔵 GET |
/web/api/v2.1/threats/{threat_id}/explore/events |
Get Events |
🔵 GET |
/web/api/v2.1/threats/{threat_id}/timeline |
Get Threat Timeline |
🔵 GET |
/web/api/v2.1/threats/{threat_id}/whitening-options |
Exclusion Options |
🔵 GET |
/web/api/v2.1/threats |
Get Threats |
🟢 POST |
/web/api/v2.1/threats/add-to-blacklist |
Add to Blacklist |
🟢 POST |
/web/api/v2.1/threats/add-to-exclusions |
Add to Exclusions |
🟢 POST |
/web/api/v2.1/threats/analyst-verdict |
Update Threat Analyst Verdict |
🟢 POST |
/web/api/v2.1/threats/engines/disable |
Disable Engines |
🔵 GET |
/web/api/v2.1/threats/export |
Export Threats |
🟢 POST |
/web/api/v2.1/threats/external-ticket-id |
Update Threat External Ticket ID |
🟢 POST |
/web/api/v2.1/threats/fetch-file |
Fetch Threat File |
🟢 POST |
/web/api/v2.1/threats/incident |
Updated Threat Incident |
🟢 POST |
/web/api/v2.1/threats/mitigate/{action} |
Mitigate Threats |
🔵 GET |
/web/api/v2.1/threats/mitigation-report/{report_id} |
Export Mitigation Report |
🟢 POST |
/web/api/v2.1/threats/notes |
Add Note to Multiple |
Explore
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/all-events |
Get Enriched Events |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/count-by-type |
Count Events by Type |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/event |
Get Process Event |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/prefetch-events |
Prefetch events |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/timeline |
Get Timeline Limits |
🔵 GET |
/web/api/v2.1/private/threats/{threat_id}/explore/tree |
Get Tree |
Users
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/private/users/iframe-token-details |
iFrame Token Details |
🟢 POST |
/web/api/v2.1/private/users/login/by-iframe-token |
Login by iFrame Token |
🔵 GET |
/web/api/v2.1/private/users/my-token |
Get Token |
🟢 POST |
/web/api/v2.1/private/users/revoke-iframe-token |
Revoke iFrame Token |
🟢 POST |
/web/api/v2.1/users/2fa/disable |
Disable 2FA |
🟢 POST |
/web/api/v2.1/users/2fa/enable |
Enable 2FA |
🟢 POST |
/web/api/v2.1/users/auth/app |
Auth App |
🟢 POST |
/web/api/v2.1/users/auth/eula |
Sign EULA |
🟢 POST |
/web/api/v2.1/users/auth/recovery-code |
Auth Recovery Code |
🔵 GET |
/web/api/v2.1/users/login/sso-saml2 |
Redirect to SSO |
🟢 POST |
/web/api/v2.1/users/login/sso-saml2/{scope_id} |
Auth by SSO |
🟢 POST |
/web/api/v2.1/users/login |
Login |
🟢 POST |
/web/api/v2.1/users/login/by-api-token |
Login by API Token |
🔵 GET |
/web/api/v2.1/users/login/by-token |
Login by Token |
🟢 POST |
/web/api/v2.1/users/onboarding/send-verification-email |
Send Verification Email |
🔵 GET |
/web/api/v2.1/users/onboarding/validate-token |
Validate Verification Token |
🟢 POST |
/web/api/v2.1/users/onboarding/verify |
Email Verification |
🔵 GET |
/web/api/v2.1/users/{user_id} |
Get User |
🟡 PUT |
/web/api/v2.1/users/{user_id} |
Update User |
🔴 DELETE |
/web/api/v2.1/users/{user_id} |
Delete User |
🔵 GET |
/web/api/v2.1/users/{user_id}/api-token-details |
API Token by User ID |
🔵 GET |
/web/api/v2.1/users |
List users |
🟢 POST |
/web/api/v2.1/users |
Create User |
🟢 POST |
/web/api/v2.1/users/api-token-details |
API Token Details |
🟢 POST |
/web/api/v2.1/users/change-password |
Change Password |
🟢 POST |
/web/api/v2.1/users/delete-users |
Bulk Delete Users |
🟢 POST |
/web/api/v2.1/users/enable-app |
Enable 2FA App |
🟢 POST |
/web/api/v2.1/users/generate-api-token |
Generate API Token |
🟢 POST |
/web/api/v2.1/users/generate-iframe-token |
Generate iFrame Token |
🟢 POST |
/web/api/v2.1/users/generate-recovery-codes |
Generate Recovery Code |
🟢 POST |
/web/api/v2.1/users/logout |
Logout |
🟢 POST |
/web/api/v2.1/users/request-app |
Request 2FA App |
🟢 POST |
/web/api/v2.1/users/revoke-api-token |
Revoke API Token |
🔵 GET |
/web/api/v2.1/users/rs-auth-check |
Check Remote Shell Permissions |
🔵 GET |
/web/api/v2.1/users/tenant-admin-auth-check |
Check Global User |
🔵 GET |
/web/api/v2.1/users/viewer-auth-check |
Check Viewer |
Details
| Endpoint | Description | |
|---|---|---|
🟡 PUT |
/web/api/v2.1/ranger/cred-groups/details/{detail_id} |
Update Cred Group Details |
🔴 DELETE |
/web/api/v2.1/ranger/cred-groups/details/{detail_id} |
Delete Cred Group Detail |
🔵 GET |
/web/api/v2.1/ranger/cred-groups/details |
Get Cred group details |
🟢 POST |
/web/api/v2.1/ranger/cred-groups/details |
Add cred details |
DeviceReview
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/ranger/device-review |
Change Device Review in Bulk |
🟡 PUT |
/web/api/v2.1/ranger/device-review/{inventory_id} |
Change Device Review |
Rbac
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/rbac/role/{role_id} |
Get Specific Role Definition |
🟡 PUT |
/web/api/v2.1/rbac/role/{role_id} |
Update role |
🔴 DELETE |
/web/api/v2.1/rbac/role/{role_id} |
Delete role |
🔵 GET |
/web/api/v2.1/rbac/role |
Get template for new role |
🟢 POST |
/web/api/v2.1/rbac/role |
Create new role |
🔵 GET |
/web/api/v2.1/rbac/roles |
Get All Roles |
Role
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/rbac/role/{role_id} |
Get Specific Role Definition |
🟡 PUT |
/web/api/v2.1/rbac/role/{role_id} |
Update role |
🔴 DELETE |
/web/api/v2.1/rbac/role/{role_id} |
Delete role |
🔵 GET |
/web/api/v2.1/rbac/role |
Get template for new role |
🟢 POST |
/web/api/v2.1/rbac/role |
Create new role |
RemoteScripts
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/remote-scripts |
Get scripts |
🟢 POST |
/web/api/v2.1/remote-scripts |
Upload a new script |
🟢 POST |
/web/api/v2.1/remote-scripts/execute |
Run remote script |
ReportTasks
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/report-tasks |
Get Report Tasks |
🟢 POST |
/web/api/v2.1/report-tasks |
Create Report Task |
🟡 PUT |
/web/api/v2.1/report-tasks/{task_id} |
Update Report Task |
Reports
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/reports |
Get Reports |
🟢 POST |
/web/api/v2.1/reports/delete-reports |
Delete Reports |
🟢 POST |
/web/api/v2.1/reports/delete-tasks |
Delete Report Tasks |
🔵 GET |
/web/api/v2.1/reports/insights/types |
Get Insight Reports |
🔵 GET |
/web/api/v2.1/reports/{report_id}/{report_format} |
Download Report |
ActiveDirectory
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/active-directory/scope-mapping |
Get AD FQDNs |
🟡 PUT |
/web/api/v2.1/settings/active-directory/scope-mapping |
Set AD FQDNs |
🔵 GET |
/web/api/v2.1/settings/active-directory |
Get AD Settings |
🟡 PUT |
/web/api/v2.1/settings/active-directory |
Set AD Settings |
🟢 POST |
/web/api/v2.1/settings/active-directory/test |
Test AD Settings |
ScopeMapping
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/active-directory/scope-mapping |
Get AD FQDNs |
🟡 PUT |
/web/api/v2.1/settings/active-directory/scope-mapping |
Set AD FQDNs |
Microsoft
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/microsoft |
Get Microsoft Settings |
🟡 PUT |
/web/api/v2.1/settings/microsoft |
Set Microsoft Settings |
🟢 POST |
/web/api/v2.1/settings/microsoft/test |
Test Microsoft Settings |
Notifications
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/notifications |
Get Notification Settings |
🟡 PUT |
/web/api/v2.1/settings/notifications |
Set Notification Settings |
🟢 POST |
/web/api/v2.1/settings/notifications/cancel-pending-emails |
Clear Pending Emails |
Recipients
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/recipients |
Get Notification Recipients |
🟡 PUT |
/web/api/v2.1/settings/recipients |
Set Notification Recipients |
🔴 DELETE |
/web/api/v2.1/settings/recipients/{recipient_id} |
Delete Notification Recipient |
Sms
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/sms |
Get SMS Settings |
🟡 PUT |
/web/api/v2.1/settings/sms |
Set SMS Settings |
Smtp
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/smtp |
Get SMTP Settings |
🟡 PUT |
/web/api/v2.1/settings/smtp |
Set SMTP Settings |
🟢 POST |
/web/api/v2.1/settings/smtp/test |
Test SMTP Settings |
Sso
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/sso |
Get SSO Settings |
🟡 PUT |
/web/api/v2.1/settings/sso |
Set SSO Settings |
🟢 POST |
/web/api/v2.1/settings/sso/test |
Test SSO Settings |
Syslog
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/settings/syslog |
Get Syslog Settings |
🟡 PUT |
/web/api/v2.1/settings/syslog |
Set Syslog Settings |
🟢 POST |
/web/api/v2.1/settings/syslog/test |
Test Syslog Settings |
SingularityMarketplace
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/singularity-marketplace/applications |
Get Marketplace Applications |
🟢 POST |
/web/api/v2.1/singularity-marketplace/applications |
Install Applications |
🟡 PUT |
/web/api/v2.1/singularity-marketplace/applications |
Update Application Configuration |
🔴 DELETE |
/web/api/v2.1/singularity-marketplace/applications |
Delete Marketplace Application |
🔵 GET |
/web/api/v2.1/singularity-marketplace/applications/{application_id}/config |
Get Configuration fields for Catalog Application |
🟢 POST |
/web/api/v2.1/singularity-marketplace/applications/{mode} |
Enable or Disable application |
🔵 GET |
/web/api/v2.1/singularity-marketplace/applications-catalog |
Get Applications Catalog |
🔵 GET |
/web/api/v2.1/singularity-marketplace/applications-catalog/{application_catalog_id}/config |
Get Configuration Fields |
System
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/system/configuration |
Get System Config |
🟡 PUT |
/web/api/v2.1/system/configuration |
Set System Config |
🔵 GET |
/web/api/v2.1/system/status |
System Status |
🔵 GET |
/web/api/v2.1/system/status/cache |
Cache Status |
🔵 GET |
/web/api/v2.1/system/status/db |
Database Status |
🔵 GET |
/web/api/v2.1/system/info |
System Info |
Status
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/system/status |
System Status |
🔵 GET |
/web/api/v2.1/system/status/cache |
Cache Status |
🔵 GET |
/web/api/v2.1/system/status/db |
Database Status |
Tags
| Endpoint | Description | |
|---|---|---|
🟡 PUT |
/web/api/v2.1/tags/{tag_id} |
Edit Tag |
🔴 DELETE |
/web/api/v2.1/tags/{tag_id} |
Delete Tag by ID |
🔵 GET |
/web/api/v2.1/tags |
Get Tags |
🟢 POST |
/web/api/v2.1/tags |
Create Tags |
🔴 DELETE |
/web/api/v2.1/tags |
Delete Tags |
TasksConfiguration
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/tasks-configuration |
Get Task Configuration |
🟡 PUT |
/web/api/v2.1/tasks-configuration |
Create Task |
🔵 GET |
/web/api/v2.1/tasks-configuration/explicit-subscopes |
Get Child Scope Task Configuration |
🔵 GET |
/web/api/v2.1/tasks-configuration/has-explicit-subscope |
Has Child Scopes |
Tenant
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/tenant/policy |
Global Policy |
🟡 PUT |
/web/api/v2.1/tenant/policy |
Update Global Policy |
ThreatIntelligence
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/threat-intelligence/iocs |
Create IoCs |
🔴 DELETE |
/web/api/v2.1/threat-intelligence/iocs |
Delete IoCs |
Notes
| Endpoint | Description | |
|---|---|---|
🟡 PUT |
/web/api/v2.1/threats/{threat_id}/notes/{note_id} |
Update Threat Note |
🔴 DELETE |
/web/api/v2.1/threats/{threat_id}/notes/{note_id} |
Delete Threat Note |
🔵 GET |
/web/api/v2.1/threats/{threat_id}/notes |
Get Threat Notes |
Download
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/update/agent/download/{package_id} |
Download Agent Package |
🔵 GET |
/web/api/v2.1/update/agent/download/{site_id}/{package_id} |
Download Package |
Packages
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/update/agent/packages |
Get Latest Packages |
🔴 DELETE |
/web/api/v2.1/update/agent/packages |
Delete Packages |
🟡 PUT |
/web/api/v2.1/update/agent/packages/{package_id} |
Update package |
Update
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/update/agent/latest-packages |
Latest Packages by OS |
Upload
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/upload/software |
Upload System Package |
🟢 POST |
/web/api/v2.1/upload/software/deploy |
Deploy System Package |
🟢 POST |
/web/api/v2.1/upload/agent/software |
Upload Agent Package |
Software
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/upload/software |
Upload System Package |
🟢 POST |
/web/api/v2.1/upload/software/deploy |
Deploy System Package |
2fa
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/users/2fa/disable |
Disable 2FA |
🟢 POST |
/web/api/v2.1/users/2fa/enable |
Enable 2FA |
Auth
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/users/auth/app |
Auth App |
🟢 POST |
/web/api/v2.1/users/auth/eula |
Sign EULA |
🟢 POST |
/web/api/v2.1/users/auth/recovery-code |
Auth Recovery Code |
Login
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/users/login/sso-saml2 |
Redirect to SSO |
🟢 POST |
/web/api/v2.1/users/login/sso-saml2/{scope_id} |
Auth by SSO |
🟢 POST |
/web/api/v2.1/users/login |
Login |
🟢 POST |
/web/api/v2.1/users/login/by-api-token |
Login by API Token |
🔵 GET |
/web/api/v2.1/users/login/by-token |
Login by Token |
SsoSaml2
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/users/login/sso-saml2 |
Redirect to SSO |
🟢 POST |
/web/api/v2.1/users/login/sso-saml2/{scope_id} |
Auth by SSO |
Onboarding
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/users/onboarding/send-verification-email |
Send Verification Email |
🔵 GET |
/web/api/v2.1/users/onboarding/validate-token |
Validate Verification Token |
🟢 POST |
/web/api/v2.1/users/onboarding/verify |
Email Verification |
ApplicationInventory
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/application-inventory |
Grouped app inventory |
ApplicationInventoryCounts
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/application-inventory-counts |
Counters |
LastActivityAsSyslog
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/last-activity-as-syslog |
Last activity as Syslog message |
Sentinelonerss
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/sentinelonerss |
S1 RSS Feed |
SiteWithAdmin
| Endpoint | Description | |
|---|---|---|
🟢 POST |
/web/api/v2.1/site-with-admin |
Create Site and User |
Tests
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/tests/hello |
FreeText Filters |
User
| Endpoint | Description | |
|---|---|---|
🔵 GET |
/web/api/v2.1/user |
User by token |
Compatibility
- n8n version: 1.0+ (tested on 2.x)
- Node.js version: 18+