Automation

Automate transfers and fetch information about mounted tapes using Canister's API.

How it works

The Canister API responds to URLs beginning with canister://. These can be triggered from a browser, shell, or script. Deployment calls can be included in your automated workflows.

Example script usage

Mac

From the Terminal:

open "canister://open"

Windows

Add Archive

Archive a source to all mounted tapes:

Mac

canister://addarchive?sources=/Volumes/X9 SSD/Important Footage

Windows

The parameters below are supported:

URL Parameter	Type	Required?
sources	String	Mandatory
destinationtape	String	optional
destinationfolder	String	optional

A Collection of different sources, files, or folders can be combined using the | (pipe) operator.

Mac

canister://addarchive?sources=/Volumes/X9 SSD/Important Footage 1|/Volumes/X9 SSD/Important Footage 2

Windows

Putting it together:

Mac

canister://addarchive?sources=/Volumes/X9 SSD/Important Footage&destinationtape=Archive 01&destinationfolder=260304

Windows

Add Retrieve

Retrieve folders or files from tape:

Mac

canister://retrieve?sources=260304/Important Footage 1&sourcetape=Archive 01&destinationpath=/Volumes/X9 SSD/Retrieved Footage

Windows

The parameters below are supported:

URL Parameter	Type	Required?
sources	string	mandatory
sourcetape	string	mandatory
destinationpath	string	mandatory

Get Tapes

Generate a JSON list of mounted tapes using gettapes.

Mac

On Mac a path and filename must be supplied to the gettapes call.

canister://gettapes?path=/Users/Username/Desktop/gettapes.json

URL Parameter	Type	Required?
path	String	mandatory (inc. filename)

Windows

Sample output:

Mac

[
  {
    "name" : "Archive 01",
    "serial" : "19WT134678",
    "mountPath" : "/Users/LTO Mac/Library/Application Support/Canister/.MountIndexData/146498582",
    "status" : "Mounted",
    "totalCapacityBytes" : 5732142415872,
    "freeBytes" : 3994656406
  }
]

Windows