LifeSize Icon 600 - Controlling System via SSH; API Authentication and Command Syntax

LifeSize Icon Video System Guide 34
Section 5: Controlling Your LifeSize Icon Video
System Through SSH
The LifeSize API provides a command line based entry point for automating access and control of LifeSize
Icon video systems. The API supports a REST method for accessing a set of resources, or objects,
through a fixed set of operations. API calls are made by sending a request to an API resource and
specifying a method and arguments. A formatted response details the operation’s outcome.
This section provides an introduction to the LifeSize API. Complete documentation is available at:
https://<videoSystemIPAddress>/docs/json/
Authentication
The same authentication policies that are enforced on a browser also apply to API calls. Log in to your
LifeSize video system through an SSH connection over the network as follows:
1. Open a client, such as Cygwin or Putty, and enter the IP address of your LifeSize video system.
2. Log in to the system with administrator credentials. The default username and password are admin.
Command Syntax
Commands take the following form:
<actor> <command> <parameters>
Access help from a command prompt as follows:
help Shows a brief introduction to using the API.
Press the Tab key. Shows a list of actors.
<actor> ? Shows commands for an actor. For example:
audio ?
<actor> <command> ? Shows help for a command. For example:
sysadmin gettimezone ?