@avantguardllc/n8n-nodes-saasalertsrespond
v0.1.0
Published
n8n node for SaaSAlerts - Respond
Downloads
20
Maintainers
Readme
SaaSAlerts - Respond n8n Node
OverviewThe Respond APIs allows partners to manage SaaS Alerts Respond.For example, the API enables partners to:- Create Respond Rules- Get all Respond Rules- Approve or reject triggered rules- Endpoint details are listed below# Getting StartedTo get started with the SaaS Alerts API, follow these steps:1. Obtain an API key by navigating to Settings > API in the SaaS Alerts dashboard, and clicking on the “Show key” button under Manage API.2. Use the API key to authenticate requests to the API and start using our endpoints. The documentation provides the details on the available endpoints, request/response structures, and authentication mechanisms.# SupportIf you have any questions or need further assistance, please don’t hesitate to contact our support team. We are always here to help!
Table of Contents
Installation
Follow the n8n community node installation guide.
Or install directly via npm:
npm install @avantguardllc/n8n-nodes-saasalertsrespondAuthentication
This node authenticates using an API Key.
| Setting | Value |
|---------|-------|
| Type | API Key |
| Sent in | header |
| Header / Query name | accesstoken |
| Base URL | https://us-central1-the-byway-248217.cloudfunctions.net/respondApi/api/v1 (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://us-central1-the-byway-248217.cloudfunctions.net/respondApi/api/v1
Auth
| | Endpoint | Description |
|---|----------|-------------|
| 🟢 POST | /auth | Get access token |
States
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /states | Get respond state |
| 🟢 POST | /states/enable | Enable respond state |
| 🟢 POST | /states/disable | Disable respond state |
Organizations
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /organizations | Get all organizations connections |
| 🔵 GET | /organizations/disconnected | Get only disconnected organizations (includes not connected, broken and upgradable organizations) |
| 🔵 GET | /organizations/{id}/application-connections | Get all applications for current organization |
Applications
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /applications | Retrieve applications that will help you retrieve the client ids to do oauth connections |
| 🔵 GET | /applications/{id} | Retrieve application by id |
ApplicationsConnections
| | Endpoint | Description |
|---|----------|-------------|
| 🟡 PUT | /application-connections/{id}/connect | Connect or Reconnect an application connection. Pass a random nanoId if connecting |
| 🔴 DELETE | /application-connections/{id} | Delete an application connection |
RuleTemplate
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /rule-templates | Gets all rules (no pagination) |
| 🔵 GET | /rule-templates/{id} | Get rule template by id |
| 🟢 POST | /rule-templates/{id}/use | Create a draft rule using rule template |
Config
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /config/account-properties | Get Account Property configurations to configure Account based rules |
| 🔵 GET | /config/event-properties | Get allowed event properties filter to filter each event. |
Rules
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /rules | Gets all rules (no pagination) |
| 🔵 GET | /rules/{id} | Get rule by id |
| 🟡 PUT | /rules/{id} | Upsert a rule by id |
| 🔴 DELETE | /rules/{id} | Delete a rule |
| 🟡 PUT | /rules/{id}/draft | Upsert a draft rule by id |
| 🟢 POST | /rules/{id}/duplicate | Duplicate a rule by id |
| 🟢 POST | /rules/{id}/convert-to-ioc | Convert a rule to IOC by rule ID id |
| 🔵 GET | /rules/{id}/organizations/disconnected | Get disconnected organizations selected in the rule |
RuleTriggers
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /rule-triggers/{id} | Get a rule trigger by id |
| 🔵 GET | /rule-triggers | Get all rule triggers or filter by parameters |
| 🟢 POST | /rule-triggers/{id}/approve | Approve a rule trigger |
| 🟢 POST | /rule-triggers/{id}/reject | Reject a rule trigger |
| 🟢 POST | /rule-triggers/{id}/ignore | Ignore a rule trigger |
| 🟢 POST | /rule-triggers/{id}/manually-remediate | Manually Remediate a rule trigger |
ResponseActions
| | Endpoint | Description |
|---|----------|-------------|
| 🟢 POST | /response-actions/execute | Execute a response action for one or more accounts and create a job |
| 🔵 GET | /response-actions/jobs | retrieve response actions jobs |
| 🔵 GET | /response-actions/jobs/{id} | retrieve response action job by id |
IOCs
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /iocs | Gets all IOC rules (no pagination) |
| 🔵 GET | /iocs/{id} | Get IOC rule by id |
| 🟡 PUT | /iocs/{id} | Upsert a IOC rule by id |
| 🟡 PUT | /iocs/{id}/draft | Upsert a draft IOC rule by id |
| 🟢 POST | /iocs/{id}/duplicate | Duplicate a IOC rule by id |
| 🟢 POST | /iocs/{id}/archive | Archive a IOC rule by id |
| 🟢 POST | /iocs/{id}/unarchive | Unarchive a IOC rule by id |
IOCTriggers
| | Endpoint | Description |
|---|----------|-------------|
| 🔵 GET | /ioc-triggers/{id} | Get a IOC trigger by id |
Compatibility
- n8n version: 1.0+ (tested on 2.x)
- Node.js version: 18+
