Ask or search…
K
Links

Seam Online CLI

Use the interactive Seam Online CLI as a user-friendly and efficient way to explore and test the Seam API from within the Seam Console.
Use the interactive Seam Online CLI to explore and test the Seam API.
The Seam Online Command Line Interface (CLI) is a fully interactive CLI version of the Seam API. You access the Seam Online CLI from within the Seam Console. Quick, intuitive, and easy to use, the Seam Online CLI enables you to perform a variety of useful tasks, including the following:
  • Explore and test all the available methods in the Seam API interactively.
  • View resources or test API functions easily and quickly.
  • Inspect the results of your API commands.
  • Access Seam API functionality that is not currently available in the Seam Console.

Access the Seam Online CLI

  1. 1.
    In the upper-right corner of the Seam Console, click the down arrow to display the workspace list.
  2. 2.
    Click the workspace for which you want to use the Seam Online CLI.
  3. 3.
    In the left navigation pane, click Online CLI.
The Seam Online CLI opens in a new browser tab or window.
Each instance of the Seam Online CLI begins within the workspace from which you opened the CLI. However, you can use seam select workspace to switch to a different workspace or seam login to use a Personal Access Token for multi-workspace access.

Use the Seam Online CLI

Interact with the Seam Online CLI using any combination of interactive and typed commands. You "construct" the full command, including any desired parameters, and then run the command.
  1. 1.
    Click within the Seam Online CLI pane to activate this pane.
  2. 2.
    Enter a command stub, such as seam, seam devices, or seam devices list. Some commonly-used command stubs include the following:
    • seam
    • seam access-codes
    • seam acs
    • seam action-attempts
    • seam client-sessions
    • seam connect-webviews
    • seam devices
    • seam locks
    • seam login
    • seam noise-sensors
    • seam select
    • seam thermostats
    • seam user-identities
    For a full list of command stubs, see Seam Online CLI Command Stubs.
  3. 3.
    Use the up and down arrows and press Enter to select the desired command and parameters.
    You can also type the beginning of a command or parameter name to filter the list of interactive options.
  4. 4.
    Enter or select any desired parameter values. You can specify values for multiple parameters and edit any parameter values that you have already specified. You can also copy and paste values.
    For example, if you have chosen to use seam devices get, and have selected the device_id parameter, the Seam Online CLI displays a list of the names and IDs of all devices to which you have access. Use the arrow keys to select the desired device and then press Enter.
  5. 5.
    Once you have constructed the full command to run, use the up and down arrows to select Make API Call and then press Enter. The Seam CLI runs the specified command and displays the output.
  6. 6.
    If you have chosen to run a command that returns an action attempt, use the left and right arrows to select yes or no and then press Enter to indicate whether to poll the action attempt until it completes.

Seam Online CLI Command Stubs

The Seam Online CLI supports the following command stubs:
Command Stub
Description
seam
Access all Seam Online CLI commands in an interactive manner.
seam access-codes
Manage access codes.
seam acs
Manage Access Control Systems (ACSs), including associated objects, such as systems, users, access groups, and credentials.
seam action-attempts
List and get action attempts to poll the status of attempted actions, such as unlock and create access code.
seam client-sessions
Manage client sessions that enable you to restrict users' interactions to include only the devices that they own.
seam connect-webviews
Manage Connect Webviews that enable users to connect their devices to Seam.
seam connected-accounts
Manage connected accounts that represent external, third-party accounts to which users have authorized Seam to access.
seam devices
Manage devices, including both "managed" and "unmanaged" devices.
seam events
Retrieve events.
seam locks
Retrieve, lock, and unlock smart locks.
seam login
Log back in to the Seam Online CLI or change your authorization to use a different API key or Personal Access Token.
seam logout
Log out of the Seam Online CLI.
seam noise-sensors
Manage noise thresholds for noise sensors and simulate triggering noise threshold alerts.
seam select
Select the desired workspace or server.
seam thermostats
seam user-identities
Manage user identities that enable you to issue and manage mobile credentials and access permissions for users.
seam webhooks
Manage webhook endpoints that enable you to receive notifications of Seam-related events.
seam workspaces
Manage your workspaces, including creating new workspaces, retrieving existing workspaces, and resetting your sandbox workspaces.

Copying and Pasting in the Seam Online CLI

To copy and paste values in the Seam Online CLI, right-click and select the desired option or use the following keyboard shortcuts:
Operation
Windows/Linux
Mac
Copy
Ctrl-Insert
Command-C
Paste
Shift-Insert or Ctrl-Shift-V
Command-V