Getting Started

Get up and running with Vultra in minutes. Follow this guide to install, configure, and make your first API call.

Prerequisites

API Key

You'll need a Vultra API key to authenticate your requests.

Get your API key

Command Line

Basic familiarity with command line tools and your preferred programming language.

Node.jsPythoncURL

Installation

Install the CLI

npm install -g @vultra/cli

The Vultra CLI provides a command-line interface for scanning and managing your security assessments.

Authenticate

vultra auth login

This will open your browser to authenticate and securely store your API credentials.

Run your first scan

vultra scan ./your-project

Point the scanner at your project directory to start analyzing your code for security vulnerabilities.

Quick Examples

Node.js

const { VultraClient } = require('@vultra/sdk');

const client = new VultraClient({
  apiKey: process.env.VULTRA_API_KEY
});

const scan = await client.scan({
  path: './my-project',
  language: 'javascript'
});

console.log('Vulnerabilities found:', scan.vulnerabilities.length);

Python

from vultra import VultraClient

client = VultraClient(api_key="your-api-key")

scan = client.scan(
    path="./my-project",
    language="python"
)

print(f"Found {len(scan.vulnerabilities)} vulnerabilities")

What's Next?

API Reference

Explore the complete API documentation with detailed examples and parameters.

Examples

See real-world examples and use cases for integrating Vultra into your workflow.

Webhooks

Set up webhooks to receive real-time notifications about security findings.

Need Help?

If you run into any issues, our support team is here to help.

Contact Support Report an Issue