Copyright © 1996-2017 Balabit SA
Copyright © 2017 Balabit SA. All rights reserved. This document is protected by copyright and is distributed under licenses restricting its use, copying, distribution, and decompilation. No part of this document may be reproduced in any form by any means without prior written authorization of Balabit.
This documentation and the product it describes are considered protected by copyright according to the applicable laws.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (https://www.openssl.org/). This product includes cryptographic software written by Eric Young (firstname.lastname@example.org)
This product uses Botan cryptographic library. The library was released under the BSD-2 license. For details about the Botan license, see Botan cryptographic library license.
The Balabit™ name and the Balabit™ logo are registered trademarks of Balabit SA.
The Balabit Shell Control Box™ name and the Balabit Shell Control Box™ logo are registered trademarks of Balabit.
Citrix®, ICA® and XenApp™ are trademarks or registered trademarks of Citrix Systems, Inc.
Linux™ is a registered trademark of Linus Torvalds.
Sun™, Sun Microsystems™, the Sun logo, Sun Fire 4140™, Sun Fire 2100™, Sun Fire 2200™, Sun Fire 4540™, and Sun StorageTek™ are trademarks or registered trademarks of Sun Microsystems, Inc. or its subsidiaries in the U.S. and other countries.
The syslog-ng™ name and the syslog-ng™ logo are registered trademarks of Balabit.
VMware™, VMware ESX™ and VMware View™ are trademarks or registered trademarks of VMware, Inc. and/or its affiliates.
Windows™ 95, 98, ME, 2000, XP, Server 2003, Vista, Server 2008, 7, 8, and Server 2012 are registered trademarks of Microsoft Corporation.
The Zorp™ name and the Zorp™ logo are registered trademarks of BalaSys IT Ltd.
All other product names mentioned herein are the trademarks of their respective owners.
DISCLAIMER. Balabit is not responsible for any third-party websites mentioned in this document. Balabit does not endorse and is not responsible or liable for any content, advertising, products, or other material on or available from such sites or resources. Balabit will not be responsible or liable for any damage or loss caused or alleged to be caused by or in connection with use of or reliance on any such content, goods, or services that are available on or through any such sites or resources.
Botan http://botan.randombit.net/ is distributed under these terms:
1999-2013,2014 Jack Lloyd
2001 Peter J Jones
2004-2007 Justin Karneges
2004 Vaclav Ovsik
2005 Matthew Gregan
2005-2006 Matt Johnston
2006 Luca Piccarreta
2007 Yves Jerschow
2007-2008 FlexSecure GmbH
2007-2008 Technische Universitat Darmstadt
2007-2008 Falko Strenzke
2007-2008 Martin Doering
2007 Manuel Hartl
2007 Christoph Ludwig
2007 Patrick Sona
2010 Olivier de Gaalon
2012 Vojtech Kral
2012-2014 Markus Wanner
2013 Joel Low
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF USE, DATA, OR PROFITS, OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
February 23, 2017
Table of Contents
- 1. Introduction
- 2. Using the SCB REST API
- 2.1. Authenticate to the SCB REST API
- 2.2. Checking the transaction status
- 2.3. Open a transaction
- 2.4. Commit a transaction
- 2.5. Delete a transaction
- 2.6. Reviewing the changelog of a transaction
- 2.7. Application level error codes
- 2.8. Navigating the configuration of SCB
- 2.9. Modifying the configuration of SCB
- 3. Basic settings
- 3.1. Retrieve basic firmware and host information
- 3.2. Network settings
- 3.3. Date and time
- 3.4. Logs, monitoring and alerts
- 4. User management and access control
- 5. Managing SCB
- 6. General connection settings
- 7. HTTP connections
- 8. Citrix ICA connections
- 9. RDP connections
- 10. SSH connections
- 11. Telnet connections
- 12. VNC connections
- 13. Searching and indexing sessions
- 14. Reporting
- 15. Advanced authentication and authorization
- List of SCB REST API parameters and elements
List of Examples