Importing and Exporting SecureApp Data

Overview

When you start working with SecureApp or when you need to create a large number of servers, server groups, and connections, you can use the SecureApp API to efficiently create your applications. You can download a Microsoft Excel spreadsheet from your SecureApp server where you can enter the details of your servers, server groups, and connections. Then you can import the spreadsheet into SecureApp to create the specified servers, server groups, and connections.

You can also use the SecureApp REST API to export application data from SecureApp. For more about the SecureApp REST API, see the TOS Developer's Guide (also available for download on the Knowledge Center Home Page).

Import Data into SecureApp with the Application Setup Tool

To import server, server group, and connection data into SecureApp:

Go to this URL to download the Import Application Template:

https://<secureapp_server>/securechangeworkflow/api/secureapp/repository/import_applications/download_template
Enter the server, server group, and connection details in the template.
Go to this URL to upload the Excel file and its contents into SecureApp:

https://<secureapp_server>/securechangeworkflow/api/secureapp/repository/import_applications/upload

Add Your SecureApp Applications Data to Template

The template file includes four sheets: servers, services, connections, application identities.

Servers: In the servers worksheet you can define servers with IP addresses and groups with group members. The columns in the worksheet are:

Column Name	Description	Max Characters
id	Import ID of the server or group. You can enter the ID of a server in the members column of the servers worksheet to add a server to a group. You can enter the ID of a server or group in the source or destination column of the connections worksheet to add a server or group to a connection. Error messages for the import process include the IDs of servers or groups to help you identify the line in the file to change. Note: This is not the same as the object ID used in the REST APIs.	8
name	Name shown in SecureApp for the server or group. Note: If you upload the file and there is an existing server or server group with the same name, it will be replaced by the server or server group defined in this import application file. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256
details	To add a single server, enter an IP address To add an IP range, enter `<start_IP>-<end_IP>` To add a subnet, enter `<IP>/<mask>` To add a group, enter '`group`' and fill in the members field	1024
comment	Comment shown in SecureApp for the server or group. Should not contain: XML or programming language tags such as `<SCRIPT>` HTML attributes, such as `<div attr="...>` Tip: Use the same pattern as in other places for comments.	1024
members	List of server IDs for servers, separated by semicolons, that are members of the group. Can include only 0-9. a-z, and ';'.	4096
application name	Application in which the server or group is created. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256
customer	(Interconnected mode only) Customer to which the application belongs. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256

Services: A list of all of the predefined services in SecureApp.

Column Name	Description	Max Characters
id	Import ID of the service. To add a service or service group to a connection, enter the ID in this column. Error messages for the import process include the IDs of services or groups to help you identify the line in the file to change. Note: This is not the same as the object ID used in the REST APIs.	8
name	Name shown in SecureApp for the service. Note: If you upload the file and there is an existing server or server group with the same name, it will be replaced by the server or server group defined in this import application file. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256
details	To add a single server, enter an IP address To add an IP range, enter `<start_IP>-<end_IP>` To add a subnet, enter `<IP>/<mask>` To add a group, enter '`group`' and fill in the members field Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	1024
comment	Comment shown in SecureApp for the server or group. Should not contain: XML or programming language tags such as `<SCRIPT>` HTML attributes, such as `<div attr="...>` Tip: Use the same pattern as in other places for comments.	1024
members	List of server IDs for servers, separated by semicolons, that are members of the group. Can include only 0-9. a-z, and ';'.	4096
application name	Application in which the server or group is created. To add the new service or service group as local to an application, enter the application name in this column (not relevant for predefined services). Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256

Connections: In the servers worksheet you can define connections between servers or server groups. The columns in the worksheet are:

Column Name	Description	Max Characters
id	Import ID of the connection. Error messages for the import process include the IDs of connections to help you identify the line in the file to change. Note: This is not the same as the connection ID used in the REST APIs. Only numeric values are valid.	16
name	Name shown in SecureApp for the connection. Note: If you upload the file and there is an existing connection with the same name, the details in this import application file are added to the existing connection. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256
comment	Comment shown in SecureApp for the connection. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	1024
application name	Application in which the connection is created. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256
source IDs	List of server or server group IDs that are in the source of the connection.	4096
service / application identity IDs	List of service or application identity IDs that are in the service of the connection.	4096
destination IDs	List of server or server group IDs that are in the destination of the connection.	4096
customer	(Interconnected mode only) Customer to which the application belongs. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256

Application Identities: This worksheet contains a list of all of the predefined application identities in SecureApp.

Column Name	Description	Max Characters
id	Import ID of the application. To add an application identity to a connection, enter the ID in this column. Note: This is not the same as the object ID used in the REST APIs.	8
name	Name of the application that appears in SecureApp. Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	256
details	Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space] Tip: Use the same pattern as for Zone Name in SecureTrack.	1024

Column Name

Description

Max Characters

Import ID of the application.

To add an application identity to a connection, enter the ID in this column.

Note: This is not the same as the object ID used in the REST APIs.

name

Name of the application that appears in SecureApp.

Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space]

Tip: Use the same pattern as for Zone Name in SecureTrack.

256

details

Supports standard characters in all Unicode-supported languages, including digits 0-9, and the following special characters: + - _ # @ . : / = ! ^ ( ) , [space]

Tip: Use the same pattern as for Zone Name in SecureTrack.

1024