voluum-community-tools

voluum-cli

voluum-cli is community-supported software released under the MIT License. It is not an official Voluum product and is not endorsed or supported by Voluum. It uses publicly documented Voluum APIs.

Lightweight Bun/TypeScript CLI for common Voluum admin and reporting operations.

Install

bun install
bun run build

Optional local link:

bun link

Then use:

voluum --help

Or run directly without linking:

node dist/index.js --help

Commands

Global options (available for all commands):

• --baseUrl <url> override API base URL
• --token <token> override auth token
• --json output as compact JSON (default is TOON — required when piping to jq)
• --pretty output as pretty-printed JSON (implies --json)
• --silent suppress stdout output
• --out <file> write full JSON output to file

Default output format is TOON (Token-Oriented Object Notation), a compact human-readable format that is 30–60% smaller than JSON. Use --json or --pretty for JSON, or --out to save full JSON to a file.

Auth

Login with email/password:

voluum auth login --email [email protected] --password 'secret'

Login with access keys:

voluum auth login --accessKeyId '...' --accessKey '...'

Who am I:

voluum auth whoami

Logout (clears local stored token):

voluum auth logout

Data Input for Create and Update

Create and update commands require a JSON body via one of:

• --data '<json>' — inline JSON string
• --file <path> — path to a JSON file (useful for complex or large payloads)

These flags are mutually exclusive; exactly one is required.

# Inline JSON
voluum offers create --data '{"name":"My Offer","url":"https://example.com/offer"}'

# From file
voluum offers create --file ./offer.json

# Update requires both --id and data
voluum offers update --id <id> --file ./updated-offer.json

Campaigns

List campaigns:

voluum campaigns list

Get campaign by ID:

voluum campaigns get --id <id>

Create campaign:

voluum campaigns create --data '{"name":"My Campaign"}'
voluum campaigns create --file ./campaign.json

Update campaign:

voluum campaigns update --id <id> --data '{"name":"Updated Name"}'
voluum campaigns update --id <id> --file ./campaign.json

Delete campaign:

voluum campaigns delete --id <id>

Offers

List all offers:

voluum offers list

Get offer by ID:

voluum offers get --id <id>

Create offer:

voluum offers create --data '{"name":"My Offer","url":"https://example.com"}'
voluum offers create --file ./offer.json

Update offer:

voluum offers update --id <id> --data '{"name":"Updated Offer"}'
voluum offers update --id <id> --file ./offer.json

Delete offer:

voluum offers delete --id <id>

Landers

List all landers:

voluum landers list

Get lander by ID:

voluum landers get --id <id>

Create lander:

voluum landers create --data '{"name":"My Lander","url":"https://example.com/lp"}'
voluum landers create --file ./lander.json

Update lander:

voluum landers update --id <id> --data '{"name":"Updated Lander"}'
voluum landers update --id <id> --file ./lander.json

Delete lander:

voluum landers delete --id <id>

Flows

List all flows:

voluum flows list

Get flow by ID:

voluum flows get --id <id>

Create flow:

voluum flows create --data '{"name":"My Flow"}'
voluum flows create --file ./flow.json

Update flow:

voluum flows update --id <id> --data '{"name":"Updated Flow"}'
voluum flows update --id <id> --file ./flow.json

Delete flow:

voluum flows delete --id <id>

Traffic Sources

List all traffic sources:

voluum traffic-sources list

Get traffic source by ID:

voluum traffic-sources get --id <id>

Create traffic source:

voluum traffic-sources create --data '{"name":"My Traffic Source"}'
voluum traffic-sources create --file ./traffic-source.json

Update traffic source:

voluum traffic-sources update --id <id> --data '{"name":"Updated Traffic Source"}'
voluum traffic-sources update --id <id> --file ./traffic-source.json

Delete traffic source:

voluum traffic-sources delete --id <id>

Affiliate Networks

List all affiliate networks:

voluum affiliate-networks list

Get affiliate network by ID:

voluum affiliate-networks get --id <id>

Create affiliate network:

voluum affiliate-networks create --data '{"name":"My Network"}'
voluum affiliate-networks create --file ./network.json

Update affiliate network:

voluum affiliate-networks update --id <id> --data '{"name":"Updated Network"}'
voluum affiliate-networks update --id <id> --file ./network.json

Delete affiliate network: