Description
n8n-nodes-beagle-security
This is an n8n community node that allows you to interact with Beagle Security API for automated vulnerability scanning and security testing.
Beagle Security is a web application and API security testing platform that helps identify vulnerabilities in your applications.
Installation
Follow the installation guide in the n8n community nodes documentation.
Community Nodes (Recommended)
- Go to Settings > Community Nodes in your n8n instance
- Select Install
- Enter
n8n-nodes-beagle-securityas the package name - Click Install
Manual Installation
To get started:
npm install n8n-nodes-beagle-security
Or install it globally:
npm install -g n8n-nodes-beagle-security
Development
Project Structure
src/– TypeScript source codecredentials/– Built credential files (auto-generated)nodes/– Built node files (auto-generated)docker/– Docker configurationsscripts/– Build and deployment scripts
Building
npm run build # Build TypeScript to JavaScript
npm run lint # Check code quality
npm run format # Format code
Credentials
You need to configure your Beagle Security API credentials:
- Go to Settings > Credentials in n8n
- Click Add Credential
- Search for "Beagle Security API"
- Enter your Beagle Security API token
Getting Your API Token
- Log in to your Beagle Security dashboard
- Go to Settings > API Keys
- Generate a new API token
- Copy the token and use it in your n8n credentials
Supported Operations
Projects
- Create – Create a new project
- Get All – Retrieve all projects
- Update – Update an existing project
- Delete – Delete a project
Applications
- Create – Create a new application in a project
- Get – Get application details
- Get All – Get all applications in a project
- Update – Update an existing application
- Delete – Delete an application
- Verify Domain – Verify domain ownership
Tests
- Start – Start a security test on an application
- Stop – Stop a running test
- Get Status – Get the status of a running test
- Get Result – Get test results
- Get Sessions – Get test sessions for an application
- Get Running Tests – Get all currently running tests
Example Usage
Start a Security Test
- Add a Beagle Security node to your workflow
- Set Resource to "Test"
- Set Operation to "Start"
- Configure Application Token (you can get this from your Beagle Security dashboard)
- Execute the workflow
Get Test Results
- Add another Beagle Security node
- Set Resource to "Test"
- Set Operation to "Get Result"
- Use the Application Token and Result Token from the previous step
- Execute to get detailed vulnerability report