The Lifesize API provides a command line based entry point for automating access and control of 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. More detailed documentation is available at:
https://<videoSystemIPAddress>/docs/clish (traditional command line interface)
https://<videoSystemIPAddress>/docs/json (REST API)
The same authentication policies that are enforced on a browser also apply to API calls. Sign in to your Lifesize video system through an SSH or HTTP connection over the network as follows:
- Open a client, such as Cygwin or Putty, and enter the IP address of your Lifesize video system.
- Sign in to the system with administrator credentials. The default username and password are admin.
Commands take the following form:
<actor> <command> <parameters>
Use commas to separate multiple parameters. Show help from a command prompt as follows:
||Shows a brief introduction to using the API.
|Press the Tab key on your keyboard
||Shows a list of actors.
||Shows commands for an actor. For example:
|<actor> <command> ?
||Shows help for a command. For example:
sysadmin gettimezone ?