For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

From the Terminal:

open "canister://open"

Add Archive

Archive a source to all mounted tapes:

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

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.

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

Putting it together:

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

Add Retrieve

Retrieve folders or files from tape:

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.

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

URL Parameter
Type
Required?

path

String

mandatory (inc. filename)

Sample output:

Last updated