Summary of the content on the page No. 1
ACR1000A-CTL API
™
ServSwitch iPATH Manager API
Application Programming Interface (API) Manual
®
BL A CK BOX
Order toll-free in the U.S.: Call 877-877-BBOX (outside U.S. call 724-746-5500)
Customer
FREE technical support 24 hours a day, 7 days a week: Call 724-746-5500 or fax 724-746-0746
Support
Mailing address: Black Box Corporation, 1000 Park Drive, Lawrence, PA 15055-1018
Information
Web site: www.blackbox.com • E-mail: info@blackbox.com
Summary of the content on the page No. 2
ServSwitch iPATH Manager API Documentation Table of Contents Methods login ...............................................................................................................................................................................3 logout ...............................................................................................................................................................................4 get_devices ............................................
Summary of the content on the page No. 3
ServSwitch iPATH Manager API Documentation API Documentation API version: 2 Changelog v2 (IPATH v2.3) - added get_devices, get_channels, connect_channel, disconnect_channel. Updated version compatibility information. v1 (IPATH v1.3) - added login, logout, get_presets, connect_preset, disconnect_preset Methods login logout get_devices get_channels get_presets connect_channel connect_preset disconnect_channel disconnect_preset login This method was last updated in API version 1, and is compatibl
Summary of the content on the page No. 4
ServSwitch iPATH Manager API Documentation Examples Input: /api/?v=1&method=login&username=xxxxx&password=xxxxx Output: 1 2012-12-14 12:12:12 1 5cf494a71c29e9465a57a81e0a2d602c or 1 2012-12-14 12:12:12 0 2 Invalid username or password
Summary of the content on the page No. 5
ServSwitch iPATH Manager API Documentation or 1 2012-12-12 12:12:12 0 3 Error logging out (you may already have logged out) get_devices This method was last updated in API version 2 and is compatible with API requests from version 2 onwards. This function returns a list of devices. Input parameters: - token - v (the IPATH
Summary of the content on the page No. 6
ServSwitch iPATH Manager API Documentation - d_version (1 = ACR1000A, 2 = ACR1002A) - d_variant ('', 'b' = ACR1002A) - d_ip_address - d_configured (0 = no, 1 = yes) - d_valid_firmware (0 = no, 1 = yes) - d_valid_backup_firmware (0 = no, 1 = yes) - d_firmware (firmware version, e.g. 2.5.17879) - d_backup_firmware (backup firmware version) - d_date_added (Date device added to iPATH network e.g. 2012-07-13 22:17:22) The following property is only returned for transmitters: - count_transm
Summary of the content on the page No. 7
ServSwitch iPATH Manager API Documentation 1 2.3.16682 2.3.16682 2012-07-14 01:37:07 0 1 2012-09-07 13:33:19 admin 1 Channel 1 1
Summary of the content on the page No. 8
ServSwitch iPATH Manager API Documentation get_channels This method was last updated in API version 2 and is compatible with API requests from version 2 onwards. This simple function returns a list of channels available to the authenticated user, for a specific receiver. Input parameters: - token - v (the iPATH API version this request is designed for) - page (page number to start showing results for, default = 1) - results_per_page (number of results per page, default = 1000) - device_id (ID o
Summary of the content on the page No. 9
ServSwitch iPATH Manager API Documentation 2 3 Channel 1 Description for Channel 1 Location of Channel 1 false disabled disabled disabled 5 Channel 2
Summary of the content on the page No. 10
ServSwitch iPATH Manager API Documentation - count_active_cp (the number of channel-receiver pairs in this preset that are already connected) - connected_rx_count (the number of receivers in this preset that are already connected) - view_button (disabled/enabled/hidden - whether the user can connect to the preset in view-only mode. disabled = no, because something is in use by someone else. hidden = never. enabled = yes) - shared_button (disabled/enabled/hidden - as above, but in share
Summary of the content on the page No. 11
ServSwitch iPATH Manager API Documentation connect_channel This method was last updated in API version 2 and is compatible with API requests from version 2 onwards. This simple function connects a receiver to a channel. Input parameters: - token - v (the iPATH API version this request is designed for) - c_id - the ID of the channel (acquired from get_channels) - rx_id - the ID of the receiver (acquired from get_receivers) - view_only (optional, 0/1 - defaults to 0) - exclusive (optional, 0/1 - d
Summary of the content on the page No. 12
ServSwitch iPATH Manager API Documentation connect_preset This method was last updated in API version 1 and is compatible with API requests from version 1 onwards. This simple function connects all channel-receiver pairs in a preset. Input parameters: - token - v (the iPATH API version this request is designed for) - id - the ID of the preset (acquired from get_presets) - view_only (optional, 0/1 - defaults to 0) - exclusive (optional, 0/1 - defaults to 0) - force - whether to ignore errors with
Summary of the content on the page No. 13
ServSwitch iPATH Manager API Documentation disconnect_channel This method was last updated in API version 2 and is compatible with API requests from version 2 onwards. This function disconnects a receiver, a number of receivers, or all connected receivers. Input parameters: - token - v (the iPATH API version this request is designed for) - rx_id (ID(s) of the receiver, as an integer, or comma-separated set of integers. Optional. - force - whether to disconnect existing connections by other user
Summary of the content on the page No. 14
ServSwitch iPATH Manager API Documentation Examples Input: /api/?v=1&method=disconnect_preset&token=xxxxx&id=1&force=1 Output: 1 2012-12-12 12:12:12 1 Page 14 724-746-5500 | blackbox.com 724-746-5500 | blackbox.com
Summary of the content on the page No. 15
NOTES 724-746-5500 | blackbox.com 724-746-5500 | blackbox.com Page 15
Summary of the content on the page No. 16
Black Box Tech Support: FREE! Live. 24/7. Tech support the way it should be. Great tech support is just 30 seconds away at 724-746-5500 or blackbox.com. About Black Box Black Box provides an extensive range of networking and infrastructure products. You’ll find everything from cabinets and racks and power and surge protection products to media converters and Ethernet switches all supported by free, live 24/7 Tech support available in 30 seconds or less. ® © Copyright 2013. Black Box Corpor
