Skip to main content

signaloid-cli drives list

List all virtual drives.

Synopsis​

signaloid-cli drives list [options]

Description​

Lists all virtual drives in your Signaloid account. Supports both table and JSON output formats with optional pagination and column customization.

Options​

OptionDescription
--cursor <cursor>Resume a listing from the Cursor value of the previous output
--start-key <key>Deprecated, use --cursor. Takes the ContinuationKey of the previous output.
--count <n>Number of items to fetch, across pages. The output's Cursor resumes after the last one.
--limit <n>Items per request, at most 100 (default 25)
--format <type>Output format: json or table (default: json)
--columns <cols>Comma-separated list of columns or help to see available columns

Output​

Table Format​

DriveID              Name                DataSources    Created
drive-abc123         Production Drive    2 sources      2025-01-15
drive-def456         Test Drive          1 source       2025-01-20

JSON Format​

{
  "Drives": [
    {
      "DriveID": "drive-abc123",
      "Name": "Production Drive",
      "DataSources": [
        {
          "ResourceID": "bkt_1234567890abcdef1234567890abcdef",
          "ResourceType": "Bucket",
          "Location": "data"
        }
      ],
      "CreatedAt": "2025-01-15T10:30:00Z"
    }
  ],
  "Count": 1
}

Examples​

List All Drives​

# JSON format (default)
signaloid-cli drives list

# Table format
signaloid-cli drives list --format table

Column Customization​

# See available columns
signaloid-cli drives list --columns help

# Select specific columns
signaloid-cli drives list --format table --columns DriveID,Name,CreatedAt

Pagination​

To read every drive, pass a --count at least as large as the number of drives. The largest --limit makes the fewest requests:

signaloid-cli drives list --count 10000 --limit 100

To read the drives a page at a time instead:

#!/bin/bash
CURSOR=""
ALL_DRIVES=()

while true; do
  if [ -z "$CURSOR" ]; then
    RESPONSE=$(signaloid-cli drives list --limit 100 --format json)
  else
    RESPONSE=$(signaloid-cli drives list --limit 100 --cursor "$CURSOR" --format json)
  fi

  # Add the page's drives, one JSON object per array element
  mapfile -t -O "${#ALL_DRIVES[@]}" ALL_DRIVES < <(echo "$RESPONSE" | jq -c '.Drives[]')

  # The listing has ended when the output has no Cursor
  CURSOR=$(echo "$RESPONSE" | jq -r '.Cursor // empty')
  [ -z "$CURSOR" ] && break
done

echo "Total drives: ${#ALL_DRIVES[@]}"

Exit Codes​

CodeDescription
0Success
1Failed to list drives (authentication error, API error)

See Also​

Last updated on