vantactl

vantactl

A CLI for interacting with the Vanta REST API. Use it to query compliance data, manage controls, track vulnerabilities, and automate Vanta workflows.

Prerequisites

Verify vantactl is available and authenticated:

vantactl --help
vantactl auth status

Authentication requires a VANTA_API_TOKEN environment variable or a stored token via vantactl auth login --token <token>.

Command pattern

vantactl <resource> <action> [args] [flags]

Global flags

Flag	Description
--output, -o	Output format: json (default), table, ndjson
--fields	Comma-separated field filter (e.g., --fields id,name,status)
--dry-run	Print the HTTP request without executing
--page-size	Items per page (default 100)
--page-all	Fetch all pages, streaming as NDJSON
--json	JSON body for create/update mutations

Resources and actions

Resource	Actions	Description
audits	list, get	View Vanta audits
computers	list, get	View Vanta computers
controls	list, get, create, update, delete, list-tests, list-documents	Manage Vanta controls
documents	list, get, create, delete	Manage Vanta documents
frameworks	list, get, list-controls	View Vanta frameworks
groups	list, get	View Vanta groups
integrations	list, get	View Vanta integrations
people	list, get, update	Manage Vanta people
policies	list, get	View Vanta policies
risk-scenarios	list, get, create, update	Manage Vanta risk scenarios
tests	list, get, list-entities	Manage Vanta tests
vendors	list, get, create, update, delete	Manage Vanta vendors
vulnerabilities	list, get, deactivate, reactivate	Manage Vanta vulnerabilities
vulnerable-assets	list, get	View Vanta vulnerable assets

Common patterns

Discover the API

# List all resources and actions
vantactl schema

# Show detail for a specific resource
vantactl schema controls

# Show action detail including body schema
vantactl schema controls create

List with filters and field masks

vantactl controls list --fields id,name,status
vantactl tests list --status NEEDS_ATTENTION --fields id,name,status
vantactl vulnerabilities list --severity CRITICAL --page-all

Get by ID

vantactl controls get ctl_abc123
vantactl people get per_xyz --fields name,email

Create and update with JSON

vantactl vendors create --json '{"name":"Acme Corp","url":"https://acme.com"}'
vantactl controls update ctl_abc --json '{"description":"Updated"}'

Preview before executing (dry run)

vantactl vendors create --json '{"name":"Acme"}' --dry-run

Stream all pages as NDJSON

vantactl vulnerabilities list --page-all --fields id,name,severity

Table output

vantactl people list -o table --fields name,email

Best practices

1. Use --dry-run before mutations to verify the request looks correct.
2. Use --fields to limit output to only the fields you need.
3. Use vantactl schema to discover available resources and actions rather than guessing.
4. Use --page-all when you need complete datasets; it streams NDJSON to avoid loading everything into memory.

Reference docs

• audits
• computers
• controls
• documents
• frameworks
• groups
• integrations
• people
• policies
• risk-scenarios
• tests
• vendors
• vulnerabilities
• vulnerable-assets