GoAnywhere 

API Guide
for GoAnywhere MFT versions 6.5.1 and later
 Copyright Terms and Conditions

The content in this document is protected by the Copyright Laws of the United States of America and other countries worldwide. The
unauthorized use and/or duplication of this material without express and written permission from HelpSystems is strictly prohibited.
Excerpts and links may be used, provided that full and clear credit is given to HelpSystems with appropriate and specific direction to the
original content. HelpSystems and its trademarks are properties of the HelpSystems group of companies. All other marks are property of
their respective owners.
202006110101
Table of Contents
Welcome 10 CLI 29
GoAnywhere Command Web Services Import Admin User 31
Installation Requirements 10
REST 31
GoAnywhere Command Installation
SOAP 31
Requirements 10
CLI 32
Admin User Permissions 10
Promote Admin User 33
REST 11
REST 33
Attaching Files to REST Requests 12
SOAP 33
SOAP 13
CLI 35
Attaching Files to SOAP Requests 13
GoAnywhere Workflow Commands 36
GoAnywhere Command Administration 15
Activate Encrypted Folder 36
Installation 15
REST 36
Upgrade 18
SOAP 37
Uninstall 19
CLI 39
Executing GoAnywhere Command 19
Cancel Job 41
Admin User Permissions 19
REST 41
Windows® 19
SOAP 41
Linux, Unix, AIX, Mac OS X 20
CLI 42
Character Encoding 23
Deactivate Encrypted Folder 42
listCommands 23
REST 42
commandHelp 23
SOAP 43
GoAnywhere Admin User Commands 25
CLI 44
Delete Admin User 26
Delete Cloud Connector 45
REST 26
REST 45
SOAP 26
SOAP 46
CLI 27
CLI 46
Export Admin User 27
Delete Monitor 47
REST 27
REST 47
SOAP 29

GoAnywhere API Guide www.goanywhere.com page: 3

Table of Contents

SOAP 47 Export Monitor 62

CLI 48 REST 62
Delete Project 48 SOAP 63
REST 48 CLI 63
SOAP 49 Export PGP Key 64
CLI 49 REST 64
Delete Resource 50 SOAP 64
REST 50 CLI 65
SOAP 50 Export Project 66
CLI 51 REST 66
Delete Schedule 52 SOAP 67
REST 52 CLI 67
SOAP 53 Export Resource 68
CLI 53 REST 68
Delete Secure Form 53 SOAP 69
REST 54 CLI 70
SOAP 54 Export Schedule 71
CLI 54 REST 71
Delete Trigger 55 SOAP 72
REST 55 CLI 73
SOAP 55 Export Secure Form 73
CLI 56 REST 73
Export Certificate 58 SOAP 74
REST 58 CLI 75
SOAP 58 Export SSH Key 75
CLI 59 REST 75
Export Cloud Connector 60 SOAP 76
REST 60 CLI 77
SOAP 61 Export Trigger 78
CLI 61 REST 78

page: 4 www.goanywhere.com GoAnywhere API Guide

 Table of Contents

SOAP 78 Import Projects From Zip 99

CLI 80 REST 99
Get Job Log 82 SOAP 100
REST 82 CLI 101
SOAP 82 Import Resource 103
CLI 83 REST 103
Get Job Status 84 SOAP 103
REST 84 CLI 104
SOAP 84 Import Schedule 105
CLI 85 REST 105
Import Certificate 86 SOAP 105
REST 86 CLI 106
SOAP 86 Import Secure Form 106
CLI 88 REST 107
Import Cloud Connector 89 SOAP 107
REST 89 CLI 108
SOAP 89 Import SSH Key 109
CLI 91 REST 109
Import Monitor 92 SOAP 110
REST 92 CLI 111
SOAP 92 Import Trigger 112
CLI 93 REST 112
Import PGP Key 93 SOAP 112
REST 94 CLI 113
SOAP 94 Pause Job 115
CLI 96 REST 115
Import Project 97 SOAP 115
REST 97 CLI 116
SOAP 97 Promote Cloud Connector 116
CLI 98 REST 116

GoAnywhere API Guide www.goanywhere.com page: 5

Table of Contents

SOAP 117 Run Project 141

CLI 118 REST 141
Promote Monitor 119 SOAP 142
REST 119 CLI 144
SOAP 119 Run Schedule 145
CLI 120 REST 146
Promote Project 122 SOAP 146
REST 122 CLI 146
SOAP 123 GoAnywhere Web User Commands 148
CLI 124 Add Contact 148
Promote Resource 126 REST 148
REST 126 SOAP 148
SOAP 126 CLI 149
CLI 128 Add SSH Key 150
Promote Schedule 130 REST 150
REST 130 SOAP 151
SOAP 130 CLI 152
CLI 131 Add SSH Key Association 153
Promote Secure Form 132 REST 153
REST 132 SOAP 154
SOAP 133 CLI 155
CLI 134 Add a Virtual File to a Web User 157
Promote Trigger 135 REST 157
REST 135 SOAP 157
SOAP 135 CLI 158
CLI 137 Add Virtual File to a Web User Group 160
Resume Job 140 REST 160
REST 140 SOAP 160
SOAP 140 CLI 161
CLI 141 Add a Virtual Folder to a Web User 163

page: 6 www.goanywhere.com GoAnywhere API Guide

 Table of Contents

REST 163 CLI 186

SOAP 163 Export Web User 186
CLI 165 REST 186
Add a Virtual Folder to a Web User SOAP 188
Group 168
CLI 189
REST 168
Export Web User Group 190
SOAP 168
REST 190
CLI 170
SOAP 191
Add Web User 173
CLI 192
REST 173
Import Web User 193
SOAP 173
REST 193
CLI 175
SOAP 193
Add Web User IP 177
CLI 194
REST 177
Import Web User Group 195
SOAP 178
REST 195
CLI 178
SOAP 195
Add a Web User to a Web User Group 180
CLI 196
REST 180
Promote Web User 198
SOAP 180
REST 198
CLI 181
SOAP 198
Delete Contact 181
CLI 199
REST 182
Promote Web User Group 201
SOAP 182
REST 201
CLI 183
SOAP 201
Delete Web User 184
CLI 202
REST 184
Remove SSH Key From GoAnywhere 204
SOAP 184
REST 204
CLI 185
SOAP 204
Delete Web User Group 185
CLI 205
REST 185
Remove SSH Key Association 207
SOAP 185

GoAnywhere API Guide www.goanywhere.com page: 7

Table of Contents

REST 207 REST 222

SOAP 207 SOAP 222
CLI 208 CLI 223
Remove a Virtual File From a Web User 210 Update Contact 224
REST 210 REST 224
SOAP 210 SOAP 225
CLI 211 CLI 226
Remove a Virtual File from a Web User Update Virtual File for a Web User 228
Group 212
REST 228
REST 212
SOAP 228
SOAP 212
CLI 229
CLI 213
Update Virtual File for a Web User
Remove a Virtual Folder from a Web Group 231
User 214
REST 231
REST 214
SOAP 231
SOAP 214
CLI 232
CLI 215
Update a Virtual Folder for a Web User 234
Remove a Virtual Folder from a Web
REST 234
Group 216
SOAP 234
REST 216
CLI 236
SOAP 216
Update Virtual Folder for a Web User
CLI 217
Group 238
Remove a Web User From a Web User
REST 238
Group 218
SOAP 238
REST 218
CLI 240
SOAP 218
Update Web User 242
CLI 219
REST 242
Remove Web User IP 219
SOAP 242
REST 219
CLI 252
SOAP 220
Dashboard Gadget Commands 263
CLI 220
Active Jobs 263
Reset Web User Password 222

page: 8 www.goanywhere.com GoAnywhere API Guide

 Table of Contents

Active Sessions - Detail 263

Active Sessions - Summary 264
Cluster Information 265
Completed Jobs - Summary 266
Expiring OpenPGP Keys 267
Expiring SSL Certificates 268
File Transfer - Summary 269
Gateway Information 271
Job Statistics 272
Recent Blacklisted IP Addresses - Detail 273
Recent Completed Jobs 274
Recent File Activity 275
Recent Secure Mail Activity 277
Recent Triggers 277
Recent Web User Activity 278
Recent Web User Logins 280
Service Statistics - Inbound Connections 281
Service Status 283
System Information 284
System Status 284
Top GoDrive Users by Disk Usage 285
Top Secure Mail Packages by Size 286
Top Secure Mail Users by Disk Usage 287
Top Web Users by Transfers 288
Unresolved Jobs 290

GoAnywhere API Guide www.goanywhere.com page: 9

Welcome
GoAnywhere Command allows users to perform an array of functions on a local or remote
GoAnywhere system. The GoAnywhere Command performs an HTTP(S) request to the specified
GoAnywhere server and executes the specified command. With GoAnywhere Command, it is
possible to execute GoAnywhere functions from custom programs, scripts and scheduler software.
GoAnywhere API Guide allows users to perform SOAP and REST requests to a local or remote
GoAnywhere system. With GoAnywhere API Guide, it is possible to execute GoAnywhere
functions from custom programs.

GoAnywhere Command Web Services

Installation Requirements
Web Services are supported in GoAnywhere MFT version 5.4.0 and later. Dashboard Gadget
Commands are supported in GoAnywhere MFT 5.5.0 and Later.

GoAnywhere Command Installation

Requirements
l Java Runtime Environment 1.6 (JRE) or higher needs to be installed on your local computer.
l An Admin User account on the GoAnywhere system.
l The GoAnywhere system must be running version 5.0.0 or later.
l
NOTE:
The Java Runtime Environment is also referred to as the Java Virtual Machine or simply
Java. Download Java from http://www.java.com.

Admin User Permissions

Each GoAnywhere Command action requires you to specify an Admin User account to authenticate
to a GoAnywhere server. The Admin User account must have permissions to execute the command
on the target server. For more information, see the Admin User Roles section of the GoAnywhere
MFT User Guide.

GoAnywhere API Guide www.goanywhere.com page: 10

REST
The GoAnywhere Command client supports REST requests to execute Workflow and Web User
actions on a GoAnywhere Server. The REST Body must be formatted as JSON.
HTTP Authentication for REST Requests

GoAnywhere Command Web Services use BASIC authentication with the User ID and Password of
an Admin User in GoAnywhere.
REST URI

The base URI to send HTTP REST Requests to a your GoAnywhere Server is http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/. The [Server URL] and [port] place holders used throughout
this guide must be replaced with the URL and port numbers of your GoAnywhere installation.
The command name or parameter for each action is listed in the commands sections in the
subsequent chapters of this guide.

EXAMPLE:
POST  http://10.1.2.1:8000/goanywhere/rest/gacmd/v1/jobs/123456789012/cancel is the
REST request used to cancel a job.

REST URI White Space Replacement

Some items in your GoAnywhere installation, such as Triggers, Web Groups, or Resources, may
have names that contain spaces. When using this name in a REST URI, the spaces must be encoded
using '+' or '%20'. For example, an SFTP Resource is named "Trading Partner SFTP" in
GoAnywhere. To export this Resource using a REST request, the spaces must be encoded in the
URI:

EXAMPLE:
Using '%20': POST
http://10.1.2.1:8000/goanywhere/rest/gacmd/v1/resources/sftp/Trading%20Partner%20SF
TP

EXAMPLE:
Using '+': POST
http://10.1.2.1:8000/goanywhere/rest/gacmd/v1/resources/sftp/Trading+Partner+SFTP

JSON Content Type and Escape Characters

When making any REST requests to a GoAnywhere server, the content type must be
'application/json'. Specific special characters within the JSON fields must be escaped. The following
table contains a list of escape characters and examples of how they are used:

Escape Definition & Example

Character

GoAnywhere API Guide www.goanywhere.com page: 11

REST / Attaching Files to REST Requests

\b Backspace (ascii code 08). Example: "description": "\bThis is a

description."
\f Form feed (ascii code 0C). Example: "description": "\fThis is a
description."
\n New line. Example: "description": "This is a new line. \n"
\r Carriage return. Example: "description": "This is a carriage return.\r"
\t Tab Example: "description": "These\tare\ttabs."
\" Double quote. Example: "description": "\"Use GoAnywhere,\" they
said."
\\ Backslash character. Example: "physicalPath": "C:\\webdocs\\home_
folders\\"

Attaching Files to REST Requests

Files must be Base64 encoded and the Base64 encoded text inserted into the correct fields within
the JSON body of a POST or PUT request.
In the importProject command example below, the "file" parameter contains a Base64 encoded
file.

{
    "importParameters" :
{
        "file":"Z29hbnl3aGVyZQ==",
        "domain":"Chicago Campus",
        "ignoreCompileErrors":"true",
        "replaceProject":"true",
        "createTargetFolder":"false",
        "targetFolder" : "/Incoming"
    }
}

page: 12 www.goanywhere.com GoAnywhere API Guide

SOAP
The GoAnywhere Command client supports SOAP requests to execute Workflow and Web User
actions on a GoAnywhere Server.
SOAP Method

All SOAP requests are POSTs.

SOAP URL

The URL to make a SOAP request on the GoAnywhere server is: http://[server URL]:
[port]/goanywhere/soap/gacmd/v1/GoAnywhereCommand. The [server URL] and [port] place
holders used throughout this guide must be replaced with the URL and port numbers of your
GoAnywhere installation.
SOAP WSDL

The SOAP WSDL can be found using the following URL on your server: http://[server URL]:
[port]/goanywhere/soap/gacmd/v1/GoAnywhereCommand?wsdl.
SOAP Authentication

GoAnywhere Command Web Services use BASIC authentication with User and Password of an
Admin User in GoAnywhere.
SOAP Envelope

Each SOAP request contains a unique XML formatted body. Examples of the SOAP Envelope are
contained in each command example found in the later sections of this guide.

Attaching Files to SOAP Requests

Non-MTOM Request

For a non-MTOM enabled request, the input file can be a Base64 encoded string and supplied in
the <inputFile> field.
Example:

<inputFile>Z29hbnl3aGVyZQ==</inputFilefile>

GoAnywhere API Guide www.goanywhere.com page: 13

SOAP / Attaching Files to SOAP Requests

MTOM Request

For an MTOM enabled request, specify a CID using the <inc> XML name space which points to
another MIME part on the same request that contains the file.
Example:

<inputFile>
  <inc:Include xmlns:inc="http://www.w3.org/2004/08/xop/include"    href="cid:123456"/>
</inputFilefile>

If your application automatically replaces Content ID references with the <inc> XML name space,
then only the CID is required.
Example:

<inputFile>cid:123456</inputFilefile>

page: 14 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Command Administration / Installation

GoAnywhere Command
Administration
The Administration section outlines the installation and maintenance of the GoAnywhere Command
application.

Installation
GoAnywhere Command can be installed on any computer running Microsoft® Windows®, Linux,
UNIX, AIX®, and Mac OS X. Download the appropriate installation file from the GoAnywhere
Customer Portal at https://my.goanywhere.com.
Follow the instructions below to install the GoAnywhere Command application:

Windows Installation
Step 1 - Launch the Installation Package
Locate and double-click the installation file on your computer (the default file name is
"gacmdwindows.exe"). If a Security Warning opens, click the Run button to confirm you wish to
install the GoAnywhere Command application.

GoAnywhere API Guide www.goanywhere.com page: 15

GoAnywhere Command Administration / Installation

Step 2 - Destination Directory

Confirm the installation directory for the GoAnywhere Command application. Click the Next
button to install.

page: 16 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Command Administration / Installation

Silent Install - Windows

The installation of GoAnywhere Command can be automated by using a silent install option. Silent
install uses the Windows command line to execute the installation.
To perform a silent install of GoAnywhere Command on Windows:

1. Log into the target Windows system as an administrator.

2. Open the command prompt and use the cd command to navigate to the directory containing
the GoAnywhere Command installer.
3. Execute the downloaded installer file using the following command:

[installer file name].exe -q

For parameters for silent install on Windows, see the Silent Install Parameters on the next page.

Linux, Unix, AIX, Mac OS X Installation

The installation for Linux, Unix, AIX, and Mac OS X is essentially the same. If a desktop interface is
installed on the system, the installer screens from the Windows installer will open, otherwise the
installation is text based.

1. Download or copy the GoAnywhere Command installation file to a location on the target
computer.
2. From a command prompt, navigate to the folder where the file was placed.
3. Type chmod 777 gacmdunix.sh and then press Enter.
4. Type ./gacmdunix.sh and then press Enter.
5. Respond to the screen prompts to finish installing the oAnywhere Command application.

Silent Install - Linux, Unix, AIX, Mac OS X

The installation of GoAnywhere Command can be automated by using a silent install option.
To perform a silent install of GoAnywhere Command on Linux, Unix, AIX, or Mac OS X systems:

1. Copy the GoAnywhere Command UNIX installer file to the UNIX server.
2. Execute the downloaded installer file using the following command:

[installer_filename].sh -q

For parameters for silent install on Linux, Unix, AIX, or Mac OS X, see the Silent Install Parameters
on the next page.

GoAnywhere API Guide www.goanywhere.com page: 17

GoAnywhere Command Administration / Upgrade

Silent Install Parameters

The following table contains the required and optional parameters for a silent install on Windows,
Unix, and Linux:

Parameter Name Description

-q Displays no user interface.
-dir The directory path where GoAnywhere
Command will be installed.

Upgrade
The installer used to install GoAnywhere Command is also used to upgrade GoAnywhere
Command. The install file recognizes any existing installations and offers to either upgrade in the
same folder or install it in a different location.

page: 18 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Command Administration / Uninstall

Uninstall
Windows
The GoAnywhere Command uninstalls using the Programs and Features option in the Windows
Control Panel. Follow the instructions below to uninstall the GoAnywhere Command:

1. From the Start menu, open the Control Panel.

2. In the Control Panel, either click the Uninstall a program link in the Programs section or
click the Programs and Features icon.
3. From the list of available programs, click to select the GACmd 1.6.1 and then from the sub-
menu bar click Uninstall.
4. The GoAnywhere Command application is removed. To completely remove any remaining
GoAnywhere Command log files, manually delete the C:\[InstallFolder]\GoAnywhere
Command folder (where [InstallFolder] is the installation location where GoAnywhere
Command was installed).

Linux, Unix, AIX, Mac OS X

Delete the GoAnywhere Command folder from your file system. (for example,
/usr/local/HelpSystems/GoAnywhere_Command).

Executing GoAnywhere Command

GoAnywhere functions residing on the local or a remote server can be executed by calling the
GoAnywhere Command (gacmd). All parameter names are case-insensitive. Values containing
spaces must be enclosed in "double-quotes."

Admin User Permissions

Each GoAnywhere Command action requires you to specify an Admin User account using the -user
parameter to authenticate to a GoAnywhere server. The Admin User account must have
permissions to execute the command on the target server. For more information, see the Admin
User Roles section of the GoAnywhere MFT User Guide.

Windows®
The default installation directory on Windows is C:\Program Files\HelpSystems\GoAnywhere
Command. In a Command or DOS window, navigate to the install folder and type:
gacmd.exe [-parameter] <value> [-command] <value>

GoAnywhere API Guide www.goanywhere.com page: 19

GoAnywhere Command Administration / Executing GoAnywhere Command

Linux, Unix, AIX, Mac OS X

Navigate to the install folder and type:
sh gacmd [-parameter] <value> [-command] <value>

The GACmd command accepts the following parameters:

Parameter Description Requi Default Value

Name red?
server The URL of the GoAnywhere server. Yes None
When running in a cluster environment,
separate multiple server URL's with a
comma, without spaces between the
comma and server addresses. For
example:

l http://10.1.4.1:8000/goanywhere
l https://10.1.4.1:8001/goanywhere
l http://10.1.4.1:8000/goanywhere,
http://10.1.4.2:8000/goanywhere
user The User name for logging in to Yes None
GoAnywhere.
password The password for the User account. Yes* None
passwordPrompt You will be prompted to specify the Yes* None
password when the command is
executed.
passwordVariabl The password is stored in an Yes* None
e environment/user variable in the
system. Specify the variable name as the
parameter, which is case sensitive.
passwordFile The password is stored in a file. Specify Yes* None
the full path to the file.
passwordIsEncry Specifies that a password is encrypted. No None
pted Valid options are true or false.

page: 20 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Command Administration / Executing GoAnywhere Command

Parameter Description Requi Default Value

Name red?

NOTE:
To encrypt a password, you can use the password encryption tool from the
GoAnywhere server by logging in to GoAnywhere and then specify the following page
in your browser:
http://[server name]:[port]/goanywhere/admin/debug/AESEncrypt.xhtml

listCommands Lists the commands supported by the No None

server.
command The name of the command sent to the No None
GoAnywhere server.
commandHelp Prints all supported parameters for the No None
selected command to the console along
with parameter descriptions.
version Prints the installed version of the No None
GoAnywhere Command application on
the local computer.
serverCertificate The path to the key store containing the No default
Store trusted certificates. This file is used for
authenticating the server during the SSL
handshake.
serverCertificate The password for the server certificate No None
StorePassword key store.
serverCertificate The type of the server certificate key No JKS
StoreType store. Valid options are JKS and
PKCS12.
clientCertificateS The path to the key store containing the No default
tore private keys and associated certificates.
This key store is required if the target
GoAnywhere server requires client
authentication using digital certificates.
clientCertificateS The password for the client certificate No None
torePassword key store.
clientCertificateS The type of the client certificate key No JKS
toreType store. Valid options are JKS and
PKCS12.

GoAnywhere API Guide www.goanywhere.com page: 21

GoAnywhere Command Administration / Executing GoAnywhere Command

Parameter Description Requi Default Value

Name red?
verifyHostName When connecting over SSL, whether or No true
not to verify the host name with the
host name listed on the digital
certificate sent by the server. Valid
options are true or false.
trustAll Whether or not to authenticate the No None
server. When this is set to true, all
servers are considered as trusted, in
other words, the server authentication
will be skipped during the SSL
handshake. Valid options are true or
false.
proxyHost The proxy host URL. No None
proxyPort The port used by the proxy. No None
proxyUser The user name used to log in to the No None
proxy server.
proxyPassword The password for the proxy user. No None
connectionTime The number of seconds before a No 60
out connection times out.
readTimeout The socket timeout in seconds. If no No 300
data is transferred in this timeframe, the
socket times out.
logFile The file location for the GoAnywhere No [installfolder/goan
Command log file. ywhereclient.log]
responseOutput The file location and file name in which No None
File to save the response returned from
GoAnywhere. The format of the
response is XML.
jvmconfig Prints all of the system properties to the No None
console, this is used for debug purposes
only.

* Only one of the four password parameters should be specified.

page: 22 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Command Administration / listCommands

Character Encoding
Special characters in parameter values need to be encoded. The following table contains a list of
invalid characters, the replacement encoded value, and an example.

Invalid Replacement Encoding Example

Character
< (less than) &lt; "2T6M!&lt;" will resolve as "2T6M!<"
> (greater than) &gt; "2T6M!&gt;" will resolve as "2T6M!>"
" (double quote) &quot; "This is a &quote;Provisional&quote;
account" will resolve as "This is
a"Provisional" account"
' (apostrophe) &apos; "Kathy&apos;s account is valid." will
resolve as "Kathy's account is valid."
& (ampersand) &amp; "User 1 &amp; User 2" will resolve as
"User 1 & User 2"

listCommands
Display a list of possible commands using listCommands.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-listCommands

commandHelp
For help with using a command, you can display the command description and command parameters
using commandHelp.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-commandHelp cancelJob

GoAnywhere API Guide www.goanywhere.com page: 23

GoAnywhere Command Administration / commandHelp

Parameter Name Description Required? Default

Value
Command name The name of the command. Yes None
Example: -commandHelp cancelJob

page: 24 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Admin User Commands / commandHelp

GoAnywhere Admin User

Commands
The following are the commands available for GoAnywhere Admin Users:

GoAnywhere API Guide www.goanywhere.com page: 25

GoAnywhere Admin User Commands / Delete Admin User

Delete Admin User

Delete an Admin User from GoAnywhere using the deleteAdminUser command.

NOTE:
You cannot delete the system root or administrator user accounts.

REST
Method & URL
DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/adminusers/
[userName]

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:deleteAdminUser>
            <userName>jsmith</userName>
        </web:deleteAdminUser>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteAdminUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Admin user 'jsmith' was deleted successfully</result>
</ns2:deleteAdminUserResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when deleting an Admin User.

Parameter Name Description Required? Default Value

userName The Admin User account name. Yes None

page: 26 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Admin User Commands / Export Admin User

CLI
The following table lists the available options when deleting an Admin User in GoAnywhere
Command using the deleteAdminUser command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteAdminUser -userName kharris

Parameter Name Description Required? Default Value

userName The Admin User account name. Yes None

NOTE:
You cannot delete the system default root or administrator user accounts.

Export Admin User

Export an Admin User to an XML file using the exportAdminUser command.

NOTE:
You cannot export the system root or administrator user accounts.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/adminusers/
[userName]

Response Body Sample

<?xml version="1.0" encoding="UTF-8" ?>

<users class="com.linoma.dpa.commandcenter.codec.AdminUserNameListCodec">
   <user>
    <modifiedOn>1548110364441</modifiedOn>
    <twoFactorAuthType></twoFactorAuthType>
    <passwordHashAlgorithm>7</passwordHashAlgorithm>
    <passwordIsEncrypted>true</passwordIsEncrypted>
    <filePermissions>3</filePermissions>
    <password>$5$3pvLY59cd6nulwt0=</password>
    <restrictToHomeDirectory>true</restrictToHomeDirectory>
    <createdBy>root</createdBy>
    <lastLoginDate>1548110345327</lastLoginDate>
    <modifiedBy>root</modifiedBy>
    <loginMethod>101</loginMethod>

GoAnywhere API Guide www.goanywhere.com page: 27

GoAnywhere Admin User Commands / Export Admin User

    <createdOn>1425500848000</createdOn>
    <name>kharris</name>
    <email>kharris@example.com</email>
    <homeDirectory>*DOCROOT/*USER</homeDirectory>
    <enabled>true</enabled>
    <loginMethodName>GoAnywhere</loginMethodName>
    <roles>
        <role>
        <name>Agent Manager</name>
        </role>
        <role>
        <name>Auditor</name>
        </role>
        <role>
        <name>Dashboard Manager</name>
        </role>
        <role>
        <name>File Manager</name>
        </role>
        <role>
        <name>Job Manager</name>
        </role>
        <role>
        <name>Key Manager</name>
        </role>
        <role>
        <name>Product Administrator</name>
        </role>
        <role>
        <name>Project Designer</name>
        </role>
        <role>
        <name>Project Executor</name>
        </role>
        <role>
        <name>Resource Manager</name>
        </role>
        <role>
        <name>Secure Forms Manager</name>
        </role>
        <role>
        <name>Secure Mail Manager</name>
        </role>
        <role>
        <name>Security Officer</name>
        </role>
        <role>
        <name>Trigger Manager</name>
        </role>
        <role>
        <name>Web User Device Manager</name>
        </role>
        <role>
        <name>Web User Manager</name>
        </role>
    </roles>
    <groups>
        <group>
        <name>All Admin Users</name>
        </group>
    </groups>

page: 28 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Admin User Commands / Export Admin User

    <domains>
        <domain>
        <name>Default</name>
        </domain>
    </domains>
     </user>
</users>

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:exportAdminUser>
            <userName>kharris</userName>
        </web:exportAdminUser>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportAdminUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWwgdmVyc...wvd2ViVXNlcnM+</outputFile>
</ns2:exportAdminUserResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when running exporting an Admin User.

Parameter Description Required? Default

Name Value
userName The user name of the Admin User to Yes None
export.

CLI
The following table lists the available options when exporting an Admin User in GoAnywhere
Command using the exportAdminUser command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportAdminUser -userName "kharris" -userOutputFile

GoAnywhere API Guide www.goanywhere.com page: 29

GoAnywhere Admin User Commands / Export Admin User

"C:\adminUsers\kharris.xml"

Parameter Description Required? Default

Name Value
userName The user name of the Admin User to export. Yes None
userOutputFile The location where the Admin User XML Yes None
will be saved.

NOTE:
You cannot export the system default root or administrator user accounts.

page: 30 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Admin User Commands / Import Admin User

Import Admin User

Import an Admin User from an XML file. Prior to importing the Admin User from a file, you must
export the Admin User from the source GoAnywhere server.

NOTE:
You cannot import the system root or administrator user accounts.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/adminusers

Body Sample:

{
    "importParameters" :
{
        "file":"Z29hbnl3aGVyZQ=="
    }
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:importAdminUser>
        <inputFile>Z29hbnl3aGVyZQ==</inputFile>
    </web:importAdminUser>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importAdminUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Admin user 'KHarris' was added successfully.</result>
</ns2:importAdminUserResponse>

GoAnywhere API Guide www.goanywhere.com page: 31

GoAnywhere Admin User Commands / Import Admin User

</S:Body>
</S:Envelope>

The following table lists the available options when importing an Admin User.

Parameter Description Required? Default

Name Value
file (REST) Base64 encoded content of the file. Yes None
inputFile To attach a file to SOAP request, view the Attaching Yes None
(SOAP) Files to SOAP Requests topic for more information.

CLI
Import an Admin User from an XML file in GoAnywhere Command using the importAdminUser
command. Prior to importing the Admin User from a file, you must export the Admin User from the
source GoAnywhere server.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importAdminUser -file "C:\temp\AdminUsers.xml"

Parameter Description Required? Default

Name Value
file The absolute path to the location of the Yes None
Admin User XML file.

NOTE:
You cannot import the system default root or administrator user accounts.

page: 32 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Admin User Commands / Promote Admin User

Promote Admin User

Promote an Admin User from one GoAnywhere server to another GoAnywhere server.

NOTE:
You cannot promote the system root or administrator user accounts.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/adminusers/
[userName]/promote

Body Sample:

{
  "targetServer" : "http://10.1.5.1:9000/goanywhere",
  "targetUser" : "root",
  "targetPassword" : "goanywhere"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:promoteAdminUser>
      <targetServer>http//:10.1.5.1:9000/
      goanywhere</targetServer>
      <targetUser>root</targetUser>
         <targetpassword>goanywhere</targetpassword>
      <userName>kharris</userName>
    </web:promoteAdminUser>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

GoAnywhere API Guide www.goanywhere.com page: 33

GoAnywhere Admin User Commands / Promote Admin User

<S:Body>
<ns2:promoteAdminUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Admin user 'kharris' was promoted successfully</result>
</ns2:promoteAdminUserResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting an Admin User.

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
userName The user name of the Admin User to promote. Yes None

page: 34 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Admin User Commands / Promote Admin User

CLI
The following table lists the available options when promoting an Admin User in GoAnywhere
Command using the promoteAdminUser command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteAdminUser -targetServer http://10.1.5.2:8000/goanywhere
-targetUser root -targetPassword goanywhere -userName "kharris"

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
userName The user name of the Admin User to promote. Yes None

NOTE:
You cannot promote the system default root or administrator user accounts.

GoAnywhere API Guide www.goanywhere.com page: 35

GoAnywhere Workflow
Commands
The following are the commands available for GoAnywhere Project Workflows:

Activate Encrypted Folder

Activate an Encrypted Folder using the activateEncryptedFolder command.

REST
Method & URL
POST http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/encryptedfolders

Body Sample

{
    "activateParameters" :
{
        "folderPath" : "/mftsystem/encrypted",
        "createFolder" : "true",
        "createBackup" : "true",
        "backupFolderPath" : "/mftsystem/backups"
    }
}

Response Body Sample

{
    "data" :
[
{
           "encryptionKey" : "jlVoGGIeA0yYZYJ7SMLa9...",
           "seedUUID" : "abb1b909-04b3-3a01-a578-65be3cb3609b"
        }
    ]
}

GoAnywhere API Guide www.goanywhere.com page: 36

GoAnywhere Workflow Commands / Activate Encrypted Folder

SOAP
Envelope Sample

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:activateEncryptedFolder>
        <folderPath>/mftsystem/encrypted</folderPath>
        <createFolder>true</createFolder>
        <createBackup>true</createBackup>
         <backupFolderPath>/mftsystem/backups</backupFolderPath>
      </web:activateEncryptedFolder>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:activateEncryptedFolderResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Folder encryption successfully activated.</result>
</ns2:activateEncryptedFolderResponse>
</S:Body>
</S:Envelope>

page: 37 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Activate Encrypted Folder

The following table lists the available options when activating an encrypted folder.

Parameter Name Description Required? Default

Value
folderPath The location of the folder on the Yes None
GoAnywhere system to use as an
Encrypted Folder.
createFolder Indicate whether GoAnywhere should No False
create this folder if it does not exist.
keyGeneration Indicate the encryption key to use on this No Random
Encrypted Folder:

l Random - GoAnywhere will create

a new encryption key for this
folder.
l Manual - The encryption key and
seed UUID will be provided. This is
useful when migrating an
Encrypted Folder between
GoAnywhere systems.
encryptionKey The encryption key to use when No None
specifying the key manually.
seedUUID The seed UUID to use when specifying No None
the key manually.
encryptContents Indicate whether or not to encrypt the No False
contents of this folder. If
encryptContents is false, GoAnywhere
will assume the contents are already
encrypted. This is only used when
specifying the key manually.
createBackup If the folderPath location already No True
contains files, it is recommended to take
a backup of those files prior to
GoAnywhere encrypting them.
backupFolderPath The location on the GoAnywhere system No None
to store the backup. If createBackup is
true, this path is required.

GoAnywhere API Guide www.goanywhere.com page: 38

GoAnywhere Workflow Commands / Activate Encrypted Folder

Parameter Name Description Required? Default

Value
backupCompression Indicate whether the backup should be No Zip
compressed:

l None - Do not perform

compression on the backup file.
l Zip - Compress the backup file
using Zip.

CLI
The following table lists the available options when activating an encrypted folder in GoAnywhere
Command using the activateEncryptedFolder command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command activateEncryptedFolder -folderPath "C:\users\kharris\encrypted" -createFolder
true -createBackup true -backupFolderPath C:\users\kharris\backups

Parameter Name Description Required? Default

Value
folderPath The location of the folder on the Yes None
GoAnywhere system to use as an
Encrypted Folder.
createFolder Indicate whether GoAnywhere should No False
create this folder if it does not exist.
keyGeneration Indicate the encryption key to use on No Random
this Encrypted Folder:

l Random - GoAnywhere will create

a new encryption key for this
folder.
l Manual - The encryption key and
seed UUID will be provided. This is
useful when migrating an
Encrypted Folder between
GoAnywhere systems.

page: 39 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Activate Encrypted Folder

Parameter Name Description Required? Default

Value
encryptionKey The encryption key to use when No None
specifying the key manually.
seedUUID The seed UUID to use when specifying No None
the key manually.
encryptContents Indicate whether or not to encrypt the No False
contents of this folder. If
encryptContents is false, GoAnywhere
will assume the contents are already
encrypted. This is only used when
specifying the key manually.
createBackup If the folderPath location already No True
contains files, it is recommended to take
a backup of those files prior to
GoAnywhere encrypting them.
backupFolderPath The location on the GoAnywhere system No None
to store the backup. If createBackup is
true, this path is required.
backupCompression Indicate whether the backup should be No Zip
compressed:

l None - Do not perform

compression on the backup file.
l Zip - Compress the backup file
using Zip.

GoAnywhere API Guide www.goanywhere.com page: 40

GoAnywhere Workflow Commands / Cancel Job

Cancel Job
Cancel a job using the cancelJob command. The job will be canceled and logged in the job log.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/jobs/
[jobId]/cancel

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
     <soapenv:Header/>
     <soapenv:Body>
         <web:cancelJob>
              <jobId>1347033630762</jobId>
         </web:cancelJob>
     </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:cancelJobResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Cancel request submitted for job 1000000000534</result>
</ns2:cancelJobResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when canceling a job.

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to each Yes None
project at runtime. The jobId's are sequential and
reflect the order in which jobs are started.

page: 41 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Deactivate Encrypted Folder

CLI
The following table lists the available options when canceling a job in GoAnywhere Command using
the cancelJob command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command cancelJob -jobId 1347033630762

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to each Yes None
project at runtime. The jobId's are sequential and
reflect the order in which jobs are started.

Deactivate Encrypted Folder

Deactivate an Encrypted Folder using the deactivateEncryptedFolder command.

REST
Method & URL
POST http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/encryptedfolders

Body Sample

{
    "deactivateParameters" :
{
      "folderPath" : "/mftsystem/encrypted",
      "createBackup" : "true",
      "backupFolderPath" : "/mftsystem/backups"
    }
}

Response Body Sample

If successful, the response body is empty.

GoAnywhere API Guide www.goanywhere.com page: 42

GoAnywhere Workflow Commands / Deactivate Encrypted Folder

SOAP
Envelope Sample

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:deactivateEncryptedFolder>
        <folderPath>/mftsystem/encrypted</folderPath>
       <backupFolderPath>/mftsystem/backup</backupFolderPath>
      </web:deactivateEncryptedFolder>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:activateEncryptedFolderResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Folder encryption successfully deactivated.</result>
</ns2:activateEncryptedFolderResponse>
</S:Body>
</S:Envelope>

page: 43 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Deactivate Encrypted Folder

The following table lists the available options when deactivating an encrypted folder.

Parameter Name Description Required? Default

Value
folderPath The folder path of the Encrypted Folder. Yes None
decryptContents Indicate whether or not to decrypt the No True
contents of this folder. If
decryptContents is false, GoAnywhere
will assume the contents are already
decrypted.
createBackup If the folderPath location already No True
contains files, it is recommended to take
a backup of those files prior to
GoAnywhere decrypting them.
backupFolderPath The location on the GoAnywhere system No None
to store the backup. If createBackup is
true, this path is required.
backupCompression Indicate whether the backup should be No Zip
compressed:

l None - Do not perform

compression on the backup file.
l Zip - Compress the backup file
using Zip.

CLI
The following table lists the available options when deactivating an encrypted folder in
GoAnywhere Command using the deactivateEncryptedFolder command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deactivateEncryptedFolder -folderPath "C:\users\kharris\encrypted"
-decryptContents true -createbackup true -backupFolderPath C:\users\kharris\backups

Parameter Name Description Required? Default

Value
folderPath The folder path of the Encrypted Folder. Yes None

GoAnywhere API Guide www.goanywhere.com page: 44

GoAnywhere Workflow Commands / Delete Cloud Connector

Parameter Name Description Required? Default

Value
decryptContents Indicate whether or not to decrypt the No True
contents of this folder. If
decryptContents is false, GoAnywhere
will assume the contents are already
decrypted.
createBackup If the folderPath location already No True
contains files, it is recommended to take
a backup of those files prior to
GoAnywhere decrypting them.
backupFolderPath The location on the GoAnywhere system No None
to store the backup. If createBackup is
true, this path is required.
backupCompression Indicate whether the backup should be No Zip
compressed:

l None - Do not perform

compression on the backup file.
l Zip - Compress the backup file
using Zip.

Delete Cloud Connector

Delete a Cloud Connector using the deleteCloudConnector command.

REST
Method & URL
DELETE http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/cloudConnectors/[cloudConnectorName]

Response Body

If successful, the response body is empty.

page: 45 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Delete Cloud Connector

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
     <web:deleteCloudConnector>
     <cloudConnectorName>Jira Cloud Connector</cloudConnectorName>
     </web:deleteCloudConnector>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteCloudConnectorResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Cloud Connector 'Jira Cloud Connector' deleted successfully.</result>
</ns2:deleteCloudConnectorResponse>
</S:Body>
</S:Envelope>    

The following table lists the available options when deleting a Cloud Connector.

Parameter Name Description Required? Default

Value
cloudConnectorName The name of the Cloud Connector to Yes None
delete.

CLI
The following table lists the available options when deleting a Cloud Connector in GoAnywhere
Command using the deleteCloudConnector command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteCloudConnector -cloudConnectorName "Jira Cloud Connector"

Parameter Name Description Required? Default

Value
cloudConnectorName The name of the Cloud Connector to Yes None
delete.

GoAnywhere API Guide www.goanywhere.com page: 46

GoAnywhere Workflow Commands / Delete Monitor

Delete Monitor
Delete a Monitor using the deleteMonitor command.

NOTE:
The Monitor must be deactivated from the GoAnywhere GUI before it can be deleted using a
REST or SOAP command.

REST
Method & URL
DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/monitors/
[monitorType]/[monitorName]

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:deleteMonitor>
        <monitorName>SFTP Upload Folder</monitorName>
        <monitorType>sftp</monitorType>
    </web:deleteMonitor>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteMonitorResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Monitor 'ExampleMonitor' deleted successfully.</result>
</ns2:deleteMonitorResponse>
</S:Body>
</S:Envelope>    

The following table lists the available options when deleting a Monitor.

page: 47 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Delete Project

Parameter Description Required? Default

Name Value
monitorName The name of the monitor to delete. Yes None
monitorType The type of the monitor (file, ftp, ftps, or Yes None
sftp).

CLI
The following table lists the available options when deleting a Monitor in GoAnywhere Command
using the deleteMonitor command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteMonitor -monitorName "SFTP Upload Folder" -monitorType "sftp"

Parameter Description Required? Default

Name Value
monitorName The name of the monitor to delete. Yes None
monitorType The type of the monitor (file, ftp, ftps, or Yes None
sftp).

Delete Project
Delete a Project using the deleteProject command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/projects

Body Sample:

{
    "deleteParameters" :
{
        "project":"/DailyTransfers/TestProject",
        "domain":"Chicago Campus"
    }
}

GoAnywhere API Guide www.goanywhere.com page: 48

GoAnywhere Workflow Commands / Delete Project

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:deleteProject>
          <project>/DailyTransfers/TestProject</project>
          <domain>Chicago Campus</domain>
        </web:deleteProject>
    </soapenv:Body>
    </soapenv:Envelope>

Response Body Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:deleteProject>
          <project>/DailyTransfers/TestProject</project>
          <domain>Chicago Campus</domain>
        </web:deleteProject>
    </soapenv:Body>
    </soapenv:Envelope>

The following table lists the available options when deleting a project.

Parameter Description Required? Default

Name Value
project The Project location and Project name. e.g. Yes None
"/Demo/Test" denotes a project named 'Test'
located in the folder named 'Demo.'
domain The name of the Domain the Project belongs to. No None
This field is optional if the user belongs to a single
Domain.

CLI
The following table lists the available options when deleting a project in GoAnywhere Command
using the deleteProject command.

page: 49 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Delete Resource

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteProject -project "/DailyTransfers/TestProject" -domain "Chicago Campus"

Parameter Description Required? Default

Name Value
project The Project location and Project name. e.g. Yes None
"/Demo/Test" denotes a project named 'Test'
located in the folder named 'Demo.'
domain The name of the Domain the Project belongs to. This No None
field is optional if the user belongs to a single
Domain.

Delete Resource
Delete a Resource using the deleteResource command.

REST
Method & URL
DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/resources/
[resourceType]/[resourceName]

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:deleteResource>
            <resourceType>as2</resourceType>
            <resourceName>Partner AS2</resourceName>
        </web:deleteResource>
    </soapenv:Body>
</soapenv:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 50

GoAnywhere Workflow Commands / Delete Resource

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteResourceResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Resource 'MyFTP' of type 'ftp' deleted successfully.</result>
</ns2:deleteResourceResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when deleting a Resource.

Parameter Description Required? Default

Name Value
resourceType The type of Resource to delete. Valid Yes None
values are:

l as2 l icap
l as400 l mailbox
l azureblob l mq
l cc l pgpKeyRing
l database l rest
l ftp l s3
l ftps l smb
l gamft l snmp
l ghttps l smtp
l gofast l soap
l http l ssh
l https l webdav

resourceName The name of the Resource to delete. Yes None

CLI
The following table lists the available options when deleting a Resource in GoAnywhere Command
using the deleteResource command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteResource -resourceType "as2" -resourceName "Partner AS2"

page: 51 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Delete Schedule

Parameter Description Required? Default

Name Value
resourceType The type of Resource to delete. Valid Yes None
values are:

l azureblob l icap
l as2 l mailbox
l as400 l mq
l cc l pgpKeyRing
l database l rest
l ftp l s3
l ftps l smb
l gamft l snmp
l ghttps l smtp
l gofast l soap
l http l ssh
l https l webdav

resourceName The name of the Resource to delete. Yes None

Delete Schedule
Delete a workflow Schedule using the deleteSchedule command.

REST
Method & URL
DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/schedules/
[scheduleName]

Response Body

If successful, the response body is empty.

GoAnywhere API Guide www.goanywhere.com page: 52

GoAnywhere Workflow Commands / Delete Secure Form

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:deleteSchedule>
          <scheduleName>Daily EDI Transfer</scheduleName>
        </web:deleteSchedule>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteScheduleResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Schedule 'Daily EDI Transfer' deleted successfully.</result>
</ns2:deleteScheduleResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when deleting a schedule.

Parameter Name Description Required? Default Value

scheduleName The name of the Schedule to delete. Yes None

CLI
The following table lists the available options when deleting a schedule in GoAnywhere Command
using the deleteSchedule command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteSchedule -scheduleName "Daily EDI Transfer"

Parameter Name Description Required? Default Value

scheduleName The name of the Schedule to delete. Yes None

Delete Secure Form

Delete a Secure Form using the deleteSecureForm command.

page: 53 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Delete Secure Form

REST
Method & URL
DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/forms/
[secureFormName]

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:deleteSecureForm>
          <secureFormName>Employee Survey</secureFormName>
        </web:deleteSecureForm>
    </soapenv:Body>
</soapenv:Envelope>

If successful, the response body is empty.

Response Body Sample

The following table lists the available options when deleting a Secure Form.

Parameter Description Required? Default

Name Value
secureFormName The name of the Secure Form to Yes None
delete.

CLI
The following table lists the available options when deleting a Secure Form in GoAnywhere
Command using the deleteSecureForm command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteSecureForm -secureFormName "Employee Survey"

GoAnywhere API Guide www.goanywhere.com page: 54

GoAnywhere Workflow Commands / Delete Trigger

Parameter Description Required? Default

Name Value
secureFormName The name of the Secure Form to Yes None
delete.

Delete Trigger
Delete a Trigger using the deleteTrigger command.

REST
Method & URL
DELETE http://[server URL]:[port]//rest/gacmd/v1/triggers/[eventType]/
[triggerName]

Response Body

If successful, the response body is empty.

SOAP 
Envelope Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:deleteTrigger>
          <triggerName>Deny GoDrive Upload</triggerName>
          <eventType>before_godrive_upload</eventType>
        </web:deleteTrigger>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteTriggerResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Trigger 'Deny GoDrive Upload' deleted successfully.</result>
</ns2:deleteTriggerResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when deleting a Trigger.

page: 55 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Delete Trigger

Parameter Description Required? Default

Name Value
triggerName The name of the Trigger to delete. Yes None
eventType The event type for the Trigger. Valid values are Yes None
found on the next table.

Event Types
l account_disabled l delete_folder_failed
l as2_mdn_receive_failed l delete_folder_successful
l as2_mdn_receive_successful l disconnect
l as2_message_receive_failed l download_failed
l as2_message_receive_successful l download_successful
l before_as2_mdn_send l invitation_failed
l before_godrive_upload l invitation_successful
l before_secure_mail_send l ip_address_blacklisted
l change_password_failed l login_failed
l change_password_successful l login_successful
l checksum_failed l registration_failed
l checksum_successful l registration_successful
l connect l rename_file_failed
l connection_rejected l rename_file_successful
l create_folder_failed l rename_folder_failed
l create_folder_successful l rename_folder_successful
l delete_file_failed l upload_failed
l delete_file_successful l upload_successful

CLI
The following table lists the available options when deleting a Trigger in GoAnywhere Command
using the deleteTrigger command.

GoAnywhere API Guide www.goanywhere.com page: 56

GoAnywhere Workflow Commands / Delete Trigger

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteTrigger -triggerName "Deny GoDrive Upload" -eventType "before_godrive_
upload"

Parameter Description Required? Default

Name Value
triggerName The name of the Trigger to delete. Yes None
eventType The event type for the Trigger. Valid values Yes None
eventType values are found on the next table.

Valid eventType Values:

l account_disabled l delete_folder_successful
l as2_mdn_receive_failed l disconnect
l as2_mdn_receive_successful l download_failed
l as2_message_receive_failed l download_successful
l as2_message_receive_successful l invitation_failed
l before_as2_mdn_send l invitation_successful
l before_godrive_upload l ip_address_blacklisted
l before_secure_mail_send l login_failed
l change_password_failed l login_successful
l change_password_successful l registration_failed
l checksum_failed l registration_successful
l checksum_successful l rename_file_failed
l connect l rename_file_successful
l connection_rejected l rename_folder_failed
l create_folder_failed l rename_folder_successful
l create_folder_successful l upload_failed
l delete_file_failed l upload_successful
l delete_file_successful
l delete_folder_failed

page: 57 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Certificate

Export Certificate
Export a Certificate from a Key Vault.

REST
Method & URL
POST http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/kms/certificates

Body Sample:

{
    "exportParameters" :
{
        "keyName":"myCert",
        "keyVault":"My Vault",
        "exportType":"head",
        "domain": "Chicago Campus"
    }
}

Response Body Sample

The response body will be Base64 encoded.

MIIEGDCCAwCgAw...

SOAP
Envelope Sample

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:web="http://webservice.goanywhere.com/">        
    <soapenv:Header/>        
    <soapenv:Body>
        <web:exportCertificate>        
        <keyName>myCert</keyName>    
        <keyVault>My Vault</keyVault>    
        <exportType>head</exportType>
        <domain>Chicago Campus</domain>    
        </web:exportCertificate>            
    </soapenv:Body>
</soapenv:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 58

GoAnywhere Workflow Commands / Export Certificate

Response Body Sample

The response body will be Base64 encoded.

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">                
<S:Body>                
<ns2:exportCertificateResponse                
xmlns:ns2="http://webservice.goanywhere.com/">                
<outputFile>PD94bWw...</outputFile>                
</ns2:exportCertificateResponse>                
</S:Body>                
</S:Envelope>    

The following table lists the available options when exporting a Certificate from a Key Vault.

Parameter Description Required? Default

Name Value
keyName The name of the key to export. Yes None
exportType The type of file to export. Valid values are - Yes None
headCertificate, certificateChain, and privateKey.
keyPassword A password to secure the private key. Used when No None
export type is privateKey.
domain The name of the Domain if the user is authorized No None
to more than one Domain.
keyVault The name of the Key Vault the key exists in. If not No None
specified, the default Key Vault assigned to the
Domain will be used.

CLI
The following table lists the available options when exporting a Certificate from a Key Vault in
GoAnywhere Command using the exportCertificate command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportCertificate -certificateOutputFile "C:\users\kharris\trustedCertificates.crt"
-keyName trustedCertificate -exportType headCertificate

Parameter Name Description Required? Default

Value
keyName The name of the key to export. Yes None

page: 59 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Cloud Connector

Parameter Name Description Required? Default

Value
exportType The type of file to export. Valid values are Yes None
headCertificate, certificateChain, and
privateKey.
keyPassword A password to secure the private key. No None
Used when export type is privateKey.
certificateOutputFile The file name and location where the Yes None
certificate file will be saved.
domain The name of the Domain if the user is No None
authorized to more than one Domain.
keyVault The name of the Key Vault the key exists No None
in. If not specified, the default Key Vault
assigned to the Domain will be used.

Export Cloud Connector

Export a Cloud Connector to an XML file using the exportCloudConnector command.

REST
Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/cloudConnectors/[cloudConnectorName]

Response Body Sample

<?xml version="1.0" encoding="UTF-8" ?>

<service name="new Connector" 
version="2.0"><action name= "Copy">
    <restGet uri="https://www.example.com" url="${url}"
    authType="Basic" user="${user}" password="${password}" 
    passwordIsEncrypted="true" keyLocation="KeyVault" 
    version="1.0" />
 </action>
 <tfInputVar label="User Name" variableName="user" />
 <pInputVar label="Password" variableName="password" />
 <tfInputVar label="URL" variableName="url" /> 
</service>    

GoAnywhere API Guide www.goanywhere.com page: 60

GoAnywhere Workflow Commands / Export Cloud Connector

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
     <web:exportCloudConnector>
     <cloudConnectorName>Jira Cloud Connector</cloudConnectorName>
     </web:exportCloudConnector>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportCloudConnectorResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWwgdmV...</outputFile>
</ns2:exportCloudConnectorResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when exporting a Cloud Connector.

Parameter Name Description Required? Default

Value
cloudConnectorName The name of the Cloud Connector to Yes None
export.

CLI
The following table lists the available options when exporting a Cloud Connector in GoAnywhere
Command using the exportCloudConnector command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportCloudConnector -cloudConnectorName "Jira Cloud Connector"
-cloudConnectorOutputFile "C:\CloudConnectors\JiraCloudConnector.xml"

page: 61 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Monitor

Parameter Name Description Required? Default

Value
cloudConnectorName The name of the Cloud Connector to Yes None
export.
cloudConnectorOutputFile The location where the Cloud Yes None
Connector XML will be saved.

Export Monitor
Export a Monitor to an XML file using the exportMonitor command.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/monitors/
[monitorType]/[monitorName]

Response Body Sample

<?xml version="1.0" encoding="UTF-8" ?>

<monitor class="com.linoma.dpa.commandcenter.codec.MonitorVOCodec">
 <status>I</status>
 <actionType>0</actionType>
 <triggerDefinition>DWI 0000 2359 1 M 2,3,4,5,6</triggerDefinition>
 <description></description>
 <name>ExportMonitor</name>
 <monitorType>0</monitorType>
 <domain>Default</domain>
  <callProject runPriority="5" onFailureAttachJobLog="false"
onSuccessAttachJobLog="false" 
    project="/Transactions/Bank Files" user="admin" password="R2czGWrj3rb66id1JZwYDA==" 
    passwordIsEncrypted="true">
    <variable value="${monitor.fileList}" name="files" />
    </callProject>
    <fileMonitorDefinition>
        <useFileLocks>true</useFileLocks>
        <folder>C:\Temp</folder>
        <recursive>false</recursive>
        <dualListDelay>10</dualListDelay>
        <stopChecking>false</stopChecking>
        <events>
           <event type="createdOrModified" />
        </events>
        <filters>
           <wildcardFilter>
              <include pattern="*" caseSensitive="false" />
           </wildcardFilter>
        </filters>

GoAnywhere API Guide www.goanywhere.com page: 62

GoAnywhere Workflow Commands / Export Monitor

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:exportMonitor>
          <monitorName>Trading Partner FTP</monitorName>
          <monitorType>ftp</monitorType>
        </web:exportMonitor>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportMonitorResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>PD94bWwgdmV...</result>
</ns2:exportMonitorResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when exporting a Monitor.

Parameter Description Required? Default

Name Value
monitorName The name of the Monitor to export. Yes None
monitorType The type of Monitor (file, ftp, ftps, Yes None
sftp).

CLI
The following table lists the available options when exporting a Monitor in GoAnywhere Command
using the exportMonitor command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportMonitor -monitorName "Trading Partner FTP" -monitorType "ftp"
-monitorOutputFile "C:\monitors\TradingPartnerFTP.xml"

page: 63 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export PGP Key

Parameter Description Required? Default

Name Value
monitorName The name of the Monitor to export. Yes None
monitorType The type of Monitor (file, ftp, ftps, sftp). Yes None
monitorOutputFile The location where the Monitor XML will Yes None
be saved.

Export PGP Key

Export a PGP Key from a Key Vault.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/kms/pgpkeys

Body Sample:

{
    "exportParameters" :
{
        "keyName":"myPGPKey",
        "keyVault":"My Vault",
        "keyType":"keyPair",
        "domain": "Chicago Campus"
    }
}

Response Body Sample

The response body will be Base64 encoded.

QOsBFpFGJIBCA...

SOAP
Envelope Sample

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:web="http://webservice.goanywhere.com/">        
    <soapenv:Header/>        

GoAnywhere API Guide www.goanywhere.com page: 64

GoAnywhere Workflow Commands / Export PGP Key

    <soapenv:Body>
        <web:exportPGPKey>        
        <keyName>myPGPKey</keyName>    
        <keyVault>My Vault</keyVault>    
        <keyType>keyPair</keyType>
        <domain>Chicago Campus</domain>    
        </web:exportPGPKey>            
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

The response body will be Base64 encoded.

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">                
<S:Body>                
<ns2:exportPGPKeyResponse                
xmlns:ns2="http://webservice.goanywhere.com/">                
<outputFile>PD94bWw...</outputFile>                
</ns2:exportPGPKeyResponse>                
</S:Body>                
</S:Envelope>    

The following table lists the available options when exporting a PGP Key from a Key Vault.

Parameter Description Required? Default

Name Value
keyName The name of the key to export. Yes None
keyType The type of file to export. Valid values are public Yes None
and keyPair.
domain The name of the Domain if the user is authorized to No None
more than one Domain.
keyVault The name of the Key Vault the key exists in. If not No None
specified, the default Key Vault assigned to the
Domain will be used.

CLI
The following table lists the available options when exporting a PGP Key from a Key Vault in
GoAnywhere Command using the exportPGPKey command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportPGPKey -keyType public -ascOutputFile

page: 65 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Project

"C:\users\kharris\temp\pubring.asc" -keyName trading_partner.pkr

Parameter Description Required? Default

Name Value
keyName The name of the key to export. Yes None
keyType The type of file to export. Valid values are public Yes None
and keyPair.
ascOutputFile The file name and location where the PGP key file Yes None
will be saved.
domain The name of the Domain if the user is authorized No None
to more than one Domain.
keyVault The name of the Key Vault the key exists in. If not No None
specified, the default Key Vault assigned to the
Domain will be used.

Export Project
Export a Project to an XML file using the exportProject command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/projects

REST Body Sample:

{
    "exportParameters" :
{
        "project":"Demo/Test",
        "domain":"Chicago Campus"
    }
}

Response Body Sample

<?xml version="1.0" encoding="UTF-8"?>

<project name="Project Success" mainModule="Main" version="2.0" logLevel="verbose">

    <module name="Main">

GoAnywhere API Guide www.goanywhere.com page: 66

GoAnywhere Workflow Commands / Export Project

        <print version="1.0">
         <![CDATA[The project executed successfully. ]]>
        </print>

    </module>

</project>

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:exportProject>
            <project>/Demo/Test</project>
            <domain>Chicago Campus</domain>
        </web:exportProject>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?><S:Envelope

xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:exportProjectResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWwg...</outputFile></ns2:exportProjectResponse></S:Body></S:Envelope>

The following table lists the available options when exporting a Project.

Parameter Description Required? Default

Name Value
project The Project location and Project name. e.g. Yes None
"/Demo/Test" denotes a project named 'Test'
located in the folder named 'Demo.'
domain The name of the Domain the Project belongs to. No None
This field is optional if the user belongs to a single
Domain.

CLI
The following table lists the available options when exporting a Project in GoAnywhere Command
using the exportProject command.

page: 67 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Resource

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportProject -project "/Demo/Test" -projectOutputfile "C:\temp\test.xml" -
domain "Chicago Campus"

Parameter Description Required? Default

Name Value
project The Project location and Project name. e.g. Yes None
"/Demo/Test" denotes a project named 'Test'
located in the folder named 'Demo.'
projectOutputFile The file name and location where the Project Yes None
XML will be saved.
domain The name of the Domain the Project belongs No None
to. This field is optional if the user belongs to
a single Domain.

Export Resource
Export a Resource to an XML file using the exportResource command.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/resources/
[resourceType]/[resourceName]

Response Body Sample

<?xml version="1.0" encoding="UTF-8" ?>

<resource class="com.linoma.ga.projects.resources.FTPResource">
  <primaryContactName>Kathy Harris</primaryContactName>
  <primaryContactPhone>402.551.5551</primaryContactPhone>
  <primaryContactEmail>kharris@example.com</primaryContactEmail>
  <secondaryContactName>Joe Guy</secondaryContactName>
  <secondaryContactPhone>402.412.5551</secondaryContactPhone>
  <secondaryContactEmail>jguy@example.com</secondaryContactEmail>
  <resourceName>MyFTP</resourceName>
  <domainName>Default</domainName>
  <resourceDescription />
  <host>10.5.5.33</host>
  <port>9000</port>
  <user>admin</user>
  <password>R2czGWrj3rb66id1JZwYDA==</password>

GoAnywhere API Guide www.goanywhere.com page: 68

GoAnywhere Workflow Commands / Export Resource

  <passwordIsEncrypted>true</passwordIsEncrypted>
  <passwordIsRecoverable>false</passwordIsRecoverable>
  <passive>false</passive>
  <dataConnectionStartPort>3000</dataConnectionStartPort>
  <dataConnectionEndPort>4000</dataConnectionEndPort>
  <timeout>30</timeout>
  <connectionRetryAttempts>5</connectionRetryAttempts>
  <connectionRetryInterval>10</connectionRetryInterval>
  <initialRemoteDirectory />
  <controlEncoding />
  <throttleBandwidth>false</throttleBandwidth>
  <listParser>windows</listParser>
  <dateFormat>mm/dd/yyyy</dateFormat>
  <recentDateFormat>mm/dd/yyyy</recentDateFormat>
  <proxyType>http</proxyType>
  <proxyHost>12.5.6.23</proxyHost>
  <alternateProxyHost>12.5.6.24</alternateProxyHost>
  <proxyPort>8000</proxyPort>
  <proxyUser>admin</proxyUser>
  <proxyPassword>R2czGWrj3rb66id1JZwYDA==</proxyPassword>
  <proxyPasswordIsEncrypted>true</proxyPasswordIsEncrypted>
  <proxyPasswordIsRecoverable>false</proxyPasswordIsRecoverable>
  <resolveAtProxy>false</resolveAtProxy>
</resource>

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:exportResource>
          <resourceType>ftp</resourceType>
          <resourceName>Trading Partner FTP</resourceName>
        </web:exportResource>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?><S:Envelope

xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportResourceResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWwgdmVyc...</outputFile>
</ns2:exportResourceResponse>
</S:Body>
</S:Envelope>    

page: 69 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Resource

The following table lists the available options when exporting a Resource.

Parameter Description Required? Default

Name Value
resourceType The type of Resource to export. Valid Yes None
values are:

l as2 l icap
l as400 l mailbox
l azureblob l mq
l cc l pgpKeyRing
l database l rest
l ftp l s3
l ftps l smb
l gamft l snmp
l ghttps l smtp
l gofast l soap
l http l ssh
l https l webdav

resourceName The name of the Resource to export. Yes None

CLI
The following table lists the available options when exporting a Resource in GoAnywhere Command
using the exportResource command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportResource -resourceType "ftp" -resourceName "Trading Partner FTP"
-resourceOutputFile "C:\resources\TradingPartnerFTP.xml"

GoAnywhere API Guide www.goanywhere.com page: 70

GoAnywhere Workflow Commands / Export Schedule

Parameter Name Description Required? Default

Value
resourceType The type of Resource to export. Valid Yes None
values are:

l azureblob l icap
l as2 l mailbox
l as400 l mq
l cc l pgpKeyRing
l database l rest
l ftp l s3
l ftps l smb
l gamft l snmp
l ghttps l smtp
l gofast l soap
l http l ssh
l https l webdav

resourceName The name of the Resource to export. Yes None

resourceOutputFile The location where the Resource XML Yes None
will be saved.

Export Schedule
Export a Schedule to an XML file using the Export Schedule command.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/schedules/
[scheduleName]

Response Body Sample

<?xml version="1.0" encoding="UTF-8" ?>

<scheduledJob class="com.linoma.dpa.commandcenter.codec.ScheduledJobVOCodec">
    <password>R2czGWrj3rb66id1JZwYDA==</password>
    <name>Daily Transfers</name>
    <triggerDefinition>DLY 20170522 1600 1</triggerDefinition>

page: 71 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Schedule

    <domain>Default</domain>
    <description></description>
    <onSuccessAttachJobLog>false</onSuccessAttachJobLog>
    <onFailureAttachJobLog>false</onFailureAttachJobLog>
    <calendarName></calendarName>
    <triggerState>I</triggerState>
    <runUser>root</runUser>
    <runPriority>5</runPriority>
    <projectLocation>/Projects/Daily Transfer</projectLocation>
    <onSuccessEmails></onSuccessEmails>
    <onFailureEmails></onFailureEmails>
    <queuePriority>5</queuePriority>
    <passwordIsEncrypted>true</passwordIsEncrypted>
    <jobName></jobName>
    <jobQueue></jobQueue>
    <jobData />
</scheduledJob>

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:exportSchedule>
          <scheduleName>Daily Transfer</scheduleName>
        </web:exportSchedule>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportScheduleResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWwgdmV...</outputFile>
</ns2:exportScheduleResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when exporting a Schedule.

Parameter Name Description Required? Default Value

scheduleName The name of the Schedule to export. Yes None

GoAnywhere API Guide www.goanywhere.com page: 72

GoAnywhere Workflow Commands / Export Secure Form

CLI
The following table lists the available options when exporting a Schedule in GoAnywhere
Command using the Export Schedule command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportSchedule -scheduleName "Daily Transfer" -scheduleOutputFile
"C:\schedules\DailyTransfer.xml"

Parameter Name Description Required? Default

Value
scheduleName The name of the Schedule to export. Yes None
scheduleOutputFile The location where the Schedule XML Yes None
will be saved.

Export Secure Form

Export a Secure Form to an XML file using the Export Form command.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/forms/
[secureFormName]

Response Body Sample

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<secureForm>
<name>test</name>
<description/>
<type>1</type>
<domain>Default</domain>
<title>Ballot</title>
<instructions>Take this test.</instructions>
<status>I</status>
<publicAccess>true</publicAccess>
<publicURL>2016ballot</publicURL>
<includeBranding>true</includeBranding>
<redirectOnSuccess>false</redirectOnSuccess>
<redirectOnSuccessURL/>
<createdBy>root</createdBy>
<createdOn>1489181481000</createdOn>
<modifiedBy>root</modifiedBy>

page: 73 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Secure Form

<modifiedOn>1489181523000</modifiedOn>
<projectLocation>/Call Agent Project</projectLocation>
<runUser>root</runUser>
<userPassword>goanywhere</userPassword>
<jobName/>
<componentSequence>6</componentSequence>
<componentVersion>1</componentVersion>
<webClientEnabled>true</webClientEnabled>
<soapEnabled>true</soapEnabled>
<restEnabled>true</restEnabled>
<allowEmbeddingFrom>0</allowEmbeddingFrom>
<webGroups/>
<webUsers/>
<components>
<row id="1002-0">
<column id="1002-1">
<textfield autocomplete="true" defaultValue="" id="1002-2" label="test" 
   placeholder=""required="false" showToolTip="mouseenter" tooltip="" 
   variableName="test" width="50"/>
</column>
</row>
<row id="1002-3">
<column id="1002-4">
<textfield autocomplete="true" defaultValue="test 2" id="1002-5" 
   label="test 2" placeholder=""required="false" showToolTip="mouseenter" 
   tooltip="" variableName="test 2" width="50"/>
</column>
</row>
</components>
</secureForm>

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:exportSecureForm>
          <secureFormName>Daily Transfer</secureFormName>
        </web:exportSecureForm>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:exportSecureFormResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>PD94bWwg...</result>
</ns2:exportSecureFormResponse>
</S:Body>
</S:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 74

GoAnywhere Workflow Commands / Export SSH Key

The following table lists the available options when exporting a Secure Form.

Parameter Description Required? Default

Name Value
secureFormName The name of the Secure Form to Yes None
export.

CLI
The following table lists the available options when exporting a Secure Form in GoAnywhere
Command using the exportSecureForm command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportSecureForm -secureFormName "Ballot" -secureFormOutputFile
"C:\secureForms\Ballot.xml"

The following table lists the available options when exporting a Secure Form:

Parameter Name Description Required? Default

Value
secureFormName The name of the Secure Form to Yes None
export.
secureFormOutputFile The location where the Secure Form Yes None
XML will be saved.

Export SSH Key

Export a SSH Key from a Key Vault.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/kms/sshkeys

Body Sample:

{
    "exportParameters" :
{
        "keyName":"myRSAKey",
        "keyVault":"My Vault",

page: 75 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export SSH Key

        "keyType":"public",
        "domain": "Chicago Campus"
    }
}

Response Body Sample

The response body will be Base64 encoded.

AAAAB3NzaC1yc2EA...

SOAP
Envelope Sample

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:web="http://webservice.goanywhere.com/">        
    <soapenv:Header/>        
    <soapenv:Body>
        <web:exportSSHKey>        
        <keyName>myRSAKey</keyName>    
        <keyVault>My Vault</keyVault>    
        <keyType>public</keyType>
        <domain>Chicago Campus</domain>    
        </web:exportSSHKey>            
    </soapenv:Body>
</soapenv:Envelope>    

Response Body Sample

The response body will be Base64 encoded.

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">                
<S:Body>                
<ns2:exportSSHKeyResponse                
xmlns:ns2="http://webservice.goanywhere.com/">                
<outputFile>PD94bWw...</outputFile>                
</ns2:exportSSHKeyResponse>                
</S:Body>                
</S:Envelope>    

The following table lists the available options when exporting a SSH Key from a Key Vault.

Parameter Description Required? Default

Name Value
keyName The name of the key to export. Yes None

GoAnywhere API Guide www.goanywhere.com page: 76

GoAnywhere Workflow Commands / Export SSH Key

Parameter Description Required? Default

Name Value
keyType The type of SSH key, either public or private. Yes None
format The output format of a public key. Valid values are No openSSH
openSSH and secureShell
domain The name of the Domain if the user is authorized to No None
more than one Domain.
keyVault The name of the Key Vault the key exists in. If not No None
specified, the default Key Vault assigned to the
Domain will be used.

CLI
The following table lists the available options when exporting a SSH Key from a Key Vault in
GoAnywhere Command using the exportSSHKey command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportSSHKey -keyOutputFile "C:\users\kharris\temp\tradingPartner.pub"
-keyName tradingPartner -keyType private

Parameter Description Required? Default

Name Value
keyName The name of the key to export. Yes None
keyType The type of SSH key, either public or private. Yes None
format The output format of a public key. Valid values No openSSH
are openSSH and secureShell
keyOutputFile The file name and location where the key file will Yes None
be saved.
domain The name of the Domain if the user is authorized No None
to more than one Domain.
keyVault The name of the Key Vault the key exists in. If No None
not specified, the default Key Vault assigned to
the Domain will be used.

page: 77 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Trigger

Export Trigger
Export a Trigger to an XML file using the exportTrigger command.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/triggers/
[eventType]/[triggerName]

Response Body Sample

<?xml version="1.0" encoding="UTF-8" ?>

<triggers class="com.linoma.dpa.commandcenter.codec.TriggerVOListCodec">
   <trigger>
      <name>Auto-Delete</name>
      <status>A</status>
      <domain>Default</domain> 
      <description></description>
      <eventTypeID>122</eventTypeID>
      <stopProcessing>true</stopProcessing>
      <service>0</service>
      <action>
      <xml><?xml version="1.0" encoding="UTF-8" ?>
      <callLocalProject passwordIsEncrypted="true" project="
      /Customer Projects/Auto Delete" user="root" password="
      R2czGWrj3rb66id1JZwYDA==" />
      </xml>
      <type>6</type>
      </action>
      <conditions>
     <condition>
      <expressionId>100</expressionId>
      <closeParen></closeParen>
      <attributeId>111</attributeId>
      <openParen></openParen>
      <operand></operand>
      <value>C:\Users\KHarris\Documents\CustomerStatements</value>
     </condition>
       </conditions>
    </trigger>
</triggers>

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>

GoAnywhere API Guide www.goanywhere.com page: 78

GoAnywhere Workflow Commands / Export Trigger

        <web:exportTrigger>
            <triggerName>Upload Failed</triggerName>
            <eventType>upload_failed</eventType>
        </web:exportTrigger>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportTriggerResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWwgd...</outputFile>
</ns2:exportTriggerResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when exporting a Trigger.

Parameter Description Required? Default

Name Value
triggerName The name of the Trigger to export. Yes None
eventType The event type of the Trigger. Valid values are
found on the next table.

page: 79 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Export Trigger

Event Types
l account_disabled l delete_folder_failed
l as2_mdn_receive_failed l delete_folder_successful
l as2_mdn_receive_successful l disconnect
l as2_message_receive_failed l download_failed
l as2_message_receive_successful l download_successful
l before_as2_mdn_send l invitation_failed
l before_godrive_upload l invitation_successful
l before_secure_mail_send l ip_address_blacklisted
l change_password_failed l login_failed
l change_password_successful l login_successful
l checksum_failed l registration_failed
l checksum_successful l registration_successful
l connect l rename_file_failed
l connection_rejected l rename_file_successful
l create_folder_failed l rename_folder_failed
l create_folder_successful l rename_folder_successful
l delete_file_failed l upload_failed
l delete_file_successful l upload_successful

CLI
The following table lists the available options when exporting a Trigger in GoAnywhere Command
using the exportTrigger command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportTrigger -triggerName "Upload Failed" -eventType "upload_failed"
-triggerOutputFile "C:\triggers\uploadFailed.xml"

Parameter Description Required? Default

Name Value
triggerName The name of the Trigger to export. Yes None
eventType The event type of the Trigger. Valid values are
found on the next table.

GoAnywhere API Guide www.goanywhere.com page: 80

GoAnywhere Workflow Commands / Export Trigger

Parameter Description Required? Default

Name Value
triggerOutputFile The location where the Trigger XML will be Yes None
saved.

Valid eventType Values:

l account_disabled l delete_folder_successful
l as2_mdn_receive_failed l disconnect
l as2_mdn_receive_successful l download_failed
l as2_message_receive_failed l download_successful
l as2_message_receive_successful l invitation_failed
l before_as2_mdn_send l invitation_successful
l before_godrive_upload l ip_address_blacklisted
l before_secure_mail_send l login_failed
l change_password_failed l login_successful
l change_password_successful l registration_failed
l checksum_failed l registration_successful
l checksum_successful l rename_file_failed
l connect l rename_file_successful
l connection_rejected l rename_folder_failed
l create_folder_failed l rename_folder_successful
l create_folder_successful l upload_failed
l delete_file_failed l upload_successful
l delete_file_successful
l delete_folder_failed

page: 81 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Get Job Log

Get Job Log

Download a job log using the getJobLog command.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/jobs/[jobId]

Response Body Sample

8/7/17 10:14:46 AM    INFO    Start Date and Time: 8/7/17 10:14:46 AM

8/7/17 10:14:46 AM    INFO    Job Number: 1000000002267 
8/7/17 10:14:46 AM    INFO    Project Name: /SOAP API/Export Project
8/7/17 10:14:46 AM    INFO    Submitted By: root
8/7/17 10:14:46 AM    INFO    Submitted From: Administrator UI
8/7/17 10:14:46 AM    INFO    GoAnywhere 5.5.3 running on Windows 8 6.2 (amd64)
8/7/17 10:14:46 AM    INFO    Executing project 'Export Project' 
8/7/17 10:14:46 AM    INFO    Project location: W:\gamft\userdata\projects\SOAP
API\Export Project.xml
8/7/17 10:14:46 AM    INFO    Executing module 'Main'
8/7/17 10:14:46 AM    INFO    Executing task 'soap 1.0'
8/7/17 10:14:46 AM    INFO    Saving response body to file 'C:\Temp\SOAP_Response.dat'
8/7/17 10:14:46 AM    WARN    Overwriting the output file 'C:\Temp\SOAP_Response.dat'
8/7/17 10:14:46 AM    INFO    SOAP request to
'http://localhost:9000/goanywhere/soap/gacmd/v1/GoAnywhereCommand' 
completed successfully. 200 OK.
8/7/17 10:14:46 AM    INFO    Finished task 'soap 1.0'
8/7/17 10:14:46 AM    INFO    Finished module 'Main'
8/7/17 10:14:46 AM    INFO    Finished project 'Export Project'
8/7/17 10:14:46 AM    INFO    End Date and Time: 8/7/17 10:14:46 AM

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:getJobLog>
            <jobId>1347033630762</jobId>
        </web:getJobLog>
    </soapenv:Body>
</soapenv:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 82

GoAnywhere Workflow Commands / Get Job Log

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getJobLogResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>OC83LzE3I...</outputFile>
</ns2:getJobLogResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when using the getJobLog command.

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to each Yes None
project at runtime. The jobId's are sequential and
reflect the order in which jobs are started.

CLI
The following table lists the available options when using the getJobLog command in GoAnywhere
Command using the getJobLog command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command getJobLog -jobId 1347033630762 -jobLogOutputFile "C:\temp\Joblog.txt"

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to Yes None
each project at runtime. The jobId's are
sequential and reflect the order in which jobs
are started.
jobLogOutputFile The location where the job log file will be No None
saved.

page: 83 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Get Job Status

Get Job Status

Get a job status code and message using the getJobStatus command. The job can be in the following
status: Q (queued), A (active), P (paused), S (successful), F (failed), or C (canceled).

NOTE:
The getJobStatus command is supported in GoAnywhere MFT version 6.4.0 and later.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/jobs/
[jobId]/status[?jobStatusFormat=[jobStatusFormat]]

Response Body Sample

{     
    "jobStatusCode": "S",
    "jobStatusMessage": "Successful" 
}

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:getJobStatus> 
            <jobId>1000000008041</jobId>
            <jobStatusFormat>XML</jobStatusFormat>
        </web:getJobStatus>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">    
<S:Body>
<ns2:getJobStatusResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result><?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jobStatus>
<jobStatusCode>S</jobStatusCode>
<jobStatusMessage>Successful</jobStatusMessage>

GoAnywhere API Guide www.goanywhere.com page: 84

GoAnywhere Workflow Commands / Get Job Status

</jobStatus> 
</result>
</ns2.getJobStatusResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when using the getJobStatus command.

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to Yes None
each project at runtime. The jobId's are
sequential and reflect the order in which jobs
are started.
jobStatusFormat The output response format for job status No REST
and job status message. Valid values are Default
TEXT, JSON, and XML Value:
JSON
SOAP
Default
Value:
XML

CLI
The following table lists the available options for the getJobStatus command in GoAnywhere
Command. The job can be in the following status: Q (queued), A (active), P (paused), S (successful), F 
(failed), or C (canceled). The following table lists the available options when using the getJobStatus
command.

NOTE:
The getJobStatus command is supported in GoAnywhere MFT version 6.4.0 and later.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command getJobStatus -jobId 1347033630762 -jobStatusFormat TEXT -responseoutputfile
"c:\temp\jobStatusResponse.txt"

page: 85 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Certificate

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to Yes None
each project at runtime. The jobId's are
sequential and reflect the order in which
jobs are started.
jobStatusFormat The output response format for job status No TEXT
and job status message. Valid values are
TEXT, JSON, and XML

Import Certificate
Import a Certificate from a CERT, BCFKS, JKS, PEM, or PKCS12 file into a Key Vault.

REST
Method & URL
POST http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/kms/certificates

Body Sample:

{
    "importParameters" :
{
        "keyName":"myCert",
        "keyVault":"My Vault",
        "fileFormat":"certificate",
        "file":"Z29hbnl3aGVyZQ==",
        "domain": "Chicago Campus"
    }
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:web="http://webservice.goanywhere.com/">        

GoAnywhere API Guide www.goanywhere.com page: 86

GoAnywhere Workflow Commands / Import Certificate

    <soapenv:Header/>        
    <soapenv:Body>
        <web:importCertificate>        
        <keyName>myCert</keyName>    
        <keyVault>My Vault</keyVault>    
        <inputFile>Z29hbnl3aGVyZQ==</inputFile>    
        <domain>Chicago Campus</domain>    
        </web:importCertificate>            
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">                
<S:Body>                
<ns2:importCertificateResponse                
xmlns:ns2="http://webservice.goanywhere.com/">                
<result>Certificate 'myCert' was imported successfully</result>                
</ns2:importCertificateResponse>                
</S:Body>                
</S:Envelope>

The following table lists the available options when importing a Certificate into a Key Vault.

Parameter Description Required? Default

Name Value
keyName The alias to assign to the certificate. The No None
name must not already exist in the Key
Vault.
fileFormat The file format of the file being imported. No Certificate
Allowed values are certificate, bcfks, jks,
pem, or pkcs12.
file(REST) Base64 encoded content of the file. Yes None
inputFile(SOAP) To attach a file to SOAP request, view the Yes None
Attaching Files to SOAP Requests topic for
more information.
keyTypes The type of key to import. Valid values are No None
certificate, keyPair, or both.
keyPassword The password for the key(s). No None
storeKeyPassword Choose whether or not to store the No True
password associated with the private key.
Valid values are True or False.

page: 87 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Certificate

Parameter Description Required? Default

Name Value
domain The name of the domain if the user is No None
authorized to more than one domain.
keyVault The name of the Key Vault to insert the No None
imported key. If not specified, the default
Key Vault assigned to the domain will be
used.

CLI
The following table lists the available options when importing a Certificate into a Key Vault in
GoAnywhere Command using the importCertificate command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importCertificate -file "C:\gamft\userdata\keys\x509\trustedCertificates.cert" -
keyName trustedCertificate -domain PROD01

Parameter Description Required? Default

Name Value
keyName The alias to assign to the certificate. The No None
name must not already exist in the Key
Vault.
fileFormat The file format of the file being imported. No Certificate
Allowed values are certificate, bcfks, jks,
pem, or pkcs12.
file The full path to the file you are importing. Yes None
The input file must exist on the system
where the GoAnywhere Command
installation resides. The file is passed to
GoAnywhere for importing.
keyTypes Used for importing a .jks. The key types to No None
import from the key store. Valid values are
certificates, keyPairs, or both.
keyPassword The password for the key(s). No None

GoAnywhere API Guide www.goanywhere.com page: 88

GoAnywhere Workflow Commands / Import Cloud Connector

Parameter Description Required? Default

Name Value
storeKeyPassword Choose whether or not to store the No True
password associated with the private key.
Valid values are True or False.
domain The name of the Domain if the user is No None
authorized to more than one Domain.
keyVault The name of the Key Vault to insert the No None
imported key. If not specified, the default
Key Vault assigned to the Domain will be
used.

Import Cloud Connector

Import a Cloud Connector from an XML file.

REST
Method & URL
POST http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/cloudConnectors

Body Sample:

{
    "file":"Z29hbnl3aGVyZQ==",
    "replaceConnector":"true"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
      <web:importCloudConnector>

page: 89 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Cloud Connector

        <inputFile>Z29hbnl3aGVyZQ==</inputFile>
          <replaceConnector>true</replaceConnector>
      </web:importCloudConnector>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importCloudConnectorResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Jira' successfully imported</result>
</ns2:importCloudConnectorResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when importing a Cloud Connector.

Parameter Name Description Required? Default

Value
addonType The type of add-on being imported, No cc
Cloud Connector or SMS add-on.
Valid values are cc and sms.
file (REST) Base64 encoded content of the file. Yes None
inputFile (SOAP) To attach a file to SOAP request, view Yes None
the Attaching Files to SOAP Requests
topic for more information.
ignoreCompileErrors Ignore Cloud Connector compilation No false
errors. Valid values are true or false.
replaceConnector Replace the Cloud Connector if it No false
exists. Valid values are true or false.

GoAnywhere API Guide www.goanywhere.com page: 90

GoAnywhere Workflow Commands / Import Cloud Connector

CLI
The following table lists the available options when importing a Cloud Connector in GoAnywhere
Command using the importCloudConnector command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importCloudConnector -file "C:\CloudConnectors\JiraConnector.XML"
-ignoreCompileErrors true -replaceConnector true

Parameter Name Description Required? Default

Value
addonType The type of add-on being imported, No cc
Cloud Connector or SMS add-on. Valid
values are cc and sms.
file The absolute path to the location of the Yes None
Cloud Connector XML file. The input
file must exist on the system where the
GoAnywhere Command installation
resides.
ignoreCompileErrors Ignore Cloud Connector compilation No false
errors. Valid options are true or false.
replaceConnector Replace the Cloud Connector if it exists. No false
Valid options are true or false.

page: 91 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Monitor

Import Monitor
Import a Monitor from an XML file.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/monitors/

Body Sample:

{
    "file":"Z29hbnl3aGVyZQ==",
    "updateExistingMonitor": "true",
    "domain" : "Chicago Campus"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
      <web:importMonitor>
        <inputFile>Z29hbnl3aGVyZQ==</inputFile>
          <updateExistingMonitor>true</updateExistingMonitor>
          <domain>Chicago Campus</domain>
      </web:importMonitor>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importMonitorResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Monitor 'FileMonitor' was imported successfully</result>
</ns2:importMonitorResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when importing a Monitor.

GoAnywhere API Guide www.goanywhere.com page: 92

GoAnywhere Workflow Commands / Import PGP Key

Parameter Name Description Required? Default

Value
file (REST) Base64 encoded content of the file. Yes None
inputFile (SOAP) To attach a file to SOAP request, view Yes None
the Attaching Files to SOAP Requests
topic for more information.
updateExistingMonitor If a Monitor with the same name exists, No false
update the existing Monitor with the
new parameters. Specify true or false.
domain The name of the Domain where the No None
Monitor will belong. This field is
required when the user is authorized to
more than one Domain.

CLI
The following table lists the available options when importing a Monitor in GoAnywhere Command
using the importMonitor command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importMonitor -file "C:\Monitors\FTPMonitor.XML" -updateExistingMonitor true

Parameter Name Description Required? Default

Value
file The absolute path to the location of the Yes None
Monitor XML file.
updateExistingMonitor If a Monitor with the same name exists, No false
update the existing Monitor with the
new parameters. Specify true or false.
domain The name of the Domain where the No None
Monitor will belong. This field is
required when the user is authorized to
more than one Domain.

Import PGP Key

Import a PGP Key pair or public key into a Key Vault.

page: 93 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import PGP Key

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/kms/pgpkeys

Body Sample:

{
    "importParameters" :
{
        "keyVault":"My Vault",
        "ascFile":"Z29hbnl3aGVyZQ==",
        "domain": "Chicago Campus"
    }
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:web="http://webservice.goanywhere.com/">        
    <soapenv:Header/>        
    <soapenv:Body>
        <web:importPGPKey>            
        <keyVault>My Vault</keyVault>    
        <ascFile>Z29hbnl3aGVyZQ==</ascFile>    
        <domain>Chicago Campus</domain>    
        </web:importPGPKey>            
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">                
<S:Body>                
<ns2:importPGPKeyResponse                
xmlns:ns2="http://webservice.goanywhere.com/">                
<result>Key 'myKey' was imported successfully</result>                
</ns2:importPGPKeyResponse>                
</S:Body>                
</S:Envelope>

The following table lists the available options when importing a PGP Key into a Key Vault.

GoAnywhere API Guide www.goanywhere.com page: 94

GoAnywhere Workflow Commands / Import PGP Key

Parameter Description Required? Default

Name Value
ascFile The Base64 encoded file to import. The input No None
file must exist on the machine where the
GoAnywhere Command installation resides.
The file is passed to GoAnywhere for
importing.
publicKeyRingFile The Base64 encoded file to import. The input No None
file must exist on the machine where the
GoAnywhere Command installation resides.
The file is passed to GoAnywhere for
importing.
secretKeyRingFile The Base64 encoded file to import. The input No None
file must exist on the machine where the
GoAnywhere Command installation resides.
The file is passed to GoAnywhere for
importing.
domain The name of the domain if the user is No None
authorized to more than one domain.
keyVault The name of the Key Vault to insert the No None
imported key(s). If not specified, the default
Key Vault assigned to the domain will be
used.

page: 95 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import PGP Key

CLI
The following table lists the available options when importing a PGP Key into a Key Vault in
GoAnywhere Command using the importPGPKey command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importPGPKey -publicKeyRingFile "C:\gamft\userdata\keys\pgp\pubring.pkr" -
domain PROD01

Parameter Description Required? Default

Name Value
ascFile Used when importing an .asc file. The full path No None
to the .asc file you are importing. The input file
must exist on the machine where the
GoAnywhere Command installation resides.
The file is passed to GoAnywhere for
importing.
publicKeyRingFile The full path to the .pkr file you are importing. No None
The input file must exist on the machine
where the GoAnywhere Command installation
resides. The file is passed to GoAnywhere for
importing.
secretKeyRingFile The full path to the .skr file you are importing. No None
The input file must exist on the machine
where the GoAnywhere Command installation
resides. The file is passed to GoAnywhere for
importing.
domain The name of the Domain if the user is No None
authorized to more than one Domain.
keyVault The name of the Key Vault to insert the No None
imported key(s). If not specified, the default
Key Vault assigned to the Domain will be
used.

GoAnywhere API Guide www.goanywhere.com page: 96

GoAnywhere Workflow Commands / Import Project

Import Project
Import a Project from an XML file by using the importProject command.

REST
Method & URL

POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/projects

Body Sample:

{
    "importParameters" :
{
        "file":"Z29hbnl3aGVyZQ==",
        "domain":"Chicago Campus",
        "ignoreCompileErrors":"true",
        "replaceProject":"true",
        "createTargetFolder":"false",
        "targetFolder" : "/Incoming"
    }
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:importProject>
          <inputFile>Z29hbnl3aGVyZQ==</inputFile>
          <targetFolder>/Incoming</targetFolder>
          <replaceProject>true</replaceProject>
          <createTargetFolder>false</createTargetFolder>
          <ignoreCompileErrors>true</ignoreCompileErrors>
          <domain>Chicago Campus</domain>
        </web:importProject>
    </soapenv:Body>
</soapenv:Envelope>

page: 97 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Project

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportProjectResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWw...</outputFile>
</ns2:exportProjectResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when importing a project.

Parameter Name Description Required? Default

Value
file (REST) Base64 encoded content of the file. Yes None
inputFile (SOAP) To attach a file to SOAP request, view the Yes None
Attaching Files to SOAP Requests topic for
more information.
targetFolder The destination folder for the imported Yes None
Project.
replaceProject Replace the Project if it exists. Valid No false
options are true or false.
createTargetFolder Create a target folder if it doesn't already No false
exist. Valid options are true or false.
ignoreCompileErrors Ignore Project compilation errors. No false
domain The name of the Domain where the Project No None
will belong. This field is required when the
user is authorized to more than one
Domain.

CLI
The following table lists the available options when importing a project in GoAnywhere Command
using the importProject command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importProject -file "C:\Temp\ProcessFiles.XML"
-targetFolder "/Incoming" - replaceProject true -domain "Chicago Campus"

GoAnywhere API Guide www.goanywhere.com page: 98

GoAnywhere Workflow Commands / Import Projects From Zip

Parameter Name Description Required? Default

Value
file The absolute path to the location of the Yes None
Project XML file.
targetFolder The destination folder for the imported Yes None
Project.
replaceProject Replace the Project if it exists. Valid No false
options are true or false.
createTargetFolder Create a target folder if it doesn't already No false
exist. Valid options are true or false.
ignoreCompileErrors Ignore Project compilation errors. No false
domain The name of the Domain where the Project No None
will belong. This field is required when the
user is authorized to more than one
Domain.

Import Projects From Zip

Import Projects from a Zip file by using the importProjectsFromZip command.

REST
Method & URL

POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/projects

Body Sample:

{
    "importZipParameters" :
{
        "file":"Z29hbnl3aGVyZQ==",
        "domain":"Chicago Campus",
        "ignoreCompileErrors":"true",
        "targetFolder":"/RestFolder",
        "createTargetFolder":"true",
        "maintainDirectoryStructure":"true",
        "overwriteFolderDescription":"true",
        "overwriteDuplicateFolderVariables":"true",
        "replaceProjects":"true"
    }
}

page: 99 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Projects From Zip

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
 xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:importProjectsFromZip>
      <inputFile>Z29hbnl3aGVyZQ==</inputFile>
      <targetFolder>/Incoming</targetFolder>
      <createTargetFolder>false</createTargetFolder>
      <ignoreCompileErrors>true</ignoreCompileErrors>
      <domain>Chicago Campus</domain>
      <maintainDirectoryStructure>true</maintainDirectoryStructure>
      <overwriteFolderDescription>true</overwriteFolderDescription>
      <overwriteDuplicateFolderVariables>true</overwriteDuplicate
    FolderVariables>
    </web:importProjectsFromZip>
   </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importProjectsFromZipResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'4' projects were successfully imported to '/Incoming'</result>
</ns2:importProjectsFromZipResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when importing projects.

Parameter Name Description Required? Default

Value
file (REST) Base64 encoded content of Yes None
the file.
inputFile (SOAP) To attach a file to SOAP Yes None
request, view the Attaching
Files to SOAP Requests topic
for more information.

GoAnywhere API Guide www.goanywhere.com page: 100

GoAnywhere Workflow Commands / Import Projects From Zip

Parameter Name Description Required? Default

Value
targetFolder The destination folder for the Yes None
imported Project.
replaceProjects Replace the Project if it No false
exists. Valid options are true
or false.
createTargetFolder Create a target folder if it No false
doesn't already exist. Valid
options are true or false.
ignoreCompileErrors Ignore Project compilation No false
errors.
maintainDirectoryStructure Maintain the directory No false
structure. Valid options are
true or false.
overwriteFolderDescription Overwrite the folder No false
description. Valid options are
true or false.
overwriteDuplicateFolderVariables Overwrite duplicate folder No false
variables. Valid options are
true or false.
domain The name of the Domain No None
where the Projects will
belong. This field is required
when the user is authorized
to more than one Domain.

CLI
The following table lists the available options when importing projects in GoAnywhere Command
using the importProjectsFromZip command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importProjectsFromZip -file "C:\Temp\ProcessFiles.Zip"
-targetFolder "/Incoming" - replaceProjects true -domain "Chicago Campus"

page: 101 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Projects From Zip

Parameter Name Description Required? Default

Value
file The absolute path to the Yes None
location of the Project
Zip file.
targetFolder The destination folder for Yes None
the imported Project.
replaceProjects Replace the Projects if No false
they exist. Valid options
are true or false.
createTargetFolder Create a target folder if it No false
doesn't already exist.
Valid options are true or
false.
ignoreCompileErrors Ignore Project compilation No false
errors.
maintainDirectoryStructure Maintain the directory No false
structure. Valid options
are true or false.
overwriteFolderDescription Overwrite the folder No false
description. Valid options
are true or false.
overwriteDuplicateFolderVariables Overwrite duplicate folder No false
variables. Valid options
are true or false.
domain The name of the Domain No None
where the Project will
belong. This field is
required when the user is
authorized to more than
one Domain.

GoAnywhere API Guide www.goanywhere.com page: 102

GoAnywhere Workflow Commands / Import Resource

Import Resource
Import a Resource from an XML file. Prior to importing the Resource from a file, you must export
the Resource from the source GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/resources/

Body Sample:

{
    "file":"Z29hbnl3aGVyZQ==",
    "replaceResource": "true",
    "domain" : "Chicago Campus"    
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:importResource>
            <inputFile>Z29hbnl3aGVyZQ==</inputFile>
            <replaceResource>true</replaceResource>
            <domain>Chicago Campus</domain>
        </web:importResource>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importResourceResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Resource 'MyFTP' of type 'ftp' was successfully
imported</result></ns2:importResourceResponse>
</S:Body>
</S:Envelope>

page: 103 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Resource

The following table lists the available options when importing a Resource.

Parameter Description Required? Default

Name Value
file (REST) Base64 encoded content of the file. Yes None
inputFile To attach a file to SOAP request, view the Yes None
(SOAP) Attaching Files to SOAP Requests topic for
more information.
replaceResource Replace the Resource if it exists. Valid options No false
are true or false.
domain The name of the Domain where the Resource No None
will belong. This field is required when the user
is authorized to more than one Domain.

CLI
The following table lists the available options when importing a Resource in GoAnywhere Command
using the importResource command. Prior to importing the Resource from a file, you must export
the Resource from the source GoAnywhere server.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importResource -file "C:\Archive\database.xml" -replaceResource true

Parameter Description Required? Default

Name Value
file The absolute path to the location of the Yes None
Resource XML file.
replaceResource Replace the Resource if it exists. Valid options No false
are true or false.
domain The name of the Domain where the Resource No None
will belong. This field is required when the user
is authorized to more than one Domain.

GoAnywhere API Guide www.goanywhere.com page: 104

GoAnywhere Workflow Commands / Import Schedule

Import Schedule
Import a Schedule from an XML file. Prior to importing the Schedule from a file, you must export
the Schedule from the source GoAnywhere server.

REST
Method & URL

POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/schedules

Body Sample:

{
    "file":"Z29hbnl3aGVyZQ==",
    "replaceSchedule": "true",
    "domain" : "Chicago Campus"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:importSchedule>
            <inputFile>Z29hbnl3aGVyZQ==</inputFile>
            <replaceSchedule>true</replaceSchedule>
            <domain>Chicago Campus</domain>
        </web:importSchedule>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importScheduleResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Schedule 'StatementFTP' was imported successfully</result>
</ns2:importScheduleResponse>
</S:Body>
</S:Envelope>

page: 105 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Secure Form

The following table lists the available options when importing a Schedule.

Parameter Description Required? Default

Name Value
file (REST) Base64 encoded content of the file. Yes None
inputFile To attach a file to SOAP request, view the Yes None
(SOAP) Attaching Files to SOAP Requests topic for
more information.
replaceSchedule Replace the Schedule if it exists. Valid options No false
are true or false.
domain The name of the Domain where the Schedule No None
will belong. This field is required when the user
is authorized to more than one Domain.

CLI
The following table lists the available options when importing a Schedule in GoAnywhere Command
using the importSchedule command. Prior to importing the Schedule from a file, you must export
the Schedule from the source GoAnywhere server.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importSchedule -file "C:\Schedules\DailyTransfers.XML" -replaceSchedule true

Parameter Description Required? Default

Name Value
file The absolute path to the location of the Yes None
Schedule XML file.
replaceSchedule Replace the Schedule if it exists. Valid options No false
are true or false.
domain The name of the Domain where the Schedule No None
will belong. This field is required when the user
is authorized to more than one Domain.

Import Secure Form

Import a Secure Form from an XML file. Prior to importing the Secure Form from a file, you must
export the Secure Form from the source GoAnywhere server.

GoAnywhere API Guide www.goanywhere.com page: 106

GoAnywhere Workflow Commands / Import Secure Form

REST
Method & URL

POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/forms

Body Sample:

{
    "file":"Z29hbnl3aGVyZQ==",
    "replaceSecureForm": "true",
    "ignoreWebUsers": "true",
    "ignoreWebGroups": "true",        
    "domain" : "default"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:web="http://webservice.goanywhere.com/">
<soapenv:Header/>
    <soapenv:Body>
    <web:importSecureForm>
      <inputFile>Z29hbnl3aGVyZQ==</inputFile>
      <replaceSecureForm>false</replaceSecureForm>
      <ignoreWebUsers>true</ignoreWebUsers>
      <ignoreWebGroups>true</ignoreWebGroups>
      <domain>default</domain>
     </web:importSecureForm>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importSecureFormResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Secure Form 'Survey' added successfully.</result>
</ns2:importSecureFormResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when importing a Schedule.

page: 107 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Secure Form

Parameter Name Description Required? Default

Value
file (REST) Base64 encoded content of the Yes None
file.
inputFile (SOAP) To attach a file to SOAP request, Yes None
view the Attaching Files to
SOAP Requests topic for more
information.
replaceSecureForm Replace the Secure Form if it No false
exists. Valid options are true or
false.
ignoreWebUsers Ignore all Web Users associated No None
with the Secure Form. Valid values
are true or false.
ignoreWebGroups Ignore all Web User Groups No None
associated with the Secure Form.
Valid values are true or false.
domain The name of the Domain where No None
the Secure Form will belong. This
field is required when the user is
authorized to more than one
Domain.

CLI
The following table lists the available options when importing a Schedule in GoAnywhere Command
using the importSecureForm command. Prior to importing the Secure Form from a file, you must
export the Secure Form from the source GoAnywhere server.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importSecureForm -file "C:\forms\Ballot.xml" -replaceSecureForm true
-ignoreWebUsers true -ignoreWebGroups true

GoAnywhere API Guide www.goanywhere.com page: 108

GoAnywhere Workflow Commands / Import SSH Key

Parameter Name Description Required? Default

Value
file The absolute path to the Yes None
location of the Secure Form
XML file.
replaceSecureForm Replace the Secure Form if it No false
exists. Valid options are true
or false.
ignoreWebUsers Ignore all Web Users No false
associated to this Secure Form.
Valid options are true or false.
ignoreWebGroups Ignore all Web User Groups No false
associated to this Secure Form.
Valid options are true or false.
domain The name of the Domain No None
where the Secure Form will
belong. This field is required
when the user is authorized to
more than one Domain.

Import SSH Key

Import a public or private SSH Key into a Key Vault.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/kms/sshkeys

Body Sample:

{
    "importParameters" :
{
        "keyName":"myRSAKey",
        "keyVault":"My Vault",
        "file":"Z29hbnl3aGVyZQ==",
        "keyType" : "public",
        "domain": "Chicago Campus"
    }
  }

page: 109 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import SSH Key

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:web="http://webservice.goanywhere.com/">        
    <soapenv:Header/>        
    <soapenv:Body>
        <web:importSSHKey>           
        <keyName>myCert</keyName>            
        <keyVault>My Vault</keyVault>    
        <inputFile>Z29hbnl3aGVyZQ==</inputFile>    
        <keyType>public</keyType>
        <domain>Chicago Campus</domain>    
        </web:importSSHKey>            
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">                
<S:Body>                
<ns2:importSSHKeyResponse                
xmlns:ns2="http://webservice.goanywhere.com/">                
<result>Key 'myRSAKey' was imported successfully</result>                
</ns2:importSSHKeyResponse>                
</S:Body>                
</S:Envelope>

The following table lists the available options when importing a SSH Key into a Key Vault.

Parameter Description Required? Default

Name Value
keyName The name of the specified SSH key. Yes None
keyType The type of SSH key, either public or private. Yes None
file(REST) Base64 encoded content of the file. Yes None
inputFile(SOAP) To attach a file to SOAP request, view the Yes None
Attaching Files to SOAP Requests topic for
more information.
keyPassword The password associated with the private No None
key.

GoAnywhere API Guide www.goanywhere.com page: 110

GoAnywhere Workflow Commands / Import SSH Key

Parameter Description Required? Default

Name Value
storeKeyPassword Choose whether or not to store the password No True
associated with the private key. Valid values
are True or False.
domain The name of the domain if the user is No None
authorized to more than one domain.
keyVault The name of the Key Vault where the SSH No None
key will be stored. If not specified, the default
Key Vault assigned to the domain will be
used.

CLI
The following table lists the available options when importing a SSH Key into a Key Vault in
GoAnywhere Command using the importSSHKey command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importSSHKey -file "C:\gamft\userdata\keys\SSH\tradingPartner.pub" -keyName
tradingPartner -keyType public -domain PROD01

Parameter Description Required? Default

Name Value
keyName The name to assign the key. Yes None
keyType The type of SSH key, either public or private. Yes None
file The full path to the key file you are Yes None
importing. The input file must exist on the
machine where the GoAnywhere Command
installation resides. The file is passed to
GoAnywhere for importing.
keyPassword The password associated with the private No None
key.
storeKeyPassword Choose whether or not to store the No True
password associated with the private key.
Valid values are True or False.

page: 111 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Trigger

Parameter Description Required? Default

Name Value
domain The name of the Domain if the user is No None
authorized to more than one Domain.
keyVault The name of the Key Vault where the SSH No None
key will be stored. If not specified, the default
Key Vault assigned to the Domain will be
used.

Import Trigger
Import a Trigger using an XML file. Prior to importing the Trigger from a file, you must export the
Trigger from the source GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/triggers

Body Sample:

{
    "file":"Z29hbnl3aGVyZQ==",
    "replaceTrigger": "true",
    "domain" : "Chicago Campus"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:importTrigger>
            <inputFile>Z29hbnl3aGVyZQ==</inputFile>
            <replaceTrigger>true</replaceTrigger>
            <domain>Chicago Campus</domain>
        </web:importTrigger>

GoAnywhere API Guide www.goanywhere.com page: 112

GoAnywhere Workflow Commands / Import Trigger

    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importTriggerResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Trigger 'Auto-Delete' was replaced successfully.</result>
</ns2:importTriggerResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when importing a Trigger.

Parameter Description Required? Default

Name Value
file (REST) Base64 encoded content of the file. Yes None
inputFile To attach a file to SOAP request, view the Yes None
(SOAP) Attaching Files to SOAP Requests topic for more
information.
replaceTrigger Replace the trigger if it exists. Valid options are No false
true or false.
domain The name of the Domain where the Trigger will No None
belong. This field is required when the user is
authorized to more than one Domain.

CLI
The following table lists the available options when importing a Trigger in GoAnywhere Command
using the importTrigger command. Prior to importing the Trigger from a file, you must export the
Trigger from the source GoAnywhere server.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importTrigger -file "C:\Triggers\EDI_Trigger.XML" - replaceTrigger true

page: 113 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Import Trigger

Parameter Description Required? Default

Name Value
file The absolute path to the location of the Trigger Yes None
XML file.
replaceTrigger Replace the trigger if it exists. Valid options are No false
true or false.
domain The name of the Domain where the Trigger will No None
belong. This field is required when the user is
authorized to more than one Domain.

GoAnywhere API Guide www.goanywhere.com page: 114

GoAnywhere Workflow Commands / Pause Job

Pause Job
Pause a GoAnywhere job using the pauseJob command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/jobs/
[jobId]/pause

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:pauseJob>
            <jobId>1347033630762</jobId>
        </web:pauseJob>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:pauseJobResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Hold request submitted for job 1000000002304</result>
</ns2:pauseJobResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when pausing a job.

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to each Yes None
project at runtime. The jobId's are sequential and
reflect the order in which jobs are started.

page: 115 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Cloud Connector

CLI
The following table lists the available options when pausing a job in GoAnywhere Command using
the pauseJob command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command pauseJob -jobId 1347033630762

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to each Yes None
project at runtime. The jobId's are sequential and
reflect the order in which jobs are started.

Promote Cloud Connector

Promote a Cloud Connector from one GoAnywhere server to another GoAnywhere server.

REST
Method & URL
POST http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/cloudConnectors/
[cloudConnectorName]/promote

Body Sample:

{
    "targetServer":"http://10.1.4.1:9000/goanywhere",
    "targetUser" : "root",
    "targetPassword" : "goanywhere",
    "replaceConnector" : "true"
}

Response Body

If successful, the response body is empty.

GoAnywhere API Guide www.goanywhere.com page: 116

GoAnywhere Workflow Commands / Promote Cloud Connector

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:promoteCloudConnector>
     <cloudConnectorName>Jira Cloud Connector</cloudConnectorName>
     <targetServer>http://10.1.4.1:9000/goanywhere</targetServer>
     <targetUser>root</targetUser>
     <targetPassword>goanywhere</targetPassword>
      </web:promoteCloudConnector>
   </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:promoteCloudConnectorResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Cloud Connector' named 'Jira Cloud Connector' was promoted
successfully</result></ns2:promoteCloudConnectorResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Cloud Connector.

Parameter Name Description Required? Default

Value
targetServer The host name (or IP address) of the Yes None
target server.
targetUser The user name to log in to the target Yes None
server.
targetPassword The password for the target user to log in Yes None
with. The password is case sensitive.
cloudConnectorName The name of the Cloud Connector. Yes None
replaceConnector Replace the Cloud Connector on the No None
target server if it exists. Valid values are
true or false.

page: 117 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Cloud Connector

CLI
The following table lists the available options when promoting a Cloud Connector in GoAnywhere
Command using the promoteCloudConnector command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteCloudConnector -targetServer http://10.1.4.2:8000/goanywhere
-targetUser root -targetPassword goanywhere -cloudConnectorName "Jira Cloud Connector"
-replaceConnector true

Parameter Name Description Required? Default

Value
targetServer The host name (or IP address) of the Yes None
target server.
targetUser The user name to log in to the target Yes None
server.
targetPassword The password for the target user to log in Yes None
with. The password is case sensitive.
cloudConnectorName The name of the Cloud Connector. Yes None
replaceConnector Replace the Cloud Connector on the No false
target server if it exists. Valid options are
true or false.

GoAnywhere API Guide www.goanywhere.com page: 118

GoAnywhere Workflow Commands / Promote Monitor

Promote Monitor
Promote a Monitor from one GoAnywhere server to another GoAnywhere server.

NOTE:
The Project called by the Monitor must already exist on the target server. Use the Promote
Project command to promote the Project.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/monitors/
[monitorType]/[monitorName]/promote

Body Sample:

{
    "updateExistingMonitor":"true",
    "targetDomain": "Chicago Campus",
    "targetUser" : "root",
    "targetPassword" : "goanywhere",
    "targetServer" : "http://10.1.4.1:9000/goanywhere"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
      <web:promoteMonitor>
        <targetServer>http://10.1.4.1:9000/goanywhere
        </targetServer>
        <targetUser>root</targetUser>
        <targetPassword>goanywhere</targetPassword>
        <monitorName>FTP Monitor</monitorName>
        <monitorType>ftp</monitorType>
        <updateExistingMonitor>true</updateExistingMonitor>
        <targetDomain>Chicago Campus</targetDomain>
      </web:promoteMonitor>
    </soapenv:Body>
</soapenv:Envelope>

page: 119 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Monitor

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:promoteMonitorResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Monitor' named 'FTP Monitor' was promoted
successfully</result></ns2:promoteMonitorResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Monitor.

Parameter Name Description Required? Default

Value
targetServer The host name (or IP address) of the Yes None
target server.
targetUser The user name to log in to the target Yes None
server.
targetPassword The password for the target user to log Yes None
in with. The password is case sensitive.
monitorName The name of the Monitor. Yes None
monitorType The type of the Monitor. Valid values are Yes None
file, ftp, ftps, or sftp.
updateExistingMonitor If a Monitor with the same name exists, No false
update the existing Monitor with the
new parameters. Specify true or false.
targetDomain The name of the Domain on the target No None
server. This field is required when the
user is authorized to more than one
Domain.

CLI
The following table lists the available options when promoting a Monitor in GoAnywhere Command
using the promoteMonitor command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteMonitor -targetServer http://10.1.4.2:8000/goanywhere -targetUser
root
-targetPassword goanywhere -monitorName "FTP Monitor" -monitorType ftp

GoAnywhere API Guide www.goanywhere.com page: 120

GoAnywhere Workflow Commands / Promote Monitor

-updateExistingMonitor true

Parameter Name Description Required? Default

Value
targetServer The host name (or IP address) of the Yes None
target server.
targetUser The user name to log in to the target Yes None
server.
targetPassword The password for the target user to log Yes None
in with. The password is case sensitive.
monitorName The name of the Monitor. Yes None
monitorType The type of the Monitor. Valid values Yes None
are file, ftp, ftps, or sftp.
updateExistingMonitor If a Monitor with the same name exists, No false
update the existing Monitor with the
new parameters. Specify true or false.
targetDomain The name of the Domain on the target No None
server. This field is required when the
user is authorized to more than one
Domain.

page: 121 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Project

Promote Project
Promote a Project from one GoAnywhere server to another GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/projects

Body Sample:

{
    "promoteParameters" :
{
        "projectName":"XML to Database",
        "projectFolder":"/Incoming/Database Tasks",
        "domain":"Chicago Campus",
        "createTargetFolder":"false",
        "replaceProject":"true",
        "targetDomain": "New York Campus",
        "targetFolder" : "/Incoming/Database Tasks",
        "targetUser" : "root",
        "targetPassword" : "goanywhere",
        "targetServer" : "http://10.1.4.1:9000/goanywhere"
    }
}

GoAnywhere API Guide www.goanywhere.com page: 122

GoAnywhere Workflow Commands / Promote Project

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
      <web:promoteProject>
        <targetServer>http://10.1.4.1:9000/goanywhere
        </targetServer>
        <targetUser>root</targetUser>
        <targetPassword>goanywhere</targetPassword>
        <projectName>XML to Database</projectName>
        <projectFolder>/Incoming/Database Tasks
        </projectFolder>
        <targetFolder>/Incoming/Database Tasks
        </targetFolder>
        <replaceProject>true</replaceProject>
        <createTargetFolder>false</createTargetFolder>
        <domain>Chicago Campus</domain>
        <targetDomain>New York Campus</targetDomain>
      </web:promoteProject>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:promoteProjectResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Project' named 'XML to Database' was promoted successfully</result>
</ns2:promoteProjectResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Project.

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in Yes None
with. The password is case sensitive.

page: 123 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Project

Parameter Description Required? Default

Name Value
projectName The name of the Project. Yes None
projectFolder The full path of where the project resides Yes None
targetFolder The full path of the folder where the project Yes None
will be promoted.
replaceProject Replace the project on the target server if it No false
already exists. Valid options are true or false.
createTargetFolder Will create each folder used in the No false
targetFolder path, if the folder doesn't
already exist on the target server. Valid
options are true or false.
domain The name of the Domain the project belongs No None
to on the local system. This field is optional if
the user belongs to only one Domain.
targetDomain The name of the Domain on the target No None
server. This field is required when the user is
authorized to more than one Domain.

CLI
The following table lists the available options when promoting a Project in GoAnywhere Command
using the promoteProject command.

EXAMPLE:
This examples replaces an existing Project.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteProject -targetServer http://10.1.4.2:8000/goanywhere -targetUser root
-targetPassword goanywhere -projectName "XML to Database"
-projectFolder "/Incoming/Database Tasks" -targetFolder "/Incoming/Database Tasks"
-replaceProject true

EXAMPLE:
This examples creates a new Project in a new folder.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteProject -targetServer http://10.1.4.2:8000/goanywhere -targetUser root
-targetPassword goanywhere -projectName "XML to Database"
-projectFolder "/Incoming/Database Tasks" -targetFolder "/Incoming/Database Tasks"
-createTargetFolder true

GoAnywhere API Guide www.goanywhere.com page: 124

GoAnywhere Workflow Commands / Promote Project

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in Yes None
with. The password is case sensitive.
projectName The name of the Project. Yes None
projectFolder The full path of where the project resides Yes None
targetFolder The full path of the folder where the project Yes None
will be promoted.
replaceProject Replace the project on the target server if it No false
already exists. Valid options are true or false.
createTargetFolder Will create each folder used in the No false
targetFolder path, if the folder doesn't
already exist on the target server. Valid
options are true or false.
domain The name of the Domain the project belongs No None
to on the local system. This field is optional if
the user belongs to only one Domain.
targetDomain The name of the Domain on the target No None
server. This field is required when the user is
authorized to more than one Domain.

page: 125 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Resource

Promote Resource
Promote a Resource from one GoAnywhere server to another GoAnywhere server.

REST
Method & URL

POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/resources/[resourceType]/

[resourceName]/promote
Body Sample:

{
    "replaceResource":"true",
    "targetDomain": "Chicago Campus",
    "targetUser" : "root",
    "targetPassword" : "goanywhere",
    "targetServer" : "http://10.1.4.1:9000/goanywhere"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:promoteResource>
          <targetServer>http://10.1.4.1:9000/goanywhere
          </targetServer>
          <targetUser>root</targetUser>
          <targetPassword>goanywhere
          </targetPassword>
          <resourceName>MySQL</resourceName>
          <resourceType>database</resourceType>
          <replaceResource>true</replaceResource>
          <targetDomain>Chicago Campus
          </targetDomain>
        </web:promoteResource>
    </soapenv:Body>
</soapenv:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 126

GoAnywhere Workflow Commands / Promote Resource

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:promoteResourceResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Resource' named 'MySQL' was promoted successfully</result>
</ns2:promoteResourceResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Resource.

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
resourceName The name of the Resource. Yes None
resourceType The type of Resource to promote. Valid values Yes None
are:

l as2 l icap
l as400 l mailbox
l azureblob l mq
l cc l pgpKeyRing
l database l rest
l ftp l s3
l ftps l smb
l gamft l snmp
l ghttps l smtp
l gofast l soap
l http l ssh
l https l webdav

replaceResource Replace the Resource if it exists. Valid values No false

are true or false.

page: 127 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Resource

Parameter Description Required? Default

Name Value
targetDomain The name of the Domain on the target server. No None
This field is required when the user is
authorized to more than one Domain.

CLI
The following table lists the available options when promoting a Resource in GoAnywhere
Command using the promoteResource command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteResource -targetServer http://10.1.4.2:8000/goanywhere
-targetUser root -targetPassword goanywhere -resourceName "MySQL"
-resourceType database -replaceResource true

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
resourceName The name of the Resource. Yes None

GoAnywhere API Guide www.goanywhere.com page: 128

GoAnywhere Workflow Commands / Promote Resource

Parameter Description Required? Default

Name Value
resourceType The type of Resource to promote. Valid values Yes None
are:

l azureblob l icap
l as2 l mailbox
l as400 l mq
l cc l pgpKeyRing
l database l rest
l ftp l s3
l ftps l smb
l gamft l snmp
l ghttps l smtp
l gofast l soap
l http l ssh
l https l webdav

replaceResource Replace the Resource if it exists. Valid values No false

are true or false.
targetDomain The name of the Domain on the target server. No None
This field is required when the user is
authorized to more than one Domain.

page: 129 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Schedule

Promote Schedule
Promote a Schedule from one GoAnywhere server to another GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/schedules/
[scheduleName]/promote

Body Sample:

{
    "replaceSchedule":"true",
    "targetDomain": "Chicago Campus",
    "targetUser" : "root",
    "targetPassword" : "goanywhere",
    "targetServer" : "http://10.1.4.1:9000/goanywhere"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:promoteSchedule>
          <targetServer>http://10.1.4.1:9000/goanywhere
          </targetServer>
          <targetUser>root</targetUser>
          <targetPassword>goanywhere</targetPassword>
          <scheduleName>Daily Transfer</scheduleName>
          <replaceSchedule>true</replaceSchedule>
          <targetDomain>Chicago Campus</targetDomain>
        </web:promoteSchedule>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

GoAnywhere API Guide www.goanywhere.com page: 130

GoAnywhere Workflow Commands / Promote Schedule

<S:Body>
<ns2:promoteScheduleResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Schedule' named 'Daily Transfer' was promoted successfully</result>
</ns2:promoteScheduleResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Schedule.

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
scheduleName The name of the Schedule. Yes None
replaceSchedule Replace the Schedule if it exists. Valid values No false
are true or false.
targetDomain The name of the Domain on the target server. No None
This field is required when the user is
authorized to more than one Domain.

CLI
The following table lists the available options when promoting a Schedule in GoAnywhere
Command using the promoteSchedule command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteSchedule -targetServer http://10.1.4.2:8000/goanywhere -targetUser
root
-targetPassword goanywhere -scheduleName "Daily Transfer" -replaceSchedule true

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None

page: 131 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Secure Form

Parameter Description Required? Default

Name Value
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
scheduleName The name of the Schedule. Yes None
replaceSchedule Replace the Schedule if it exists. Valid values No false
are true or false.
targetDomain The name of the Domain on the target server. No None
This field is required when the user is
authorized to more than one Domain.

Promote Secure Form

Promote a Secure Form from one GoAnywhere server to another GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/forms/
[secureFormName]/promote

Body Sample:

{
    "replaceSecureForm":"true",
    "targetDomain": "Chicago Campus",
    "ignoreWebUsers": "true",        
    "ignoreWebGroups": "true",        
    "targetUser" : "root",
    "targetPassword" : "goanywhere",
    "targetServer" : "http://10.1.4.1:9000/goanywhere"
}

Response Body

If successful, the response body is empty.

GoAnywhere API Guide www.goanywhere.com page: 132

GoAnywhere Workflow Commands / Promote Secure Form

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
       <web:promoteSecureForm>
        <targetServer>http://10.1.4.1:9000/goanywhere
        </targetServer>
         <targetUser>root</targetUser>
        <targetPassword>goanywhere</targetPassword>
        <secureFormName>New Hire Onboarding</secureFormName>
        <replaceSecureForm>true</replaceSecureForm>
        <targetDomain>default</targetDomain>
        <ignoreWebUsers>true</ignoreWebUsers>
        <ignoreWebGroups>true</ignoreWebGroups>
       </web:promoteSchedule>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:promoteSecureFormResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Secure Form' named 'New Hire Onboarding' was promoted successfully</result>
</ns2:promoteSecureFormResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Schedule.

Parameter Name Description Required? Default

Value
targetServer The host name (or IP address) of the Yes None
target server.
targetUser The user name to log in to the target Yes None
server.
targetPassword The password for the target user to log in Yes None
with. The password is case sensitive.
secureFormName The name of the Secure Form. Yes None
replaceSecureForm Replace the Secure Form if it exists. Valid No false
values are true or false.

page: 133 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Secure Form

Parameter Name Description Required? Default

Value
ignoreWebUsers Ignore all Web Users associated with the No None
Secure Form. Valid values are true or false.
ignoreWebGroups Ignore all Web User Groups associated No None
with the Secure Form. Valid values are
true or false.
targetDomain The name of the Domain on the target No None
server. This field is required when the user
is authorized to more than one Domain.

CLI
The following table lists the available options when promoting a Schedule in GoAnywhere
Command using the promoteSecureForm command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteSecureForm -targetServer http://10.1.4.2:8000/goanywhere
-targetUser root -targetPassword goanywhere -SecureFormName "Ballot.xml"
-replaceSecureForm true -ignoreWebUsers true -ignoreWebGroups true

Parameter Name Description Required? Default

Value
targetUser The user name to log in to the Yes None
target server.
targetPassword The password for the target user to Yes None
log in with. The password is case
sensitive.
targetServer The host name (or IP address) of the Yes None
target server.
targetDomain The name of the Domain on the No None
target server. This field is required
when the user is authorized to more
than one Domain.
secureFormName The name of the Secure Form. Yes None

GoAnywhere API Guide www.goanywhere.com page: 134

GoAnywhere Workflow Commands / Promote Trigger

Parameter Name Description Required? Default

Value
replaceSecureForm Replace the Secure Form if it exists. No false
Valid values are true or false.
ignoreWebUsers Ignore all Web Users associated No false
with the Secure Form.
ignoreWebGroups Ignore all Web User Groups No false
associated with the Secure Form.

Promote Trigger
Promote a Trigger from one GoAnywhere server to another GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/triggers/
[eventType]/[triggerName]/promote

Body Sample

{
    "replaceTrigger":"true",
    "targetDomain": "Chicago Campus",
    "targetUser" : "root",
    "targetPassword" : "goanywhere",
    "targetServer" : "http://10.1.4.1:8000/goanywhere"
}

Response Body

If successful, the response body is empty.

SOAP 
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:promoteTrigger>
          <triggerName>Daily Transfers</triggerName>
          <targetServer>http://10.1.4.1:8000/goanywhere

page: 135 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Trigger

          </targetServer>
          <targetUser>root</targetUser>
          <targetPassword>goanywhere</targetPassword>
          <eventType>login_failed</eventType>
          <replaceTrigger>true</replaceTrigger>
          <targetDomain>Chicago Campus</targetDomain>
        </web:promoteTrigger>    
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:promoteTriggerResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Trigger' named 'Daily Transfers' was promoted successfully</result>
</ns2:promoteTriggerResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Trigger.

Parameter Description Required? Default

Name Value
triggerName The name of the Trigger. Yes None
targetServer The host name or IP address of the target server. Yes None
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
eventType The event type of the trigger. Valid values are Yes None
found on the next table.
replaceTrigger Replace the trigger if it exists. Valid options are No false
true or false.
targetDomain The name of the Domain on the target server. No None
This field is required when the user is authorized
to more than one Domain.

GoAnywhere API Guide www.goanywhere.com page: 136

GoAnywhere Workflow Commands / Promote Trigger

Event Types
l account_disabled l delete_folder_failed
l as2_mdn_receive_failed l delete_folder_successful
l as2_mdn_receive_successful l disconnect
l as2_message_receive_failed l download_failed
l as2_message_receive_successful l download_successful
l before_as2_mdn_send l invitation_failed
l before_godrive_upload l invitation_successful
l before_secure_mail_send l ip_address_blacklisted
l change_password_failed l login_failed
l change_password_successful l login_successful
l checksum_failed l registration_failed
l checksum_successful l registration_successful
l connect l rename_file_failed
l connection_rejected l rename_file_successful
l create_folder_failed l rename_folder_failed
l create_folder_successful l rename_folder_successful
l delete_file_failed l upload_failed
l delete_file_successful l upload_successful

CLI
The following table lists the available options when promoting a Trigger in GoAnywhere Command
using the promoteTrigger command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteTrigger -targetServer http://10.1.4.2:8000/goanywhere -targetUser
root
-targetPassword goanywhere -triggerName "Daily Transfers" -eventType login_failed
-replaceTrigger true

Parameter Description Required? Default

Name Value
triggerName The name of the Trigger. Yes None

page: 137 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Promote Trigger

Parameter Description Required? Default

Name Value
targetServer The host name or IP address of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
eventType The event type of the trigger. Valid values are Yes None
found on the next table.
replaceTrigger Replace the trigger if it exists. Valid options are No false
true or false.
targetDomain The name of the Domain on the target server. No None
This field is required when the user is
authorized to more than one Domain.

GoAnywhere API Guide www.goanywhere.com page: 138

GoAnywhere Workflow Commands / Promote Trigger

Valid eventType Values:

l account_disabled l delete_folder_successful
l as2_mdn_receive_failed l disconnect
l as2_mdn_receive_successful l download_failed
l as2_message_receive_failed l download_successful
l as2_message_receive_successful l invitation_failed
l before_as2_mdn_send l invitation_successful
l before_godrive_upload l ip_address_blacklisted
l before_secure_mail_send l login_failed
l change_password_failed l login_successful
l change_password_successful l registration_failed
l checksum_failed l registration_successful
l checksum_successful l rename_file_failed
l connect l rename_file_successful
l connection_rejected l rename_folder_failed
l create_folder_failed l rename_folder_successful
l create_folder_successful l upload_failed
l delete_file_failed l upload_successful
l delete_file_successful
l delete_folder_failed

page: 139 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Resume Job

Resume Job
Resume a paused GoAnywhere job using the resumeJob command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/jobs/
[jobId]/resume

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:resumeJob>
            <jobId>1347033630762</jobId>
        </web:resumeJob>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resumeJobResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Release request submitted for job 1000000002304</result>
</ns2:resumeJobResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when resuming a paused Job.

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to each Yes None
project at runtime. The jobId's are sequential and
reflect the order in which jobs are started.

GoAnywhere API Guide www.goanywhere.com page: 140

GoAnywhere Workflow Commands / Run Project

CLI
The following table lists the available options when resuming a paused job in GoAnywhere
Command using the resumeJob command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command resumeJob -jobId 1347033630762

Parameter Description Required? Default

Name Value
jobId The jobId is a unique job number given to each Yes None
project at runtime. The jobId's are sequential and
reflect the order in which jobs are started.

Run Project
Start a GoAnywhere Project using the runProject command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/projects

Body Sample:

{
    "runParameters" :
{
        "project":"/Data Translation",
        "domain":"Chicago Campus",
        "jobName" : "Script Transfer",
        "jobQueue" : "SFTP",
        "mode" : "batch",
        "priority" : 10,
        "variables" :
[
{
            "key" : "CustomerName",
            "value" : "example"
          },
{
            "key" : "CustomerLocation",
            "value" : "Chicago"
          }
        ]

page: 141 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Run Project

    }
}

Response Body
If successful, the response body will contain the job number of the executed Project.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:runProject>
      <project>/Data Translation</project>
        <mode>batch</mode>
        <jobName>Script Transfer</jobName>
            <jobQueue>SFTP</jobQueue>
        <priority>10</priority>
        <variables>
        <!--Zero or more repetitions:-->
        <variable>
            <!--Optional:-->
        <variableName>CustomerName
        </variableName>
        <!--Optional:-->
        <variableValue>example
        </variableValue>
        </variable>
        </variables>
        <domain>Chicago Campus</domain>
    </web:runProject>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:runProjectResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Project 'Script Transfer' submitted for execution</result>
</ns2:runProjectResponse>
</S:Body>
</S:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 142

GoAnywhere Workflow Commands / Run Project

The following table lists the available options when running a Project.

Parameter Description Required? Default

Name Value
project The Project location and Project name. Each Yes None
Project name and location is proceeded with a
forward slash as shown in the example.
mode The mode in which to run a Project. No interactive

l Batch mode submits the project to a Job

Queue. The project will be processed based
on its priority in the Queue.
l Interactive mode will execute the job
immediately. The client will wait until the
Project finishes running.
jobName Specify a name which identifies the Job. This No None
name should be descriptive enough so Admin
Users can quickly identify this Job from a report
or list. The Job Name cannot exceed 50
characters. Spaces are allowed.
jobQueue The Job Queue the Project is placed in when the No None
Job is executed in batch mode. If a Job Queue is
not specified in the runProject command, the Job
is placed in the Job Queue specified on the
Project's Control tab. If a Job Queue is not
specified on the Project's Control tab, the Job is
placed in the default Job Queue.
priority The priority of CPU resource given to the Project. No 5
The priority is a value from 1 to 10 (highest)
variables A list of variables the Project can use to override No None
any variables specified in the Project.
domain The name of the Domain the Project belongs to. No None
This field is optional if the user belongs to a single
Domain.

page: 143 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Run Project

CLI
The following table lists the available options when running a Project in GoAnywhere Command
using the runProject command.

EXAMPLE:
This command runs the Project in interactive mode.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command runProject -project /Test

EXAMPLE:
This command runs the Project in batch mode.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command runProject -project /Test -mode batch -jobQueue SFTP -jobName "Script Transfer"
-priority 10 -variables erroremail control@example.com loglocation /logs/errors/ -domain
"Chicago Campus"

Parameter Description Required? Default

Name Value
project The Project location and Project name. Each Yes None
Project name and location is proceeded with a
forward slash as shown in the example.
mode The mode in which to run a Project. No interactive

l Batch mode submits the project to a Job

Queue. The project will be processed based
on its priority in the Queue. The command
screen will return "Project '[Project
Name]' submitted for execution"
indicating the job was successfully
submitted.
l Interactive mode will execute the job
immediately. The client will wait until the
Project finishes running, at which point the
command screen will return "Project '
[Project Name]' finished with
no Errors" indicating the job completed
successfully.

GoAnywhere API Guide www.goanywhere.com page: 144

GoAnywhere Workflow Commands / Run Schedule

Parameter Description Required? Default

Name Value
jobName Specify a name which identifies the Job. This name No None
should be descriptive enough so Admin Users can
quickly identify this Job from a report or list. The
Job Name cannot exceed 50 characters. Spaces are
allowed.
jobQueue The Job Queue the Project is placed in when the No None
Job is executed in batch mode. If a Job Queue is
not specified in the runProject command, the Job
is placed in the Job Queue specified on the
Project's Control tab. If a Job Queue is not
specified on the Project's Control tab, the Job is
placed in the default Job Queue.
priority The priority of CPU resource given to the Project. No 5
The priority is a value from 1 to 10 (highest)
variables A list of variables the Project can use to override No None
any variables specified in the Project. When using
the variables option, use the following syntax: -
variables <variable name> <override value>

For example, a variable named "erroremail"

contains the value "admin@example.com," which is
used to send an email to admin@example.com if
the Project fails. However, if a Project fails and it
was started using the runProject command, you
may want email notification to go to
"control@example.com." For this you would
specify -variables erroremail
control@example.com
domain The name of the Domain the Project belongs to. No None
This field is optional if the user belongs to a single
Domain.

Run Schedule
Execute a Scheduled Job immediately using the runSchedule command.

page: 145 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Workflow Commands / Run Schedule

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/schedules/
[scheduleName]/run

Response Body
If successful, the response body will contain the job number of the executed Schedule.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
     <web:runSchedule>
        <scheduleName>Daily Transfer</scheduleName>
     </web:runSchedule>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>  
     <ns2:runScheduleResponse xmlns:ns2="http://webservice.goanywhere.com/">
        <result>Schedule 'Daily Transfer' was submitted for immediate execution. Job
number is '1000000000506'.</result>
     </ns2:runScheduleResponse>
  </S:Body>
</S:Envelope>

The following table lists the available options when running a Project.

Parameter Description Required? Default Value

Name
scheduleName The name of the Schedule to run. Yes None

CLI
The following table lists the available options when running a Schedule in GoAnywhere Command
using the runSchedule command.

GoAnywhere API Guide www.goanywhere.com page: 146

GoAnywhere Workflow Commands / Run Schedule

EXAMPLE:
This command runs the Schedule.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command runSchedule -scheduleName Test

Parameter Description Required? Default Value

Name
scheduleName The name of the Schedule to run. Yes None

page: 147 www.goanywhere.com GoAnywhere API Guide

GoAnywhere Web User
Commands
The following are the commands available for GoAnywhere Web Users:

Add Contact
Add a contact to GoAnywhere using the addContact command. A contact can be added with as little
information as an email address.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/addressBooks/
[addressBookName]/addContact

Body Sample:

{
    "email":"kharris@example.com",
    "name" : "Kathy Harris",
    "organization" : "Support",
    "officePhone" : "4024444242",
    "replace" : "yes"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:addContact>
        <email>kharris@example.com</email>
        <name>Kathy Harris</name>
        <organization>Support</name>
        <officePhone>4024444242</officePhone>
    </web:addContact>

GoAnywhere API Guide www.goanywhere.com page: 148

GoAnywhere Web User Commands / Add Contact

  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:addContactResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Contact 'kharris@example.com' was added successfully.</result>
</ns2:addContactResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when adding a contact.

Parameter Description Required? Default

Name Value
email The email to add to the contact. Yes None
name The name to add to the contact. No None
organization The organization to add to the contact. No None
officePhone The office phone number to add to the contact. No None
countryName The country name to add to the contact. No None
mobilePhone The mobile phone number to add to the contact. No None
A country name is required, and the format of the
phone number must match the mask of the
provided country.
description The description to add to the contact. No None
replace Whether or not to replace the contact if one No False
already exists with the same email. Valid values
are True or False.

CLI
The following table lists the available options when adding a contact in GoAnywhere Command
using the addContact command. A contact can be added with as little information as an email
address. The following table lists the available options when adding a contact.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addcontact -addressbook Support -email kharris@example.com

page: 149 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add SSH Key

Parameter Description Required? Default

Name Value
addressBook The unique name of the Address Book being added Yes None
to.
email The email to add to the contact. Yes None
name The name to add to the contact. No None
organization The organization to add to the contact. No None
officePhone The office phone to add to the contact. No None
countryName The country name to add to the contact. No None
mobilePhone The mobile phone number to add to the contact. A No None
country name is required, and the format of the
phone number must match the mask of the
provided country.
description The description to add to the contact. No None
replace Whether or not to replace the contact if one No No
already exists with the same email.

Add SSH Key

Add SSH keys to GoAnywhere using the addSSHKey command.
To add public and private SSH keys, authenticate as an Admin User with the Key Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/sshkeys/

Body Sample:

{
    "keyName": "sshkey123",
    "keyType" : "private",
    "keyPassword" : "password01",
    "storeKeyPassword" : "False",
    "domain" : "Chicago Campus",
    "keyVault" : "IT",
    "file" : "Z29hbnl3aGVyZQ=="
}

GoAnywhere API Guide www.goanywhere.com page: 150

GoAnywhere Web User Commands / Add SSH Key

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
      <web:addSSHKey>
        <keyName>sshkey123</keyName>
        <keyType>private</keyType>
        <keyPassword>password01</keyPassword>
        <storeKeyPassword>False</storeKeyPassword>
        <domain>Chicago Campus</domain>
        <keyVault>IT</keyVault>
        <inputFile>Z29hbnl3aGVyZQ==</inputFile>
        </web:addSSHKey>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addSSHKeyResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Public key 'sshkey123' was added successfully and associated to web user
'kharris'.</result>
</ns2:addSSHKeyResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when adding a SSH key.

Parameter Description Required? Default

Name Value
keyName The name of the specified SSH key. Yes None
keyType The type of SSH key, either public or private. Yes None
keyPassword The password used for the private key. No None
storeKeyPassword Choose whether or not to store the No True
password associated with the private key.
Valid values are True, False.

page: 151 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add SSH Key

Parameter Description Required? Default

Name Value
keyVault The name of the Key Vault where the SSH No None
key will be stored. If not specified, the default
Key Vault assigned to the Domain will be
used.
domain The name of the Domain if the user is No None
authorized to more than one Domain.
Example: "Chicago Campus"
file (REST) Base64 encoded content of the file. No None
inputFile (SOAP) To attach a file to SOAP request, view the No None
Attaching Files to SOAP Requests topic for
more information.

CLI
The following table lists the available options when adding a SSH key in GoAnywhere Command
using the addSSHKey command. To associate public SSH keys to a Web User, log in as a User with
Key Manager role.

EXAMPLE:
The following command will add a public SSH key.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addsshkey -keyname sshkey123 -keytype public -inputFile c:\file.pub

EXAMPLE:
The following command will add a private SSH key to a Key Vault.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addsshkey -keyname sshkey123 -keytype private -inputFile c:\file.pvk
-keyPassword keyp -keyVault "Trading Partner"

EXAMPLE:
The following command will associate an SSH key to a specified Web User.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addsshkey -keyname sshkey123 -username jsmith

EXAMPLE:
The following command will add a public SSH key and associate it to a specified Web User.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addsshkey -keyname sshkey123 -inputFile c:\file.pub -username jsmith

GoAnywhere API Guide www.goanywhere.com page: 152

GoAnywhere Web User Commands / Add SSH Key Association

Parameter Name Description Required? Default

Value
keyName The name of the specified SSH key. Yes None
keyType The type of SSH key, either public or No None
private.
userName The name of the Web User the key is being No None
associated with.
inputFile The full path to the key file you are No None
importing. The input file must exist on the
machine where the GoAnywhere
Command installation resides. The file is
passed to GoAnywhere for importing.
keyPassword The password used for the private key. No None
storeKeyPassword Choose whether or not to store the No True
password associated with the private key.
Valid values are True or False.
domain The name of the Domain if the user is No None
authorized to more than one Domain.

Example: "Chicago Campus"

keyVault The name of the Key Vault where the SSH No None
key will be stored. If not specified, the
default Key Vault assigned to the Domain
will be used.

Add SSH Key Association

Associate an SSH key to a Web User using the add SSH Key association command.
To associate public SSH keys to a Web User, authenticate as an Admin User with Web User
Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/sshkeys/[keyName]

page: 153 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add SSH Key Association

Body Sample:

{
    "action" : "add",
    "keyVault" : "IT"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:addSSHKey>
            <keyName>sshKey123</keyName>
            <userName>jsmith</userName>
        </web:addSSHKey>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addSSHKeyResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Public key 'sshKey123' was associated to web user 'jsmith'.</result>
</ns2:addSSHKeyResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when adding a SSH key.

Parameter Description Required? Default

Name Value
keyName The name of the specified SSH key. Yes None
userName The name of the Web User the key is being Yes None
associated with.
action Choose to 'add' or 'delete' the SSH key association No add
using the REST POST method.

GoAnywhere API Guide www.goanywhere.com page: 154

GoAnywhere Web User Commands / Add SSH Key Association

Parameter Description Required? Default

Name Value
keyVault The name of the Key Vault where the SSH key is No None
stored. If not specified, the default Key Vault
assigned to the Domain will be used.

CLI
The following table lists the available options when adding an SSH key in GoAnywhere Command
using the add SSH Key association command. To associate public SSH keys to a Web User, log in as
a User with Web User Manager role.

EXAMPLE:
The following command will associate an SSH key to a specified Web User. gacmd.exe -server
http://10.1.4.1:8000/goanywhere -user root -password goanywhere -command addsshkey -
keyname sshkey123 -username jsmith

EXAMPLE:
The following command will add a public SSH key and associate it to a specified Web User.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere -
command addsshkey -keyname sshkey123 -inputFile c:\file.pub -username jsmith

Parameter Name Description Required? Default

Value
keyName The name of the specified SSH key. Yes None
keyType The type of SSH key, either public or No None
private.
userName The name of the Web User the key is being No None
associated with.
inputFile The full path to the key file you are No None
importing. The input file must exist on the
machine where the GoAnywhere Command
installation resides. The file is passed to
GoAnywhere for importing.
keyPassword The password used for the private key. No None
storeKeyPassword Choose whether or not to store the No True
password associated with the private key.
Valid values are True or False.

page: 155 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add SSH Key Association

Parameter Name Description Required? Default

Value
domain The name of the Domain if the user is No None
authorized to more than one Domain.
Example: "Chicago Campus"
keyVault The name of the Key Vault where the SSH No None
key is stored. If not specified, the default
Key Vault assigned to the Domain will be
used.

GoAnywhere API Guide www.goanywhere.com page: 156

GoAnywhere Web User Commands / Add a Virtual File to a Web User

Add a Virtual File to a Web User

Add a virtual file to a Web User profile using the addVirtualFile command.
To add a virtual file to a Web User profile or Web User Group, authenticate as an Admin User with
the Web User Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/virtualfiles

Body Sample:

{
  "action" : "add",
  "virtualPath" : "/Inbound/Invoices/Qtr1.csv",
  "physicalPath" : "${homeDirectory}/Inbound/Invoices/Qtr1.csv",
  "permissions" : ["download","overwrite"]
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
      <web:addVirtualFile>
        <userName>kharris</userName>
        <virtualPath>/Inbound/Invoices/Qtr1.csv
        </virtualPath>
        <physicalPath>${homeDirectory}/Inbound
        /Invoices/Qtr1.csv</physicalPath>
        <permissions>
          <!--Zero or more repetitions:-->
          <permission>download</permission>
          <permission>overwrite</permission>
        </permissions>
      </web:addVirtualFile>
    </soapenv:Body>
</soapenv:Envelope>

page: 157 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add a Virtual File to a Web User

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addVirtualFileResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual file 'Qtr1.csv' successfully added to web user 'kharris'. </result>
</ns2:addVirtualFileResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when adding a virtual file.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
action The type of action used for working with Virtual Yes/REST None
Files. This is used for REST only and must be
'add'.
virtualPath The relative path of the file as it appears to Web Yes None
Users.
physicalPath The physical path to the file that the virtual Yes None
path refers to. The physical path can contain the
Web User's ${homeDirectory} variable.
permissions The permissions allowed for the file. If this No No
parameter is supplied without any values, the Permissions
permissions are reset using no permissions.
Valid values are:

n download
n overwrite
n append
n checksum
n share

CLI
The following table lists the available options for adding a virtual file in GoAnywhere Command
using the addVirtualFile command.
To add a virtual file to a Web User profile, log in as a User with the Web User Manager role.

GoAnywhere API Guide www.goanywhere.com page: 158

GoAnywhere Web User Commands / Add a Virtual File to a Web User

EXAMPLE:
The following command will add a virtual file using a relative path with permissions to a Web
User:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addVirtualFile -userName kharris -virtualPath "/Inbound/Invoices/Qtr1.csv"
-physicalPath "${homeDirectory}/Inbound/Invoices/Qtr1.csv" -permissions download
overwrite

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the file as it appears to Yes None
Web Users.
physicalPath The physical path to the file that the virtual Yes None
path refers to. The physical path can contain
the Web User's ${homeDirectory} variable.
permissions The permissions allowed for the file, separated No No
by spaces. If this parameter is supplied without Permissions
any values, the permissions are reset using no
permissions. Valid values are:

n download
n overwrite
n append
n checksum
n share

*You must specify either a userName or groupName parameter with this command.

page: 159 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add Virtual File to a Web User Group

Add Virtual File to a Web User Group

Add a virtual file to a Web User Group using the addVirtualFile command.
To add a virtual file to a Web User Group, authenticate as an Admin User with the Web User
Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/
[groupName]/virtualfiles

Body Sample:

{
  "action" : "add",
  "virtualPath" : "/Inbound/Invoices/Qtr1.csv",
  "physicalPath" : "${homeDirectory}/Inbound/Invoices/Qtr1.csv",
  "permissions" : ["download","overwrite"]
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
      <web:addVirtualFile>
        <groupName>Trading Partners</groupName>
        <virtualPath>/Inbound/Invoices/Qtr1.csv
        </virtualPath>
        <physicalPath>${homeDirectory}/Inbound
        /Invoices/Qtr1.csv</physicalPath>
        <permissions>
          <!--Zero or more repetitions:-->
          <permission>download</permission>
          <permission>overwrite</permission>
          </permissions>
          </web:addVirtualFile>
    </soapenv:Body>
</soapenv:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 160

GoAnywhere Web User Commands / Add Virtual File to a Web User Group

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addVirtualFileResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual file 'Qtr1.csv' successfully added to web user group 'Trading
Partners'.</result>
</ns2:addVirtualFileResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when adding a virtual file.

Parameter Description Required? Default

Name Value
groupName The name of the Web User Group. Yes None
action The type of action used for working with Yes/REST None
Virtual Files. This is used for REST only and
must be 'add'.
virtualPath The relative path of the file as it appears to Yes None
Web Users.
physicalPath The physical path to the file that the virtual Yes None
path refers to. The physical path can contain
the Web User's ${homeDirectory} variable.
permissions The permissions allowed for the file. If this No No
parameter is supplied without any values, the Permissions
permissions are reset using no permissions.
Valid values are:

n download
n overwrite
n append
n checksum
n share

CLI
The following table lists the available options for adding a virtual file in GoANywhere Command
using the addVirtualFile command.
To add a virtual file to a Web User profile, log in as a User with the Web User Manager role.

page: 161 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add Virtual File to a Web User Group

EXAMPLE:
The following command will add a virtual file using a relative path with permissions to a Web
User Group:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addVirtualFile -groupName HTTPSUsers -virtualPath
"/Inbound/Invoices/Qtr1.csv"
-physicalPath "${homeDirectory}/Inbound/Invoices/Qtr1.csv" -permissions download
overwrite

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the file as it appears to Web Yes None
Users.
physicalPath The physical path to the file that the virtual Yes None
path refers to. The physical path can contain the
Web User's ${homeDirectory} variable.
permissions The permissions allowed for the file, separated No No
by spaces. If this parameter is supplied without Permissions
any values, the permissions are reset using no
permissions. Valid values are:

n download
n overwrite
n append
n checksum
n share

*You must specify either a userName or groupName parameter with this command.

GoAnywhere API Guide www.goanywhere.com page: 162

GoAnywhere Web User Commands / Add a Virtual Folder to a Web User

Add a Virtual Folder to a Web User

Add a virtual folder to a Web User profile using the addVirtualFolder command.
To add a virtual folder to a Web User profile or Web User Group, authenticate as an Admin User
with the Web User Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/virtualfolders

Body Sample:

{
    "action" : "add",
    "virtualPath" : "/Inbound/Invoices",
    "physicalPath" : "${homeDirectory}/Inbound/
     Invoices",
    "diskQuota" : "10MB",
    "permissions" : ["download","overwrite"]
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
      <web:addVirtualFolder>
        <userName>kharris</userName>
        <virtualPath>/Inbound/Invoices
        </virtualPath>
        <physicalPath>${homeDirectory}/Inbound
        /Invoices</physicalPath>
        <diskQuota>10MB</diskQuote>
          <permissions>
          <!--Zero or more repetitions:-->
          <permission>download</permission>
          <permission>overwrite</permission>
          </permissions>
      </web:addVirtualFolder>

page: 163 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add a Virtual Folder to a Web User

    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addVirtualFolderResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual folder 'Inbound/Invoices' successfully added to web user 'kharris'.
</result>
</ns2:addVirtualFolderResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when adding a virtual folder.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
action The type of action used for working with Virtual Yes/REST None
Folders. This is used for REST only and must be
'add'.
virtualPath The relative path of the folder as it appears to Yes None
Web Users.
physicalPath The physical path to the folder that the virtual Yes None
path refers to. The physical path can contain the
Web User's ${homeDirectory} variable.
diskQuota Specifies the folder disk size limit. Maximum No Inherited
value is 999999 in measurements of KB, MB,
GB, or TB. You can also specify unlimited, or
inherited. Measurements are case sensitive and
cannot contain any spaces between the value
and measurement.
Example: 100GB

GoAnywhere API Guide www.goanywhere.com page: 164

GoAnywhere Web User Commands / Add a Virtual Folder to a Web User

Parameter Description Required? Default

Name Value
permissions The permissions allowed for the folder. If this No No
parameter is supplied without any values, the Permissions
permissions are reset using no permissions.
Valid values are:

n list
n download
n upload
n overwrite
n renameFiles
n deleteFiles
n checksum
n share
n createSubfolders
n renameSubfolders
n deleteSubfolders
n shareSubfolders
n applyToSubfolders
n append

CLI
Add a virtual folder to a Web User profile using the addVirtualFolder command.
To add a virtual folder to a Web User profile or Web User Group, authenticate as an Admin User
with the Web User Manager role.

EXAMPLE:
The following command will add a virtual folder using a relative path with permissions to a
Web User:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addVirtualFolder -username kharris -virtualPath "/Inbound/Invoices"
-physicalPath "${homeDirectory}/Inbound/Invoices" -diskQuota 10MB -permissions
download overwrite

page: 165 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add a Virtual Folder to a Web User

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the folder as it appears to Yes None
Web Users.
physicalPath The physical path to the folder that the virtual Yes None
path refers to. The physical path can contain the
Web User's ${homeDirectory} variable.
diskQuota Specifies the folder disk size limit. Maximum No Inherited
value is 999999 in measurements of KB, MB,
GB, or TB. You can also specify unlimited, or
inherited. Measurements are case sensitive and
cannot contain any spaces between the value
and measurement.
Example: 100GB
permissions The permissions allowed for the folder, No No
separated by spaces. If this parameter is Permissions
supplied without any values, the permissions
are reset using no permissions. Valid values are:

n list
n download
n upload
n overwrite
n renameFiles
n deleteFiles
n checksum
n share
n createSubfolders
n renameSubfolders
n deleteSubfolders
n shareSubfolders
n applyToSubfolders
n append

GoAnywhere API Guide www.goanywhere.com page: 166

GoAnywhere Web User Commands / Add a Virtual Folder to a Web User

*You must specify either a userName or groupName parameter with this command.

page: 167 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add a Virtual Folder to a Web User Group

Add a Virtual Folder to a Web User Group

Add a virtual folder to a Web User Group using the addVirtualFolder command.
To add a virtual folder to a Web User Group, authenticate as an Admin User with the Web User
Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/
[groupName]/virtualfolders

Body Sample:

{
  "action" : "add",
  "virtualPath" : "/Inbound/Invoices",
  "physicalPath" : 
  "${homeDirectory}/Inbound/Invoices",
  "diskQuota" : "10MB",
  "permissions" : ["download","overwrite"]
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:addVirtualFolder>
        <groupName>Trading Partners</groupName>
        <virtualPath>/Inbound/Invoices
        </virtualPath>
        <physicalPath>${homeDirectory}/Inbound
        /Invoices</physicalPath>
        <diskQuota>10MB</diskQuota>
        <permissions>
          <!--Zero or more repetitions:-->
          <permission>download</permission>
          <permission>overwrite</permission>
        </permissions>
    </web:addVirtualFolder>

GoAnywhere API Guide www.goanywhere.com page: 168

GoAnywhere Web User Commands / Add a Virtual Folder to a Web User Group

  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:addVirtualFolderResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual folder 'Inbound/Invoices' successfully added to web user group 'Trading
Partners'.</result>
</ns2:addVirtualFolderResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when adding a virtual folder.

Parameter Description Required? Default

Name Value
groupName The Web User Group name. Yes None
action The type of action used for working with Yes/REST None
Virtual Folders. This is used for REST only and
must be 'add'.
virtualPath The relative path of the folder as it appears to Yes None
Web Users.
physicalPath The physical path to the folder that the virtual Yes None
path refers to. The physical path can contain
the Web User's ${homeDirectory} variable.
diskQuota Specifies the folder disk size limit. Maximum No Inherited
value is 999999 in measurements of KB, MB,
GB, or TB. You can also specify unlimited, or
inherited. Measurements are case sensitive and
cannot contain any spaces between the value
and measurement.
Example: 100GB

page: 169 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add a Virtual Folder to a Web User Group

Parameter Description Required? Default

Name Value
permissions The permissions allowed for the folder. If this No No
parameter is supplied without any values, the Permissions
permissions are reset using no permissions.
Valid values are:

n list
n download
n upload
n overwrite
n renameFiles
n deleteFiles
n checksum
n share
n createSubfolders
n renameSubfolders
n deleteSubfolders
n shareSubfolders
n applyToSubfolders
n append

CLI
The following table lists the available options for adding a virtual folder in GoAnywhere Command
using the addVirtualFolder command.
To add a virtual folder to a Web User Group, log in as a User with the Web User Manager role.

EXAMPLE:
The following command will add a virtual folder using a relative path with permissions to a Web
User Group:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addVirtualFolder -groupName HTTPSUsers -virtualPath "/Inbound/Invoices"
-physicalPath "${homeDirectory}/Inbound/Invoices" -diskQuota 100MB -permissions
download overwrite

GoAnywhere API Guide www.goanywhere.com page: 170

GoAnywhere Web User Commands / Add a Virtual Folder to a Web User Group

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the folder as it appears to Yes None
Web Users.
physicalPath The physical path to the folder that the virtual Yes None
path refers to. The physical path can contain
the Web User's ${homeDirectory} variable.
diskQuota Specifies the folder disk size limit. Maximum No Inherited
value is 999999 in measurements of KB, MB,
GB, or TB. You can also specify unlimited, or
inherited. Measurements are case sensitive and
cannot contain any spaces between the value
and measurement.
Example: 100GB
permissions The permissions allowed for the folder, No No
separated by spaces. If this parameter is Permissions
supplied without any values, the permissions
are reset using no permissions. Valid values are:

n list
n download
n upload
n overwrite
n renameFiles
n deleteFiles
n checksum
n share
n createSubfolders
n renameSubfolders
n deleteSubfolders
n shareSubfolders
n applyToSubfolders
n append

page: 171 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add a Virtual Folder to a Web User Group

*You must specify either a userName or groupName parameter with this command.

GoAnywhere API Guide www.goanywhere.com page: 172

GoAnywhere Web User Commands / Add Web User

Add Web User

Add a Web User to GoAnywhere using the addWebUser command. A Web User can be added with
as little information as a Web User Template and a user name.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers

Body Sample:

{
    "addParameters" :
{
        "userName":"jsmith",
        "template" : "Trading Partners",
        "firstName" : "John",
        "lastName" : "Smith",
        "email" : "jsmith@example.com"
    }
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:addWebUser>
        <template>Trading Partners</template>
        <userName>jsmith</userName>
        <firstName>John</firstName>
        <lastName>Smith</lastName>
        <email>jsmith@example.com</email>
    </web:addWebUser>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

page: 173 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add Web User

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:addWebUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Web user 'jsmith' was added successfully.</result>
</ns2:addWebUserResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when adding a Web User.

Parameter Name Description Required? Default

Value
template The template to use when creating the Web Yes None
User. Many of the permissions and settings
for this Web User account can be predefined
in a Web User Template.
userName The Web User account name. Yes None
userPassword Password for the Web User. The password No None
must meet the restrictions set in the Web
User Password Policy. If using a Base64
encoded password hash, specify the
algorithm with the "passwordAlgorithm"
parameter.
passwordAlgorithm If the userPassword parameter is specified, No None
this parameter becomes optional and is used
if the specified password is stored in an
encrypted format (hashed and Base64
encoded). Supported hash algorithms are
MD2, MD5, PBKDF2, SHA-1, SHA-256,
SHA-384, SHA-512, and UNIX (for UNIX
style hashed passwords). The algorithms
must be specified in upper case.
firstName Web User's first name. No None
lastName Web User's last name. No None
description A description of the Web User. No None
organization The organization of the Web User. No None

GoAnywhere API Guide www.goanywhere.com page: 174

GoAnywhere Web User Commands / Add Web User

Parameter Name Description Required? Default

Value
email Web User's email address. If the Web User No None
Template is configured to email the new
Web User their password, the email address
parameter is required.
phone The phone number of the Web User. No None
httpsFingerprint The HTTPS SHA1 fingerprint for the Web No None
User. Only specify this option if the Web
User authenticates using a Certificate.
as2Fingerprint The AS2 SHA1 fingerprint for the Web User. No None
Only specify this option if the Web User
authenticates using a Certificate.
ftpesFingerprint The FTPES SHA1 fingerprint for the Web No None
User. Only specify this option if the Web
User authenticates using a Certificate.
ftpsFingerprint The FTPS SHA1 fingerprint for the Web No None
User. Only specify this option if the Web
User authenticates using a Certificate.
gofastFingerprint The GoFast SHA1 fingerprint for the Web No None
User. Only specify this option if the Web
User authenticates using a Certificate.
PeSITFingerprint The PeSIT SHA1 fingerprint for the Web No None
User. Only specify this option if the Web
User authenticates using a Certificate.
homeDirectory The home directory for the Web User. No None

CLI
The following table lists the available options when adding a Web User in GoAnywhere Command
using the addWebUser command. A Web User can be added with as little information as a Web
User Template and a user name.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addwebuser -webusertemplate "Web User Template" -username jsmith

page: 175 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add Web User

Parameter Name Description Required? Default

Value
webUserTemplate The template to use when creating the Yes None
Web User. Many of the permissions and
settings for this Web User account can
be predefined in a Web User Template.
userName The Web User account name. Yes None
userPassword Password for the Web User. The No None
password must meet the restrictions set
in the Web User Password Policy. If
using a base64 encoded password hash,
specify the algorithm with the
"userPasswordAlgorithm" parameter.
userPasswordAlgorithm If the userPassword parameter is No None
specified, this parameter becomes
optional and is used if the specified
password is stored in an encrypted
format (hashed and base64 encoded).
Supported hash algorithms are MD2,
MD5, PBKDF2, SHA-1, SHA-256, SHA-
384, SHA-512, and UNIX (for UNIX
style hashed passwords). The algorithms
must be specified in upper case.
firstName Web User's first name. No None
lastName Web User's last name. No None
description A description of the Web User. No None
organization The organization of the Web User. No None
email Web User's email address. If the Web No None
User Template is configured to email the
new Web User their password, the email
address parameter is required.
phone The phone number of the Web User. No None
httpsFingerprint The HTTPS SHA1 fingerprint for the No None
Web User. Only specify this option if
the Web User authenticates using a
Certificate.

GoAnywhere API Guide www.goanywhere.com page: 176

GoAnywhere Web User Commands / Add Web User IP

Parameter Name Description Required? Default

Value
AS2Fingerprint The AS2 SHA1 fingerprint for the Web No None
User. Only specify this option if the
Web User authenticates using a
Certificate.
ftpesFingerprint The FTPES SHA1 fingerprint for the No None
Web User. Only specify this option if
the Web User authenticates using a
Certificate.
ftpsFingerprint The FTPS SHA1 fingerprint for the Web No None
User. Only specify this option if the
Web User authenticates using a
Certificate.
gofastFingerprint The GoFast SHA1 fingerprint for the No None
Web User. Only specify this option if
the Web User authenticates using a
Certificate.
PeSITFingerprint The PeSIT SHA1 fingerprint for the Web No None
User. Only specify this option if the
Web User authenticates using a
Certificate.
homeDirectory The home directory for the Web User. No None

Add Web User IP

Add IP Filter entries for a Web User using the addWebUserIP command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/ip

Body Sample:

{
{

page: 177 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add Web User IP

        "action":"add",
        "ipAddress" : "10.1.2.77"
    }
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:addWebUserIP>
        <userName>jsmith</userName>
        <ipAddress>10.1.2.77</ipAddress>
    </web:addWebUserIP>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

If successful, the response body is empty.

The following table lists the available options when adding a Web User IP filter.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
ipAddress The individual IP address, IP address range, or Yes None
CIDR notation.

CLI
The following table lists the available options when adding IP filter entries for a Web User in
GoAnywhere Command using the addWebUserIP command. The filter type to indicate if this IP
entry should be whitelisted or blacklisted is determined on the Web User account.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addWebUserIP -userName kharris -ipAddress 10.1.2.77

GoAnywhere API Guide www.goanywhere.com page: 178

GoAnywhere Web User Commands / Add Web User IP

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
ipAddress The individual IP address, IP address range, or Yes None
CIDR notation.

page: 179 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Add a Web User to a Web User Group

Add a Web User to a Web User Group

Add a Web User to a Web User Group using the addWebUserToGroup command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/groups

Body Sample:

{
    "action" : "add",
    "groupName" : "Trading Partners",
    "createVirtualFolders" : "true"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:addWebUserToGroup>
    <userName>kharris</userName>
    <groupName>Trading Partners</groupName>
    <createVirtualFolders>true</createVirtualFolders>
    </web:addWebUserToGroup>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:addWebUserToGroupResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>User 'kharris' was added to group 'Trading Partners' successfully.</result>
</ns2:addWebUserToGroupResponse>
</S:Body>
</S:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 180

GoAnywhere Web User Commands / Delete Contact

The following table lists the available options when adding a Web User to a Web User Group:

Parameter Name Description Required? Default

Value
userName The Web User account name. Yes None
groupName The name of the Web User Group the Web Yes None
User will be added to.
createVirtualFolders If the Web User Group contains virtual No False
folders that are relative to the Web User's
home directory (using the
${homeDirectory} variable), you can choose
to create those folders when you add the
Web User to the group.

CLI
The following table lists the available options when adding a Web User to a Web User Group in
GoAnywhere Command using the addWebUserToGroup command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command addWebUserToGroup -userName jsmith -groupName "Trading Partners"
-createVirtualFolders true

Parameter Name Description Required? Default

Value
userName The Web User account name. Yes None
groupName The name of the Web User Group the Web Yes None
User will be added to.
createVirtualFolders If the Web User Group contains virtual No False
folders that are relative to the Web User's
home directory (using the
${homeDirectory} variable), you can choose
to create those folders when you add the
Web User to the group.

Delete Contact
Delete a contact to GoAnywhere using the deleteContact command.

page: 181 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Delete Contact

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/addressBooks/
[addressBookName]/deleteContact

Body Sample:

{
    "currentEmail":"kharris@example.com",
    "noFail":"true"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:deleteContact>
        <currentEmail>kharris@example.com</currentEmail>
        <noFail>true</noFail>
    </web:deleteContact>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:deleteContactResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Contact 'kharris@example.com' was removed successfully.</result>
</ns2:deleteContactResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when deleting a contact.

Parameter Description Required? Default

Name Value
currentEmail The current email of the contact. Yes None

GoAnywhere API Guide www.goanywhere.com page: 182

GoAnywhere Web User Commands / Delete Contact

Parameter Description Required? Default

Name Value
noFail A boolean indicator to prevent the failure of the No False
action if the contact cannot be found.

CLI
The following table lists the available options when deleting a contact in GoAnywhere Command
using the deleteContact command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deletecontact -addressbook Support -currentemail kharris@example.com

Parameter Description Required? Default

Name Value
addressBook The unique name of the Address Book containing Yes None
the contact.
currentEmail The email of the contact to remove. Yes None
noFail Boolean indicator to prevent the failure of the No False
action if the contact cannot be found.

page: 183 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Delete Web User

Delete Web User

Delete a Web User from GoAnywhere using the deleteWebUser command.

REST
Method & URL
DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:deleteWebUser>
            <userName>jsmith</userName>
        </web:deleteWebUser>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:deleteWebUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Web user 'jsmith' was deleted successfully</result>
</ns2:deleteWebUserResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when deleting a Web User.

Parameter Name Description Required? Default Value

userName The Web User account name. Yes None

GoAnywhere API Guide www.goanywhere.com page: 184

GoAnywhere Web User Commands / Delete Web User Group

CLI
The following table lists the available options when deleting a Web User in GoAnywhere Command
using the deleteWebUser command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deletewebuser -username jsmith

Parameter Name Description Required? Default Value

userName The Web User account name. Yes None

Delete Web User Group

Delete a Web User Group from GoAnywhere using the deleteWebUserGroup command.

REST
Method & URL

DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/[groupName]

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:deleteWebUserGroup>
        <groupName>Trading Partners</groupName>
    </web:deleteWebUserGroup>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

page: 185 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Export Web User

<S:Body>
<ns2:deleteWebUserGroupResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Web User Group 'Trading Partners' deleted successfully.</result>
</ns2:deleteWebUserGroupResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when deleting a Web User Group.

Parameter Name Description Required? Default Value

groupName The Web User Group name. Yes None

CLI
The following table lists the available options when deleting a Web User Group in GoAnywhere
Command using the deleteWebUserGroup command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command deleteWebUserGroup -groupName "Security Group"

Parameter Name Description Required? Default Value

groupName The Web User Group name. Yes None

Export Web User

Export one or more Web Users to an XML file using the Export Web User command.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/webusers?emailSearch=@he
lpsystems&statusSearch=disabled

Response Body Sample

<?xml version="1.0" encoding="UTF-8" ?>

GoAnywhere API Guide www.goanywhere.com page: 186

GoAnywhere Web User Commands / Export Web User

<webUsers class="com.linoma.dpa.commandcenter.codec.WebUserVOListCodec">
   <webUser>
      <secureMailPermissions>1</secureMailPermissions>
         <goDriveDiskQuotaOption>B</goDriveDiskQuotaOption>
      <secureFormPermission>true</secureFormPermission>
      <secureFolderPermission>true</secureFolderPermission>
      <viewActivityPermission>false</viewActivityPermission>
      <goDriveDiskSpaceUnit>G</goDriveDiskSpaceUnit>
      <passwordExpirationInterval>-1</passwordExpirationInterval>
      <lastLoginDate>1496325688000</lastLoginDate>
      <gftpesAuthType>P</gftpesAuthType>
      <as2SignatureAlias></as2SignatureAlias>
      <gsftpAuthType>P</gsftpAuthType>
      <ipFilterEnabled>false</ipFilterEnabled>
      <loginAttempts>0</loginAttempts>
      <createdOn>1494515644000</createdOn>
      <loginMethod>0</loginMethod>
      <createdBy>root</createdBy>
      <limitTime>0</limitTime>
      <as2WhenFileExist>-1</as2WhenFileExist>
      <gas2AuthType>P</gas2AuthType>
      <ipFilterType>A</ipFilterType>
      <ghttpsAuthType>P</ghttpsAuthType>
      <limitDays>0</limitDays>
      <as2RequireSignature></as2RequireSignature>
      <limitDaysOfWeek>0</limitDaysOfWeek>
      <as2Id></as2Id>
      <goFastAuthType>P</goFastAuthType>
      <inactiveDays>-1</inactiveDays>
      <approved>true</approved>
      <gftpsAuthType>P</gftpsAuthType>
      <modifiedBy>root</modifiedBy>
      <servicePermissions>11</servicePermissions>
      <modifiedOn>1502216397000</modifiedOn>
      <goDrivePermission>false</goDrivePermission>
      <goDriveAccess>F</goDriveAccess>
      <goDriveDiskSpace>5</goDriveDiskSpace>
      <pastExpiration>false</pastExpiration>
      <maxSessions>-1</maxSessions>
      <inviteUserPermission>false</inviteUserPermission>
      <passwordHashAlgorithm>5</passwordHashAlgorithm>
      <ghttpsTwoFactorAuthTypeCode></ghttpsTwoFactorAuthTypeCode>
      <password>7tE6npb...</password>
      <forcePasswordChange>false</forcePasswordChange>
      <name>kharris</name>
      <domain>Default</domain>
      <loginMethodName>GoAnywhere</loginMethodName>
      <firstName>Kathy</firstName>
      <lastName>Harris</lastName>
      <email>kharris@example.com</email>
      <phone></phone>
      <organization></organization>
      <as2MdnApprovalAutomatic></as2MdnApprovalAutomatic>
      <as2RequireEncryption></as2RequireEncryption>
      <as2RequireAuthentication></as2RequireAuthentication>
      <changePasswordPermission>false</changePasswordPermission>
      <description></description>
      <passwordIsEncrypted>true</passwordIsEncrypted>
      <enabled>true</enabled>
      <webGroups />
      <ipFilterEntries />

page: 187 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Export Web User

      <virtualFile>
       <applyToSubfolders>true</applyToSubfolders>
       <folderPermissions>8191</folderPermissions>
       <filePermissions>0</filePermissions>
       <diskQuotaOption>B</diskQuotaOption>
       <diskQuotaUnit>M</diskQuotaUnit>
       <diskQuotaSize>100</diskQuotaSize>
       <type>D</type>
       <description>This is the login directory</description>
       <virtualFiles>
         <virtualFile>
          <applyToSubfolders>false</applyToSubfolders>
          <folderPermissions>0</folderPermissions>
          <alias>ExportResource.txt</alias>
          <filePermissions>3</filePermissions>
          <diskQuotaOption>B</diskQuotaOption>
          <diskQuotaUnit>M</diskQuotaUnit>
          <diskQuotaSize>0</diskQuotaSize>
          <type>F</type>
          <path>${homeDirectory}/ExportResource.txt</path>
         </virtualFile>
          </virtualFiles>
       <secureForms>
          <secureForm>
          <name>New Hire Onboarding</name>
          </secureForm>
       </secureForms>
     </webUser>
</webUsers>

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:exportWebUser>
            <userName>kharris</userName>
        </web:exportWebUser>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportWebUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWwgdmVyc...wvd2ViVXNlcnM+</outputFile>
</ns2:exportWebUserResponse>
</S:Body>
</S:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 188

GoAnywhere Web User Commands / Export Web User

The following table lists the available options when exporting a Web User.

Parameter Description Required? Default

Name Value
userName The User Name of the Web User to export. No None
usernameSearch The parameter that will hold the User Name No None
search field and will be used to perform a
'like' query on the Web Users table.
statusSearch The parameter that will hold the Status No None
search field options, which allows the
command user to search for enabled or
disabled Web Users. Valid values are any,
enabled, disabled, pending, and expired.
firstNameSearch The parameter that will hold the First Name No None
search field and will be used to perform a
'like' query on the Web Users table.
lastNameSearch The parameter that will hold the Last Name No None
search field and will be used to perform a
'like' query on the Web Users table.
organizationSearch The parameter that will hold the No None
Organization search field and will be used to
perform a 'like' query on the Web Users
table.
emailSearch The parameter that will hold the Email No None
search field and will be used to perform a
'like' query on the Web Users table.

CLI
The following table lists the available options when exporting a Web User in GoAnywhere
Command using the Export Web User command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportWebUser -userName "kharris" -webUserOutputFile
"C:\webUsers\kharris.xml"

page: 189 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Export Web User Group

Parameter Name Description Required? Default

Value
userName The User Name of the Web User to export. No None
usernameSearch The parameter that will hold the User Name No None
search field and will be used to perform a
'like' query on the Web Users table.
statusSearch The parameter that will hold the Status No None
search field options, which allows the
command user to search for enabled or
disabled Web Users. Valid values are any,
enabled, disabled, pending, or expired.
firstNameSearch The parameter that will hold the First Name No None
search field and will be used to perform a
'like' query on the Web Users table.
lastNameSearch The parameter that will hold the Last Name No None
search field and will be used to perform a
'like' query on the Web Users table.
organizationSearch The parameter that will hold the No None
Organization search field and will be used to
perform a 'like' query on the Web Users
table.
emailSearch The parameter that will hold the Email No None
search field and will be used to perform a
'like' query on the Web Users table.
webUserOutputFile The location where the Web User XML will Yes None
be saved.

Export Web User Group

Export a Web User Group using the Export Web User Group command.

REST
Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/
[groupName]

GoAnywhere API Guide www.goanywhere.com page: 190

GoAnywhere Web User Commands / Export Web User Group

Response Body Sample

<?xml version="1.0" encoding="UTF-8" ?>

<webGroups class="com.linoma.dpa.commandcenter.codec.WebGroupVOListCodec">
   <webGroup>
    <secureMailPermissions>1</secureMailPermissions>
    <goDriveDiskQuotaOption>B</goDriveDiskQuotaOption>
    <secureFormPermission>false</secureFormPermission>
    <secureFolderPermission>true</secureFolderPermission>
    <viewActivityPermission>false</viewActivityPermission>
    <goDriveDiskSpaceUnit>G</goDriveDiskSpaceUnit>
    <servicePermissions>1</servicePermissions>
    <goDrivePermission>false</goDrivePermission>
    <goDriveAccess>F</goDriveAccess>
    <goDriveDiskSpace>5</goDriveDiskSpace>
    <inviteUserPermission>false</inviteUserPermission>
    <name>Support POC</name>
    <domain>Default</domain>
    <changePasswordPermission>false</changePasswordPermission>
    <description>Sales group</description>
    <webUsers />
    <virtualFile>
       <applyToSubfolders>true</applyToSubfolders>
       <folderPermissions>8191</folderPermissions>
       <filePermissions>0</filePermissions>
       <diskQuotaOption>B</diskQuotaOption>
       <diskQuotaUnit>M</diskQuotaUnit>
       <diskQuotaSize>100</diskQuotaSize>
       <type>D</type>
       <description>This is the login directory</description>
       <virtualFiles>
          <virtualFile>
          <applyToSubfolders>true</applyToSubfolders>
          <folderPermissions>8191</folderPermissions>
          <alias>Support Files</alias>
          <filePermissions>0</filePermissions>
          <diskQuotaOption>B</diskQuotaOption>
          <diskQuotaUnit>M</diskQuotaUnit>
          <diskQuotaSize>100</diskQuotaSize>
          <type>D</type>
          <path>C:\SalesGroup</path>
          <virtualFiles />
          </virtualFile>
     </virtualFiles>
     <secureForms />
    </webGroup>
</webGroups>

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>

page: 191 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Export Web User Group

    <web:exportWebUserGroup>
        <groupName>Trading Partners</groupName>
    </web:exportWebUserGroup>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:exportWebUserGroupResponse xmlns:ns2="http://webservice.goanywhere.com/">
<outputFile>PD94bWwgdm...</outputFile>
</ns2:exportWebUserGroupResponse>
</S:Body><
/S:Envelope>

The following table lists the available options when exporting a Web User Group.

Parameter Description Required? Default

Name Value
groupName The user name of the Web User Group to Yes None
export.

CLI
The following table lists the available options when exporting a Web User Group in GoAnywhere
Command using the exportWebUserGroup command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command exportWebUserGroup -groupName "Trading Partners"
-webUserGroupOutputFile "C:\webUserGroups\TradingPartners.xml"

Parameter Name Description Required? Default

Value
groupName The group name of the Web User Yes None
Group to export.
webUserGroupOutputFile The location where the Web User Yes None
Group XML will be saved.

GoAnywhere API Guide www.goanywhere.com page: 192

GoAnywhere Web User Commands / Import Web User

Import Web User

Import Web User(s) from an XML file. Prior to importing the Web User(s) from a file, you must
export the Web User(s) from the source GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers

Body Sample:

{
    "importParameters" :
{
        "file":"Z29hbnl3aGVyZQ==",
        "domain" : "Chicago Campus"
    }
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:importWebUser>
        <inputFile>Z29hbnl3aGVyZQ==</inputFile>
        <domain>Chicago Campus</domain>
    </web:importWebUser>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importWebUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Web user 'KHarris' was added successfully.</result>
</ns2:importWebUserResponse>
</S:Body>
</S:Envelope>

page: 193 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Import Web User

The following table lists the available options when importing a Web User.

Parameter Description Required? Default

Name Value
file (REST) Base64 encoded content of the file. Yes None
inputFile To attach a file to SOAP request, view the Attaching Yes None
(SOAP) Files to SOAP Requests topic for more information.
domain The name of the Domain where the Web User will No None
belong. This field is required when the user is
authorized to more than one Domain.

CLI
The following table lists the available options when importing a Web User in GoAnywhere
Command using the importWebUser command. Prior to importing the Web User(s) from a file, you
must export the Web User(s) from the source GoAnywhere server.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importWebUser -file "C:\temp\WebUsers.xml"

Parameter Description Required? Default

Name Value
file The absolute path to the location of the Web User Yes None
XML file
domain The name of the Domain where the Web User will No None
belong. This field is required when the user is
authorized to more than one Domain.

GoAnywhere API Guide www.goanywhere.com page: 194

GoAnywhere Web User Commands / Import Web User Group

Import Web User Group

Import a Web User Group(s) from an XML file. Prior to importing the Web User Group from a file,
you must export the Web User Group from the source GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups

Body Sample:

{
    "file":"Z29hbnl3aGVyZQ==",
    "domain" : "Chicago Campus",
    "ignoreWebUsers" : "true",
    "ignoreSecureForms" : "true"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:importWebUserGroup>
      <inputFile>Z29hbnl3aGVyZQ==</inputFile>
      <ignoreWebUsers>true</ignoreWebUsers>
      <ignoreSecureForms>true</ignoreSecureForms>
      <domain>Chicago Campus</domain>
    </web:importWebUserGroup>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:importWebUserGroupResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Web group 'REST API Group' was added successfully.</result>

page: 195 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Import Web User Group

</ns2:importWebUserGroupResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when importing a Web User Group.

Parameter Name Description Required? Default

Value
file (REST) Base64 encoded content of the file. Yes None
inputFile (SOAP) To attach a file to SOAP request, view the Yes None
Attaching Files to SOAP Requests topic for
more information.
ignoreWebUsers Ignore all Web Users associated with the No None
Web User Group. Valid values are true or
false.
ignoreSecureForms A Web User Group may be linked to a No False
number of Secure Forms. When importing a
Web User Group, this option can be specified
to ignore all Secure Forms associated with
the Web User Group. If this option is not
specified, the Secure Forms associated with
this group must already exist in
GoAnywhere.
domain The name of the Domain where the Web No None
User Group will belong. This field is required
when the user is authorized to more than
one Domain.

CLI
The following table lists the available options when importing a Web User Group in GoAnywhere
Command using the importWebUserGroup command. Prior to importing the Web User Group from
a file, you must export the Web User Group from the source GoAnywhere server.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command importWebUserGroup -file "C:\Archive\TradingPartners.XML" -ignoreWebUsers
true
-ignoreSecureForms true

GoAnywhere API Guide www.goanywhere.com page: 196

GoAnywhere Web User Commands / Import Web User Group

Parameter Name Description Required? Default

Value
file The absolute path to the location of the Yes None
Web User Group(s) XML file.
ignoreWebUsers Ignore all Web Users associated with the No None
Web User Group. Valid values are true or
false.
ignoreSecureForms A Web User Group may be linked to a No False
number of Secure Forms. When importing a
Web User Group, this option can be
specified to ignore all Secure Forms
associated with the Web User Group. If this
option is not specified, the Secure Forms
associated with this group must already
exist in GoAnywhere.
domain The name of the Domain where the Web No None
User Group will belong. This field is required
when the user is authorized to more than
one Domain.

page: 197 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Promote Web User

Promote Web User

Promote a Web User from one GoAnywhere server to another GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/promote

Body Sample:

{
  "targetServer" : "http://10.1.5.1:9000/goanywhere",
  "targetUser" : "kharris",
  "targetPassword" : "goanywhere",
  "targetDomain": "Chicago Campus"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:promoteWebUser>
      <targetServer>http://10.1.5.1:9000/
      goanywhere</targetServer>
      <targetUser>kharris</targetUser>
         <targetpassword>goanywhere</targetpassword>
      <userName>goanywhere</userName>
      <targetDomain>Trading Partners</targetDomain>
      </web:promoteWebUser>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:promoteWebUserResponse xmlns:ns2="http://webservice.goanywhere.com/">

GoAnywhere API Guide www.goanywhere.com page: 198

GoAnywhere Web User Commands / Promote Web User

<result>'Web User' named 'BSmith' was promoted successfully</result>

</ns2:promoteWebUserResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Web User.

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
userName The user name of the Web User. Yes None
targetDomain The name of the Domain on the target server. No None
This field is required when the user is
authorized to more than one Domain.

CLI
The following table lists the available options when promoting a Web User in GoAnywhere
Command using the promoteWebUser command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command promoteWebUser -targetServer http://10.1.5.2:8000/goanywhere -targetUser
root
-targetPassword goanywhere -username "kharris"

Parameter Description Required? Default

Name Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in with. Yes None
The password is case sensitive.
username The user name of the Web User. Yes None

page: 199 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Promote Web User

Parameter Description Required? Default

Name Value
targetDomain The name of the Domain on the target server. No None
This field is required when the user is
authorized to more than one Domain.

GoAnywhere API Guide www.goanywhere.com page: 200

GoAnywhere Web User Commands / Promote Web User Group

Promote Web User Group

Promote a Web User Group from one GoAnywhere server to another GoAnywhere server.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/
[groupName]/promote

Body Sample:

{
  "targetServer" : "http://10.1.3.1:9000/goanywhere",
  "targetUser" : "root",
  "targetPassword" : "goanywhere",
  "targetDomain": "Chicago Campus",
  "ignoreWebUsers" : "true",
  "ignoreSecureForms" : "true"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Header/>
  <soapenv:Body>
    <web:promoteWebUserGroup>
      <targetServer>http://10.1.3.1:9000/
      goanywhere</targetServer>
      <targetUser>root</targetUser>
      <targetpassword>goanywhere</targetpassword>
      <groupName>Trading Partners</groupName>
      <ignoreWebUsers>true</ignoreWebUsers>
      <ignoreSecureForms>true</ignoreSecureForms>
      <targetDomain>Chicago Campus</targetDomain>
    </web:promoteWebUserGroup>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

page: 201 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Promote Web User Group

<S:Body>
<ns2:promoteWebUserGroupResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>'Web User Group' named 'Trading Partners' was promoted successfully</result>
</ns2:promoteWebUserGroupResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when promoting a Web User Group.

Parameter Name Description Required? Default

Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in Yes None
with. The password is case sensitive.
groupName The name of the Web User Group. Yes None
ignoreWebUsers Ignore all Web Users associated with the No None
Web User Group. Valid values are true or
false.
ignoreSecureForms A Web User Group may be linked to a No False
number of Secure Forms. When promoting a
Web User Group, this option can be specified
to ignore all Secure Forms associated with
the Web User Group. If this option is not
specified, the Secure Forms associated with
this group must already exist in the
GoAnywhere target installation.
targetDomain The name of the Domain on the target No None
server. This field is required when the user is
authorized to more than one Domain.

CLI
The following table lists the available options when promoting a Web User Group in GoAnywhere
Command using the promoteWebUserGroup command.

EXAMPLE:
gacmd.exe -server http://10.1.3.1:8000/goanywhere -user root -password goanywhere
-command promoteWebUserGroup -targetServer http://10.1.5.2:8000/goanywhere

GoAnywhere API Guide www.goanywhere.com page: 202

GoAnywhere Web User Commands / Promote Web User Group

-targetUser root -targetPassword goanywhere -groupName "Trading Partners"

-ignoreWebUsers true -ignoreSecureForms true

Parameter Name Description Required? Default

Value
targetServer The host name (or IP address) of the target Yes None
server.
targetUser The user name to log in to the target server. Yes None
targetPassword The password for the target user to log in Yes None
with. The password is case sensitive.
groupName The name of the Web User Group. Yes None
ignoreWebUsers Ignore all Web Users associated with the No None
Web User Group. Valid values are true or
false.
ignoreSecureForms A Web User Group may be linked to a No False
number of Secure Forms. When promoting a
Web User Group, this option can be
specified to ignore all Secure Forms
associated with the Web User Group. If this
option is not specified, the Secure Forms
associated with this group must already
exist in the GoAnywhere target installation.
targetDomain The name of the Domain on the target No None
server. This field is required when the user is
authorized to more than one Domain.

page: 203 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove SSH Key From GoAnywhere

Remove SSH Key From GoAnywhere

Remove SSH keys from GoAnywhere using the removeSSHKey command.
To remove public and private SSH keys, authenticate as an Admin User with the Key Manager role.

REST
Method & URL
DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/sshkeys/
[keyType]/[keyName]
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/sshkeys/
[keyType]/[keyName]

POST Body Sample:

{
    "domain" : "Chicago Campus",
    "keyVault" : "IT"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:removeSSHKey>
            <keyName>sshkey123</keyName>
            <keyType>private</keyType>
            <domain>Chicago Campus</domain>
            <keyVault>IT</keyVault>
        </web:removeSSHKey>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

GoAnywhere API Guide www.goanywhere.com page: 204

GoAnywhere Web User Commands / Remove SSH Key From GoAnywhere

<S:Body>
<ns2:removeSSHKeyResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>SSH public key 'SFTP' was successfully removed.</result>
</ns2:removeSSHKeyResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when removing an SSH key from GoAnywhere.

Parameter Name Description Required? Default

Value
keyName The name of the specified SSH key. Yes None
keyType The type of SSH key, either Public or Yes None
Private.
domain The name of the Domain if the user is No None
authorized to more than one Domain.
Example: "Chicago Campus"
keyVault The name of the Key Vault where the SSH No None
key is stored. If not specified, the default
Key Vault assigned to the Domain will be
used.

CLI
The following table lists the available options when removing an SSH key from GoAnywhere in
GoAnywhere Command using the removeSSHKey command. To remove public and private SSH
keys, log in as a User with the Key Manager role.

EXAMPLE:
The following command removes the public and private versions of a specified SSH key. The
public and private keys well be removed from all associated Web Users.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removesshkey -keyname sshkey123

EXAMPLE:
The following command removes a public SSH key. The public key will be removed from all
associated Web Users.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removesshkey -keyname sshkey123 -keytype public

page: 205 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove SSH Key From GoAnywhere

EXAMPLE:
The following command removes a private SSH key from a Key Vault.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removesshkey -keyname sshkey123 -keytype private -keyVault "Trading Partner"

Parameter Description Required? Default

Name Value
keyName The name of the specified SSH key. Yes None
keyType The type of SSH key, either Public or Private. No None
userName The name of the Web User the key is being removed No None
from.
keyVault The name of the Key Vault where the SSH key is No None
stored. If not specified, the default Key Vault
assigned to the Domain will be used.
domain The name of the Domain if the user is authorized to No None
more than one Domain.
Example: "Chicago Campus"

GoAnywhere API Guide www.goanywhere.com page: 206

GoAnywhere Web User Commands / Remove SSH Key Association

Remove SSH Key Association

Remove SSH keys from a Web User using the removeSSHKey command.
To remove a public SSH key association from a Web User, authenticate as an Admin User with
Web User Manager role.

REST
Method & URL
DELETE http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/sshkeys/[keyName]
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/sshkeys/[keyName]

POST Body Sample:

{
    "action" : "delete",
    "keyVault" : "IT"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
    <soapenv:Header/>
    <soapenv:Body>
        <web:removeSSHKey>
            <keyName>sshkey123</keyName>
            <userName>jsmith</userName>
        </web:removeSSHKey>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>

page: 207 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove SSH Key Association

<ns2:removeSSHKeyResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>SSH public key 'sshkey123' was successfully unassociated with web user
'kharris'.</result>
</ns2:removeSSHKeyResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when removing an SSH key.

Parameter Description Required? Default

Name Value
keyName The name of the specified SSH key. Yes None
userName The name of the Web User the key is being removed Yes None
from.
action Choose to 'add' or 'delete' the SSH key association No add
using the REST POST method.
keyVault The name of the Key Vault where the SSH key will No None
be stored. If not specified, the default Key Vault
assigned to the Domain will be used.

CLI
The following table lists the available options when removing an SSH key association in
GoAnywhere Command using the removeSSHKey command. To remove a public SSH key
association from a Web User, log in as a User with Web User Manager role.

EXAMPLE:
The following command will remove a public SSH key association from a specified Web User.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removesshkey -keyname sshkey123 -username jsmith

Parameter Description Required? Default

Name Value
keyName The name of the specified SSH key. Yes None
keyType The type of SSH key, either Public or Private. No None
userName The name of the Web User the key is being removed No None
from.

GoAnywhere API Guide www.goanywhere.com page: 208

GoAnywhere Web User Commands / Remove SSH Key Association

Parameter Description Required? Default

Name Value
keyVault The name of the Key Vault where the SSH key is No None
stored. If not specified, the default Key Vault
assigned to the Domain will be used.
domain The name of the Domain if the user is authorized to No None
more than one Domain.
Example: "Chicago Campus"

page: 209 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove a Virtual File From a Web User

Remove a Virtual File From a Web User

Remove a virtual file from a Web User profile using the removeVirtualFile command.
To remove a virtual file from a Web User profile, authenticate as an Admin User with the Web
User Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/virtualfiles

Body Sample:

{
    "action" : "remove",
    "virtualPath" : "/Inbound/Invoices/Qtr1.csv"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:removeVirtualFile>
      <userName>kharris</userName>
      <virtualPath>/Inbound/Invoices/Qtr1.csv
      </virtualPath>
      </web:removeVirtualFile>
    </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeVirtualFileResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual file 'Qtr1.csv' successfully removed from web user 'kharris'. </result>

GoAnywhere API Guide www.goanywhere.com page: 210

GoAnywhere Web User Commands / Remove a Virtual File From a Web User

</ns2:removeVirtualFileResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for removing a virtual file.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
action The type of action used for working with Virtual Yes/REST None
Files. This is used for REST only and must be
'remove'.
virtualPath The relative path of the file as it appears to Web Yes None
Users.

CLI
The following table lists the available options for removing a virtual file in GoAnywhere Command
using the removeVirtualFile command.
To remove a virtual file from a Web User profile, log in as a User with the Web User Manager role.

EXAMPLE:
The following command will remove a virtual file from a Web User:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removeVirtualFile -username kharris -virtualPath "/Inbound/Invoices/Qtr1.csv"

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the file as it appears to Yes None
Web Users.

*You must specify either a userName or groupName parameter with this command.

page: 211 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove a Virtual File from a Web User Group

Remove a Virtual File from a Web User

Group
Remove a virtual file from a Web User Group using the removeVirtualFile command.
To remove a virtual file from a Web User Group, authenticate as an Admin User with the Web User
Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/
[groupName]/virtualfiles

Body Sample:

{
    "action" : "remove",
    "virtualPath" : "/Inbound/Invoices/Qtr1.csv"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:removeVirtualFile>
      <groupName>Trading Partners</groupName>
      <virtualPath>/Inbound/Invoices/Qtr1.csv
      </virtualPath>
    </web:removeVirtualFile>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

GoAnywhere API Guide www.goanywhere.com page: 212

GoAnywhere Web User Commands / Remove a Virtual File from a Web User Group

<S:Body>
<ns2:removeVirtualFileResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual file 'Qtr1.csv' successfully removed from web user group 'Trading
Partners'.</result>
</ns2:removeVirtualFileResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for removing a virtual file.

Parameter Description Required? Default

Name Value
groupName The Web User group name. Yes None
action The type of action used for working with Virtual Yes/REST None
Files. This is used for REST only and must be
'remove'.
virtualPath The relative path of the file as it appears to Web Yes None
Users.

CLI
The following table lists the available options for removing a virtual file in GoAnywhere Command
using the removeVirtualFile command.
To remove a virtual file from a Web User Group, log in as a User with the Web User Manager role.

EXAMPLE:
The following command will remove a virtual file from a Web User Group:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removeVirtualFile -groupName HTTPSUsers -virtualPath
"/Inbound/Invoices/Qtr1.csv"

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the file as it appears to Yes None
Web Users.

*You must specify either a userName or groupName parameter with this command.

page: 213 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove a Virtual Folder from a Web User

Remove a Virtual Folder from a Web User

Remove a virtual folder from a Web User profile using the removeVirtualFolder command.
To remove a virtual folder from a Web User profile, authenticate as an Admin User with the Web
User Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/virtualfolders

Body Sample:

{
    "action" : "remove",
    "virtualPath" : "/Inbound/Invoices"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:removeVirtualFolder>
      <userName>kharris</userName>
      <virtualPath>/Inbound/Invoices
      </virtualPath>
    </web:removeVirtualFolder>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:removeVirtualFolderResponse xmlns:ns2="http://webservice.goanywhere.com/">

GoAnywhere API Guide www.goanywhere.com page: 214

GoAnywhere Web User Commands / Remove a Virtual Folder from a Web User

<result>Virtual folder 'Invoices' successfully removed from web user 'kharris'.

</result>
</ns2:removeVirtualFolderResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for removing a virtual folder.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
action The type of action used for working with Virtual Yes/REST None
Folders. This is used for REST only and must be
'remove'.
virtualPath The relative path of the file as it appears to Web Yes None
Users.

CLI
The following table lists the available options for removing a virtual folder in GoAnywhere
Command using the removeVirtualFolder command.
To remove a virtual folder from a Web User profile, log in as a User with the Web User Manager
role.

EXAMPLE:
The following command will remove a virtual folder from a Web User:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removeVirtualFolder -username kharris -virtualPath "/Inbound/Invoices"

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the folder as it appears to Yes None
Web Users.

*You must specify either a userName or groupName parameter with this command.

page: 215 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove a Virtual Folder from a Web Group

Remove a Virtual Folder from a Web

Group
Remove a virtual folder from a Web User Group using the removeVirtualFolder command.
To remove a virtual folder from a Web User Group, authenticate as an Admin User with the Web
User Manager role.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/
[groupName]/virtualfolders

Body Sample:

{
    "action" : "remove",
    "virtualPath" : "/Inbound/Invoices"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:removeVirtualFolder>
      <groupName>Trading Partners</groupName>
      <virtualPath>/Inbound/Invoices</virtualPath>
    </web:removeVirtualFolder>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>

GoAnywhere API Guide www.goanywhere.com page: 216

GoAnywhere Web User Commands / Remove a Virtual Folder from a Web Group

<ns2:removeVirtualFolderResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual folder 'Invoices' successfully removed from web user group 'Trading
Partners'. </result>
</ns2:removeVirtualFolderResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for removing a virtual folder.

Parameter Description Required? Default

Name Value
groupName The Web User group name. Yes None
action The type of action used for working with Virtual Yes/REST None
Folders. This is used for REST only and must be
'remove'.
virtualPath The relative path of the folder as it appears to Web Yes None
Users.

CLI
The following table lists the available options for removing a virtual folder in GoAnywhere
Command using the removeVirtualFolder command.
To remove a virtual folder from a Web User Group, log in as a User with the Web User Manager
role.

EXAMPLE:
The following command will remove a virtual folder from a Web User Group:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removeVirtualFolder -groupName HTTPSUsers -virtualPath "/Inbound/Invoices"

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the folder as it appears to Yes None
Web Users.

*You must specify either a userName or groupName parameter with this command.

page: 217 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove a Web User From a Web User Group

Remove a Web User From a Web User

Group
Remove a Web User from a Web User Group using the removeWebUserFromGroup command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/groups

Body Sample:

{
    "action" : "remove",
    "groupName" : "Trading Partners"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:removeWebUserFromGroup>
    <userName>kharris</userName>
    <groupName>Trading Partners</groupName>
    </web:removeWebUserFromGroup>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:removeWebUserFromGroupResponse
xmlns:ns2="http://webservice.goanywhere.com/">
<result>User 'kharris' was successfully removed from group 'Trading Partners'.</result>
</ns2:removeWebUserFromGroupResponse>
</S:Body>

GoAnywhere API Guide www.goanywhere.com page: 218

GoAnywhere Web User Commands / Remove Web User IP

</S:Envelope>

The following table lists the available options when removing a Web User from a Web User Group.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
groupName The name of the Web User Group the Web User Yes None
will be removed from.

CLI
The following table lists the available options when removing a Web User from a Web User Group
in GoAnywhere Command using the removeWebUserFromGroup command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removeWebUserFromGroup -userName jsmith -groupName "Trading Partners"

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
groupName The name of the Web User Group the Web User Yes None
will be removed from.

Remove Web User IP

Remove IP Filter entries for a Web User using the removeWebUserIP command.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/ip

Body Sample:

{
{

page: 219 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Remove Web User IP

        "action":"remove",
        "ipAddress" : "10.1.2.77"
    }
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:removeWebUserIP>
        <userName>jsmith</userName>
        <ipAddress>10.1.2.77</ipAddress>
    </web:removeWebUserIP>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

If successful, the response body is empty.

The following table lists the available options when removing a Web User IP filter.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
ipAddress The individual IP address, IP address range, or Yes None
CIDR notation.

CLI
The following table lists the available options when removing IP filter entries for a Web User in
GoAnywhere Command using the removeWebUserIP command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command removeWebUserIP -userName kharris -ipAddress 10.1.2.77

GoAnywhere API Guide www.goanywhere.com page: 220

GoAnywhere Web User Commands / Remove Web User IP

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
ipAddress The individual IP address, IP address range, or Yes None
CIDR notation.

page: 221 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Reset Web User Password

Reset Web User Password

Reset a Web User's password for GoAnywhere by using the resetWebUserPassword command.
To manage Web User passwords, authenticate as an Admin User with the Web User Manager role.

NOTE:
The resetWebUserPassword command can only be used when the Web User's Login Method is
GoAnywhere. No other Login Methods are supported.

Response Body

If successful, the response body is empty.

REST
Method & URL
POST http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/resetpassword

Body Sample:

{
    "generatePassword":"false",
    "userPassword" : "a2w4f6l09",
    "forcePasswordChange" : "true",
    "displayPassword" : "false",
    "emailPassword" : "true"
}

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:resetWebUserPassword>
      <userName>kharris</userName>
      <generatePassword>false</generatePassword>
      <userPassword>a2w4f6l09</userPassword>
      <forcePasswordChange>true
      </forcePasswordChange>
      <displayPassword>false</displayPassword>
      <emailPassword>true</emailPassword>
    </web:resetWebUserPassword>
  </soapenv:Body>
</soapenv:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 222

GoAnywhere Web User Commands / Reset Web User Password

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:resetWebUserPasswordResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Web user 'kharris' password successfully reset.</result>
</ns2:resetWebUserPasswordResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for resetting a Web User’s password.

Parameter Name Description Required? Default

Value
userName The Web User account name. Yes None
generatePassword GoAnywhere will generate a password No None
for the Web User.
userPassword Password you supply for the Web User. No None
The password must meet the restrictions
set in the Web User Password Policy.
forcePasswordChange Forces the Web User to change their No None
password on their next log in.
displayPassword Displays the password in the response No None
message.
emailPassword Emails the new password to the Web No None
User.

CLI
The following table lists the available options for resetting a Web User’s password in GoAnywhere
Command using the resetWebUserPassword command.
To manage Web User passwords, log in as a User with the Web User Manager role.

NOTE:
The resetWebUserPassword command can only be used when the Web User's Login Method is
GoAnywhere. No other Login Methods are supported.

EXAMPLE:
The following command will reset a Web User password with a password generated by
GoAnywhere.

page: 223 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Contact

gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere

-command resetwebuserpassword -username jsmith -generatepassword true
-forcepasswordchange true -displaypassword true -emailpassword true

EXAMPLE:
The following command will reset a Web User password with the password 'xyz' supplied from
within the command.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command resetwebuserpassword -username jsmith -userpassword xyz -displaypassword true
-emailpassword true

Parameter Name Description Required? Default

Value
userName The Web User account name. Yes None
generatePassword GoAnywhere will generate a password for No None
the Web User.
userPassword Password you supply for the Web User. No None
The password must meet the restrictions
set in the Web User Password Policy.
forcePasswordChange Forces the Web User to change their No None
password on their next log in.
displayPassword Displays the password in the confirmation No None
message on the command window.
emailPassword Emails the new password to the Web No None
User.

Update Contact
Update a contact to GoAnywhere using the updateContact command.

REST
Method & URL
PUT http://[server URL]:[port]/goanywhere/rest/gacmd/v1/addressBooks/
[addressBookName]/updateContact

Body Sample:

GoAnywhere API Guide www.goanywhere.com page: 224

GoAnywhere Web User Commands / Update Contact

{
    "currentEmail":"kharris@example.com",
    "newEmail":"kharris@support.com"
    "newName" : "Kathy Harris",
    "newOrganization" : "Support",
    "newOfficePhone" : "4024444242",
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:updateContact>
        <currentEmail>kharris@example.com</currentEmail>
        <newEmail>kharris@support.com</newEmail>
        <newName>Kathy Harris</newName>
        <newOrganization>Support</newOrganization>
        <newOfficePhone>4024444242</newOfficePhone>
    </web:updateContact>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body><ns2:updateContactResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Contact 'kharris@example.com' was updated successfully.</result>
</ns2:updateContactResponse>
</S:Body>
</S:Envelope>

The following table lists the available options when updating a contact.

Parameter Description Required? Default

Name Value
currentEmail The current email of the contact. Yes None
newEmail The email to add to the contact. No None
newName The name to add to the contact. No None
newOrganization The organization to add to the contact. No None

page: 225 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Contact

Parameter Description Required? Default

Name Value
newOfficePhone The office phone number to add to the No None
contact.
newCountryName The country name to add to the contact. No None
newMobilePhone The mobile phone number to add to the No None
contact. A country name is required, and the
format of the phone number must match the
mask of the provided country.
newDescription The description to add to the contact. No None

CLI
The following table lists the available options when updating a contact in GoAnywhere Command
using the updateContact command.

EXAMPLE:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command updatecontact -addressbook Support -currentemail kharris@example.com -
neworganization Support

Parameter Description Required? Default

Name Value
addressBook The unique name of the Address Book Yes None
containing the contact.
currentEmail The current email of the contact. Yes None
newEmail The email to add to the contact. No None
newName The name to add to the contact. No None
newOrganization The organization to add to the contact. No None
newOfficePhone The office phone number to add to the No None
contact.
newCountryName The country name to add to the contact. No None
newMobilePhone The mobile phone number to add to the No None
contact. A country name is required, and the
format of the phone number must match the
mask of the provided country.

GoAnywhere API Guide www.goanywhere.com page: 226

GoAnywhere Web User Commands / Update Contact

Parameter Description Required? Default

Name Value
newDescription The description to add to the contact. No None

page: 227 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Virtual File for a Web User

Update Virtual File for a Web User

Update a virtual file in a Web User profile using the updateVirtualFile command.
To update a virtual file in a Web User, authenticate as an Admin User with the Web User Manager
role.

REST
Method & URL
PUT http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/virtualfiles

Body Sample:

{
    "virtualPath" : "/Inbound/Invoices/Qtr1.csv",
    "physicalPath" : "${homeDirectory}/Inbound/Qtr1.csv",
    "permissions" : ["download","overwrite"]
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:updateVirtualFile>
      <userName>kharris</userName>
      <virtualPath>/Inbound/Invoices/Qtr1.csv
      </virtualPath>
      <physicalPath>${homeDirectory}/Inbound
      /Qtr1.csv</physicalPath>
      <permissions>
      <!--Zero or more repetitions:-->
      <permission>download</permission>
      <permission>overwrite</permission>
      </permissions>
    </web:updateVirtualFile>
  </soapenv:Body>
</soapenv:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 228

GoAnywhere Web User Commands / Update Virtual File for a Web User

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateVirtualFileResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual file 'Qtr1.csv' associated to web user 'kharris' was successfully
updated. </result>
</ns2:updateVirtualFileResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for updating a virtual file.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
virtualPath The relative path of the file as it appears to Yes None
Web Users.
physicalPath The physical path to the file that the virtual No None
path refers to. The physical path can contain
the Web User's ${homeDirectory} variable.
permissions The permission allowed for the file. If this No Permissions
parameter is supplied without any values, the are not
permissions are reset using no permissions. changed
Valid values are:

n download
n overwrite
n append
n checksum
n share

CLI
The following table lists the available options for updating a virtual file in GoAnywhere Command
using the updateVirtualFile command.
To update a virtual file in a Web User profile, log in as a User with the Web User Manager role.

EXAMPLE:
The following command will update the permissions on a virtual file in a Web User's profile:

page: 229 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Virtual File for a Web User

gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere

-command updateVirtualFile -username kharris -virtualPath "/Inbound/Invoices/Qtr1.csv"
-permissions download overwrite append share

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the file as it appears to Web Yes None
Users.
physicalPath The physical path to the file that the virtual No None
path refers to. The physical path can contain the
Web User's ${homeDirectory} variable.
permissions The permission allowed for the file, separated No No
by spaces. If this parameter is supplied without Permissions
any values, the permissions are reset using no
permissions. Valid values are:

n download
n overwrite
n append
n checksum
n share

*You must specify either a userName or groupName parameter with this command.

GoAnywhere API Guide www.goanywhere.com page: 230

GoAnywhere Web User Commands / Update Virtual File for a Web User Group

Update Virtual File for a Web User Group

Update a virtual file in a Web User Group using the updateVirtualFile command.
To update a virtual file in a Web User Group, authenticate as an Admin User with the Web User
Manager role.

REST
Method & URL
PUT http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/
[groupName]/virtualfiles

Body Sample:

{
  "virtualPath" : "/Inbound/Invoices/Qtr1.csv",
  "physicalPath" : "${homeDirectory}/
   Inbound/Qtr1.csv",
  "permissions" : ["download","overwrite"]
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:updateVirtualFile>
      <groupName>Trading Partners</groupName>
      <virtualPath>/Inbound/Invoices/
      Qtr1.csv</virtualPath>
      <physicalPath>${homeDirectory}/Inbound/
      Qtr1.csv</physicalPath>
      <permissions>
      <!--Zero or more repetitions:-->
        <permission>download</permission>
        <permission>overwrite</permission>
        </permissions>
      </web:updateVirtualFile>
  </soapenv:Body>
</soapenv:Envelope>

page: 231 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Virtual File for a Web User Group

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateVirtualFileResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual file 'Qtr1.csv' associated to web user group 'Trading Partners' was
successfully updated. </result>
</ns2:updateVirtualFileResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for updating a virtual file.

Parameter Description Required? Default

Name Value
groupName The Web User group name. Yes None
virtualPath The relative path of the file as it appears to Web Yes None
Users.
physicalPath The physical path to the file that the virtual No None
path refers to. The physical path can contain the
Web User's ${homeDirectory} variable.
permissions The permission allowed for the file. If this No Permissions
parameter is supplied without any values, the are not
permissions are reset using no permissions. changed
Valid values are:

n download
n overwrite
n append
n checksum
n share

CLI
The following table lists the available options for updating a virtual file in GoAnywhere Command
using the updateVirtualFile command.
To update a virtual file in a Web User Group, log in as a User with the Web User Manager role.

EXAMPLE:
The following command will update the permissions on a virtual file in a Web User Group:

GoAnywhere API Guide www.goanywhere.com page: 232

GoAnywhere Web User Commands / Update Virtual File for a Web User Group

gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere

-command updateVirtualFile -groupName HTTPSUsers -virtualPath
"/Inbound/Invoices/Qtr1.csv"
-permissions download overwrite append share

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None
virtualPath The relative path of the file as it appears to Yes None
Web Users.
physicalPath The physical path to the file that the virtual No None
path refers to. The physical path can contain
the Web User's ${homeDirectory} variable.
permissions The permission allowed for the file, separated No No
by spaces. If this parameter is supplied without Permissions
any values, the permissions are reset using no
permissions. Valid values are:

n download
n overwrite
n append
n checksum
n share

*You must specify either a userName or groupName parameter with this command.

page: 233 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update a Virtual Folder for a Web User

Update a Virtual Folder for a Web User

Update a virtual folder in a Web User profile using the updateVirtualFolder command.
To update a virtual folder in a Web User profile, authenticate as an Admin User with the Web User
Manager role.

REST
Method & URL
PUT http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]/virtualfolders

Body Sample:

{
  "virtualPath" : "/Inbound/Invoices",
  "physicalPath" : "${homeDirectory}/Inbound",
  "diskQuota" : "10MB"
  "permissions" : ["download","overwrite"]
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:updateVirtualFolder>
      <userName>kharris</userName>
      <virtualPath>/Inbound/Invoices
      </virtualPath>
      <physicalPath>${homeDirectory}
      /Inbound</physicalPath>
      <diskQuota>10MB</diskQuota>
      <permissions>
      <!--Zero or more repetitions:-->
      <permission>download</permission>
      <permission>overwrite</permission>
      </permissions>
    </web:updateVirtualFolder>
  </soapenv:Body>
</soapenv:Envelope>

GoAnywhere API Guide www.goanywhere.com page: 234

GoAnywhere Web User Commands / Update a Virtual Folder for a Web User

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateVirtualFolderResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual folder 'Invoices' associated to web user 'kharris' was successfully
updated. </result>
</ns2:updateVirtualFolderResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for updating a virtual folder.

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes None
virtualPath The relative path of the folder as it appears to Yes None
Web Users.
physicalPath The physical path to the folder that the virtual No None
path refers to. The physical path can contain
the Web User's ${homeDirectory} variable.
diskQuota Specifies the folder disk size limit. Maximum No None
value is 999999 in measurements of KB, MB,
GB, or TB. You can also specify unlimited, or
inherited. When no value is specified, the disk
size limit is not changed. Measurements are
case sensitive, and cannot contain any spaces
between value and measurement.
Example: 100GB

page: 235 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update a Virtual Folder for a Web User

Parameter Description Required? Default

Name Value
permissions The permissions allowed for the folder. If this No Permissions
parameter is supplied without any values, the are not
permissions are reset using no permissions. changed
Valid values are:

n list
n download
n upload
n overwrite
n renameFiles
n deleteFiles
n checksum
n share
n createSubfolders
n renameSubfolders
n deleteSubfolders
n shareSubfolders
n applyToSubfolders
n append

CLI
The following table lists the available options for updating a virtual folder in GoAnywhere
Command using the updateVirtualFolder command. To update a virtual folder in a Web User
profile, log in as a User with the Web User Manager role.

EXAMPLE:
The following command will update the permissions of a virtual folder in a Web User's profile:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command updateVirtualFolder -username kharris -virtualPath "/Inbound/Invoices"
-permissions list download

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None

GoAnywhere API Guide www.goanywhere.com page: 236

GoAnywhere Web User Commands / Update a Virtual Folder for a Web User

Parameter Description Required? Default

Name Value
virtualPath The relative path of the folder as it appears to Yes None
Web Users.
physicalPath The physical path to the folder that the virtual No None
path refers to. The physical path can contain the
Web User's ${homeDirectory} variable.
diskQuota Specifies the folder disk size limit. Maximum No None
value is 999999 in measurements of KB, MB,
GB, or TB. You can also specify unlimited, or
inherited. When no value is specified, the disk
size limit is not changed. Measurements are
case sensitive, and cannot contain any spaces
between value and measurement.
Example: 100GB
permissions The permissions allowed for the folder, No No
separated by spaces. If this parameter is Permissions
supplied without any values, the permissions
are reset using no permissions. Valid values are:

n list
n download
n upload
n overwrite
n renameFiles
n deleteFiles
n checksum
n share
n createSubfolders
n renameSubfolders
n deleteSubfolders
n shareSubfolders
n applyToSubfolders
n append

*You must specify either a userName or groupName parameter with this command.

page: 237 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Virtual Folder for a Web User Group

Update Virtual Folder for a Web User

Group
Update a virtual folder in a Web User Group using the updateVirtualFolder command.
To update a virtual folder in a Web User Group, authenticate as an Admin User with the Web User
Manager role.

REST
Method & URL
PUT http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webgroups/
[groupName]/virtualfolders

Body Sample:

{
  "virtualPath" : "/Inbound/Invoices",
  "physicalPath" : "${homeDirectory}/Inbound",
  "diskQuota" : "10MB"
  "permissions" : ["download","overwrite"]
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:updateVirtualFolder>
      <groupName>Administrators</groupName>
      <virtualPath>/Inbound
      /Invoices</virtualPath>
      <physicalPath>${homeDirectory}
      /Inbound</physicalPath>
      <diskQuota>10MB</diskQuota>
      <permissions>
      <!--Zero or more repetitions:-->
      <permission>download</permission>
      <permission>overwrite</permission>
      </permissions>

GoAnywhere API Guide www.goanywhere.com page: 238

GoAnywhere Web User Commands / Update Virtual Folder for a Web User Group

    </web:updateVirtualFolder>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateVirtualFolderResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Virtual folder 'Invoices' associated to web user group 'Administrators' was
successfully updated. </result>
</ns2:updateVirtualFolderResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for updating a virtual folder.

Parameter Description Required? Default

Name Value
groupName The Web User group name. Yes None
virtualPath The relative path of the folder as it appears to Yes None
Web Users.
physicalPath The physical path to the folder that the virtual No None
path refers to. The physical path can contain
the Web User's ${homeDirectory} variable.
diskQuota Specifies the folder disk size limit. Maximum No None
value is 999999 in measurements of KB, MB,
GB, or TB. You can also specify unlimited, or
inherited. When no value is specified, the disk
size limit is not changed. Measurements are
case sensitive, and cannot contain any spaces
between value and measurement.
Example: 100GB

page: 239 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Virtual Folder for a Web User Group

Parameter Description Required? Default

Name Value
permissions The permissions allowed for the folder. If this No Permissions
parameter is supplied without any values, the are not
permissions are reset using no permissions. changed
Valid values are:

n list
n download
n upload
n overwrite
n renameFiles
n deleteFiles
n checksum
n share
n createSubfolders
n renameSubfolders
n deleteSubfolders
n shareSubfolders
n applyToSubfolders
n append

CLI
The following table lists the available options for updating a virtual folder in GoAnywhere
Command using the updateVirtualFolder command.

EXAMPLE:
The following command will update the permissions of a virtual folder in a Web User Group:
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command updateVirtualFolder -groupName HTTPSUsers -virtualPath "/Inbound/Invoices"
-permissions list download

Parameter Description Required? Default

Name Value
userName The Web User account name. Yes* None
groupName The Web User group name. Yes* None

GoAnywhere API Guide www.goanywhere.com page: 240

GoAnywhere Web User Commands / Update Virtual Folder for a Web User Group

Parameter Description Required? Default

Name Value
virtualPath The relative path of the folder as it appears to Yes None
Web Users.
physicalPath The physical path to the folder that the virtual No None
path refers to. The physical path can contain the
Web User's ${homeDirectory} variable.
diskQuota Specifies the folder disk size limit. Maximum No None
value is 999999 in measurements of KB, MB,
GB, or TB. You can also specify unlimited, or
inherited. When no value is specified, the disk
size limit is not changed. Measurements are
case sensitive, and cannot contain any spaces
between value and measurement.
Example: 100GB
permissions The permissions allowed for the folder, No No
separated by spaces. If this parameter is Permissions
supplied without any values, the permissions
are reset using no permissions. Valid values are:

n list
n download
n upload
n overwrite
n renameFiles
n deleteFiles
n checksum
n share
n createSubfolders
n renameSubfolders
n deleteSubfolders
n shareSubfolders
n applyToSubfolders
n append

*You must specify either a userName or groupName parameter with this command.

page: 241 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Update Web User

The update Web User command allows you to edit Web User profile information. Web User
accounts can also be enabled or disabled using this command. Only values specified will be updated.
To update Web User profiles, authenticate as an Admin User with the Web User Manager role.

REST
Method & URL
PUT http://[server URL]:[port]/goanywhere/rest/gacmd/v1/webusers/
[userName]

Body Sample:

{
  "firstName" : "Kathy",
  "lastName" : "Harris",
  "email" : "kharris@example.com",
  "phoneNumber" : "4029444242",
  "description" : "Web User",
  "servicePermissions" : ['ftp','sftp'],
  "enabled" : "true"
}

Response Body

If successful, the response body is empty.

SOAP
Envelope Sample

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.goanywhere.com/">
  <soapenv:Header/>
  <soapenv:Body>
    <web:updateWebUser>
      <userName>kharris</userName>
      <firstName>Kathy</firstName>
      <lastName>Harris</lastName>
      <email>kharris@example.com</email>
      <description>Web User</description>
      <organization>IT</organization>
      <phone>4029444242</phone>
      <servicePermissions>
      <!--Zero or more repetitions:-->
      <servicePermission>gofast</servicePermission>
      <servicePermission>as2</servicePermission>

GoAnywhere API Guide www.goanywhere.com page: 242

GoAnywhere Web User Commands / Update Web User

      </servicePermissions>
      <enabled>true</enabled>
    </web:updateWebUser>
  </soapenv:Body>
</soapenv:Envelope>

Response Body Sample

<?xml version='1.0' encoding='UTF-8'?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:updateWebUserResponse xmlns:ns2="http://webservice.goanywhere.com/">
<result>Web user 'kharris' was updated successfully.</result>
</ns2:updateWebUserResponse>
</S:Body>
</S:Envelope>

The following table lists the available options for updating a Web User.

Parameter Name Description Required? Default

Value
userName The Web User's account Yes None
name.
firstName The Web User's first name. No None
lastName The Web User's last name. No None
email The Web User's email No None
address.
description A description for the Web No None
User account.
organization A description of the Web No None
User's organization.
phoneNumber The Web User's office No None
phone number.
mobilePhoneNumber The Web User's mobile No None
phone number.
mobilePhoneCountry The country associated No None
with the Web User's
mobile phone number.

page: 243 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
loginMethod The login method to be No None
used for this Web User.
Valid values are *default or
the name of the login
method. If changing the
login method to
GoAnywhere, you may also
need to run the
resetWebUserPassword
command to set the user
password and password
specific options.
allowUserToChangePassword This option makes a No None
Change Password link
available at the top of the
page in the HTTPS Web
Client.
passwordExpirationInterval If authenticating the Web No None
User account against the
GoAnywhere database, the
password expiration
interval determines how
long before a password
expires.
enabled Enable or disable a Web No None
User account.
authCertificateKeyLocation The location of certificates No None
to be used for this Web
User's authentication. Valid
values are keyVault or File.
authCertificateKeyVault The Key Vault that No None
contains the certificates to
be used for authentication.
httpsFingerprint The SHA1 fingerprint of the No None
certificate to use for HTTPS
authentication.

GoAnywhere API Guide www.goanywhere.com page: 244

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
as2Fingerprint The SHA1 fingerprint of the No None
certificate to use for AS2
authentication.
ftpesFingerprint The SHA1 fingerprint of the No None
certificate to use for FTPES
(Explicit SSL)
authentication.
ftpsFingerprint The SHA1 fingerprint of the No None
certificate to use for FTPS
(Implicit SSL)
authentication.
gofastFingerprint The SHA1 fingerprint of the No None
certificate to use for
GoFast authentication.
PeSITFingerprint The PeSIT SHA1 fingerprint No None
for the Web User. Only
specify this option if the
Web User authenticates
using a Certificate.
httpsAuthType The Authentication Type No None
for the HTTPS service.
Valid values are password,
certificate, either, or both.
as2AuthType The Authentication Type No None
for the AS2 service. Valid
values are password,
certificate, either, or both.
ftpesAuthType The Authentication Type No None
for the FTPES service. Valid
values are password,
certificate, either, or both.
ftpsAuthType The Authentication Type No None
for the FTPS service. Valid
values are password,
certificate, either, or both.

page: 245 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
gofastAuthType The Authentication Type No None
for the GoFast service.
Valid values are password,
certificate, either, or both.
pesitAuthType The Authentication Type No None
for the PeSIT service. Valid
values are password,
certificate, either, or both.
sftpAuthType The Authentication Type No None
for the SFTP service. Valid
values are password,
publicKey, either, or both.
httpsTwoFactorAuthType The two factor No None
authentication method for
the HTTPS service. Valid
values are radius, totp,
none, or gotp.
servicePermissions The services this user can No None
access, separated by
spaces. Valid values are
as2, ftp, ftps, gofast, https,
and sftp. Example: ['ftps',
'gofast', 'https']
goDrivePermission The permission to use No None
GoDrive. Valid values are
true or false.
goDriveAccess The level of access to No None
GoDrive. Valid values are
full, or view.

GoAnywhere API Guide www.goanywhere.com page: 246

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
goDriveDiskSpaceLimit Specifies the GoDrive size No None
limit. Maximum value is
9999 in measurements of
KB, MB, GB, or TB.
Measurements are case
sensitive and cannot
contain any spaces
between the value and
measurement. Example:
100GB.
goDriveLinkPermission The permission to create No None
links for GoDrive. Valid
values are true or false.
secureFoldersPermission The permission to use No None
Secure Folders. Valid values
are true or false.
secureFormsPermisson The permission to use No None
Secure Forms. Valid values
are true or false.
sendSecureMailPermission The permission to send No None
Secure Mail. Valid values
are true or false.
sendInvitationsPermission The permission to send No None
invitations for self
registration. Valid values
are true or false.
viewActivityReportPermission The permission to view the No None
activity report. Valid values
are true or false.
maxConcurrentSessions The number of sessions No None
this user can have at one
time. Valid values are
number or *unlimited.

page: 247 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
enableIpFilter The IP Filter can be No None
enabled or disabled at the
individual Web User level.
Valid values are true or
false.
ipFilterType The IP Filter can be No None
configured as a whitelist or
a blacklist. Valid values are
blacklist or whitelist.
accountExpiresOn If you would like the Web No None
User account to expire on a
certain date, enter the date.
If specified, the Web User
will not be able to login on
or after that date. Valid
values are never or Use the
iso date format yyyy-mm-
dd.
limitTimeOfDay To limit the time period in No None
which the Web User can
login. Valid values are
*unlimited or use the 24hr
time format. Example:
0800-1700 will limit login
time from 8 A.M. to 5 P.M.
limitedDays To limit which days of the No None
week the Web User can
login. Valid values are
*unlimited, sun, mon, tue,
wed, thu, fri, and sat.

GoAnywhere API Guide www.goanywhere.com page: 248

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
inactiveDays The Web User account can No None
be disabled after a number
of inactive days. Inactive
days are calculated from
the last login date or the
last date the account was
modified. Valid values are:
*default, *never, or the
number of days after last
login.
as2Id The AS2 ID of the sender No None
(Web User). The AS2 ID is
case sensitive and can be 1
to 128 ASCII printable
characters in length.
as2MessageDecryptionKeyLocation Specify the location for the No None
certificate used to decrypt
the message. Valid values
are keyVault or file.
as2MessageDecryptionKeyVault Specify the Key Vault that No None
contains the certificate.
*default uses the Domains
default Key Vault.
as2MessageDecryptionKeyName Specify the key name of the No None
desired certificate. This is
either the key name or the
certificate alias if using file
based keys.
as2MessageDecryptionKeyPassword Specify the password of the No None
desired certificate.
as2SignatureKeyLocation Specify the location for the
public certificate used to
verify the this Web User's
signature. Valid values are
keyVault or file.

page: 249 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
as2SignatureKeyVault Specify the Key Vault that No None
contains the certificate.
*default uses the Domains
default Key Vault.
as2SignatureKeyName Specify the key name of the No None
desired certificate.
as2DefaultUploadFolder The location where AS2 No None
messages are saved when
received (uploaded). The
default location is the
default home directory for
the Web User. Valid values
are *default, *home, file
path to desired storage
location.
as2WhenFileExists The file action to perform No None
when a file already exists.
Valid values are default,
overwrite, rename, or
append error.
as2RequireEncryption This option indicates No None
whether or not messages
sent by this Web User
must be encrypted. Valid
values are true, false, or
default.
as2RequireSignature A signed message contains No None
a digital signature from the
sender to further
authenticate the message.
If signatures are required,
any unsigned message sent
by this Web User will be
rejected. Valid values are
true, false, or default.

GoAnywhere API Guide www.goanywhere.com page: 250

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
as2RequireAuthentication Require No None
username/password or
certificate authentication
for messages uploads. If
authentication is not
required, GoAnywhere will
use the AS2 ID to identify
the Web User. Valid values
are true, false, or default.
as2AsynchronousMDNApproval If a return receipt is No None
requested by the Web
User, select if the MDN will
be sent automatically
during the Web User's
session or manually after
the message is processed.
Valid values are default,
manual, or automatic.
as2MDNSignatureKeyLocation Specify the location for the No None
certificate used to decrypt
the MDN message. Valid
values are keyVault or file.
as2MDNSignatureKeyVault Specify the Key Vault that No None
contains the signature
certificate. *default uses the
Domains default Key Vault.
as2MDNSignatureKeyName Specify the key name of the No None
desired certificate.
as2MDNSignatureKeyPassword Specify the password of the No None
desired certificate.
as2SignatureAlgorithmFormat The format of the signature No None
algorithm. Valid values are
default, rfc3851, or rfc5751.

page: 251 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
addressBookPersonal Allow the Web User to use No None
the personal address book
in the GoAnywhere Web
Client. Valid values are true
or false.
addressBookRestrictShared Restrict the Web User to No None
using only address books
created and shared by an
admin. Valid values are true
or false.

CLI
The updateWebUser command allows you to edit Web User profile information. Web User
accounts can also be enabled or disabled using this command. Only values specified will be updated.
The following table lists the available options for updating a Web User in GoAnywhere Command.
To update Web User profiles, log in as a User with the Web User Manager role.

EXAMPLE:
The following command will enable a Web User.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command updateWebUser -username jsmith -enabled true

EXAMPLE:
The following command updates Web User profile information.
gacmd.exe -server http://10.1.4.1:8000/goanywhere -user root -password goanywhere
-command updateWebUser -username jsmith -firstName John -lastName Smith -organization
"acme inc" -phoneNumber "402-555-0011" -servicePermissions AS2 FTP FTPS GoFast
HTTPS

Parameter Name Description Required? Default

Value
userName The Web User's account Yes None
name.
firstName The Web User's first name. No None
lastName The Web User's last name. No None

GoAnywhere API Guide www.goanywhere.com page: 252

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
email The Web User's email No None
address.
description A description for the Web No None
User account. Place the
description in double
quotes (" ") to support
spaces.
Example: -description
"trading partner"
organization A description of the Web No None
User's organization. Place
the description in double
quotes (" ") to support
spaces.
Example: -organization
"acme inc"
phoneNumber The Web User's office No None
phone number. Place the
number in double quotes ("
") to support dashes.
Example: -phoneNumber
"402-555-0011"
mobilePhoneNumber The Web User's mobile No None
phone number.
mobilePhoneCountry The country associated No None
with the Web User's
mobile phone number.

page: 253 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
loginMethod The login method to be No None
used for this Web User.
Valid values are *default or
the name of the login
method. If changing the
login method to
GoAnywhere, you may also
need to run the
resetWebUserPassword
command to set the user
password and password
specific options.
allowUserToChangePassword This option makes a No None
Change Password link
available at the top of the
page in the HTTPS Web
Client.
passwordExpirationInterval If authenticating the Web No None
User account against the
GoAnywhere database, the
password expiration
interval determines how
long before a password
expires.
enabled Enable or disable a Web No None
User account.
authCertificateKeyLocation The location of certificates No None
to be used for this Web
User's authentication.
Valid values are keyVault
or file.
authCertificateKeyVault The Key Vault that No None
contains the certificates to
be used for authentication.

GoAnywhere API Guide www.goanywhere.com page: 254

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
httpsFingerprint The SHA1 fingerprint of No None
the certificate to use for
HTTPS authentication.
as2Fingerprint The SHA1 fingerprint of No None
the certificate to use for
AS2 authentication.
ftpesFingerprint The SHA1 fingerprint of No None
the certificate to use for
FTPES (Explicit SSL)
authentication.
ftpsFingerprint The SHA1 fingerprint of No None
the certificate to use for
FTPS (Implicit SSL)
authentication type.
gofastFingerprint The SHA1 fingerprint of No None
the certificate to use for
GoFast authentication.
PeSITFingerprint The PeSIT SHA1 fingerprint No None
for the Web User. Only
specify this option if the
Web User authenticates
using a Certificate.
httpsAuthType The Authentication Type No None
for the HTTPS service.
Valid values are password,
certificate, either, or both.
as2AuthType The Authentication Type No None
for the AS2 service. Valid
values are password,
certificate, either, or both.
ftpesAuthType The Authentication Type No None
for the FTPES service. Valid
values are password,
certificate, either, or both.

page: 255 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
ftpsAuthType The Authentication Type No None
for the FTPS service. Valid
values are password,
certificate, either, or both.
gofastAuthType The Authentication Type No None
for the GoFast service.
Valid values are password,
certificate, either, or both.
pesitAuthType The Authentication Type No None
for the PeSIT service. Valid
values are password,
certificate, either, or both.
sftpAuthType The Authentication Type No None
for the SFTP service. Valid
values are password,
certificate, either, or both.
httpsTwoFactorAuthType The two factor No None
authentication method for
the HTTPS service. Valid
values are radius, totp,
none, or gotp.
servicePermissions The services this user can No None
access, separated by
spaces. Valid values are
as2, ftp, ftps, gofast, https,
and sftp. Example: ftp ftps
sftp
goDrivePermission The permission to use No None
GoDrive. Valid values are
true or false.
goDriveAccess The level of access to No None
GoDrive. Valid values are
full or view.

GoAnywhere API Guide www.goanywhere.com page: 256

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
goDriveDiskSpaceLimit Specifies the GoDrive size No None
limit. Maximum value is
9999 in measurements of
KB, MB, GB, or TB.
Measurements are case
sensitive and cannot
contain any spaces
between the value and
measurement. Example:
100GB
goDriveLinkPermission The permission to create No None
links for GoDrive. Valid
values are true or false.
secureFoldersPermission The permission to use No None
Secure Folders. Valid
values are true or false.
secureFormsPermisson The permission to use No None
Secure Forms. Valid values
are true or false.
sendSecureMailPermission The permission to send No None
Secure Mail. Valid values
are true or false.
sendInvitationsPermission The permission to send No None
invitations for self
registration. Valid values
are true or false.
viewActivityReportPermission The permission to view the No None
activity report. Valid values
are true or false.
maxConcurrentSessions The number of sessions No None
this user can have at one
time. Valid values are
number or *unlimited.

page: 257 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
enableIpFilter The IP Filter can be No None
enabled or disabled at the
individual Web User level.
Valid values are true or
false.
ipFilterType The IP Filter can be No None
configured as a whitelist or
a blacklist. Valid values are
blacklist or whitelist.
accountExpiresOn If you would like the Web No None
User account to expire on a
certain date, enter the date.
If specified, the Web User
will not be able to login on
or after that date. Valid
values are never or Use the
iso date format yyyy-mm-
dd.
limitTimeOfDay To limit the time period in No None
which the Web User can
login. Valid values are
*unlimited or use the 24hr
time format. Example:
0800-1700 will limit login
time from 8 A.M. to 5 P.M.
limitedDays To limit which days of the No None
week the Web User can
login. Valid values are
*unlimited, sun, mon, tue,
wed, thu, fri, and sat.

GoAnywhere API Guide www.goanywhere.com page: 258

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
inactiveDays The Web User account can No None
be disabled after a number
of inactive days. Inactive
days are calculated from
the last login date or the
last date the account was
modified. Valid values are
*default, *never, or the
number of days after last
login.
as2Id The AS2 ID of the sender No None
(Web User). The AS2 ID is
case sensitive and can be 1
to 128 ASCII printable
characters in length.
as2MessageDecryptionKeyLocation Specify the location for the No None
certificate used to decrypt
the message. Valid values
are keyVault or file.
as2MessageDecryptionKeyVault Specify the Key Vault that No None
contains the certificate.
*default uses the Domains
default Key Vault.
as2MessageDecryptionKeyName Specify the key name of the No None
desired certificate. This is
either the key name or the
certificate alias if using file
based keys.
as2MessageDecryptionKeyPassword Specify the password of the No None
desired certificate.
as2SignatureKeyLocation Specify the location for the No None
public certificate used to
verify the this Web User's
signature. Valid values are
keyVault or file.

page: 259 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
as2SignatureKeyVault Specify the Key Vault that No None
contains the certificate.
*default uses the Domains
default Key Vault.
as2SignatureKeyName Specify the key name of the No None
desired certificate.
as2DefaultUploadFolder The location where AS2 No None
messages are saved when
received (uploaded). The
default location is the
default home directory for
the Web User. Valid values
are *default, *home, file
path to desired storage
location.
as2WhenFileExists The file action to perform No None
when a file already exists.
Valid values are default,
overwrite, rename, or
append error.
as2RequireEncryption This option indicates No None
whether or not messages
sent by this Web User
must be encrypted. Valid
values are true, false, or
default.
as2RequireSignature A signed message contains No None
a digital signature from the
sender to further
authenticate the message.
If signatures are required,
any unsigned message sent
by this Web User will be
rejected. Valid values are
true, false, or default.

GoAnywhere API Guide www.goanywhere.com page: 260

GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
as2RequireAuthentication Require No None
username/password or
certificate authentication
for messages uploads. If
authentication is not
required, GoAnywhere will
use the AS2 ID to identify
the Web User. Valid values
are true, false, or default.
as2AsynchronousMDNApproval If a return receipt is No None
requested by the Web
User, select if the MDN will
be sent automatically
during the Web User's
session or manually after
the message is processed.
Valid values are default,
manual, or automatic
as2MDNSignatureKeyLocation Specify the location for the No None
certificate used to decrypt
the MDN message. Valid
values are keyVault or file.
as2MDNSignatureKeyVault Specify the Key Vault that No None
contains the signature
certificate. *default uses
the Domains default Key
Vault.
as2MDNSignatureKeyName Specify the key name of the No None
desired certificate.
as2MDNSignatureKeyPassword Specify the password of the No None
desired certificate.
as2SignatureAlgorithmFormat The format of the signature No None
algorithm. Valid values are
default, rfc3851, or
rfc5751.

page: 261 www.goanywhere.com GoAnywhere API Guide

 GoAnywhere Web User Commands / Update Web User

Parameter Name Description Required? Default

Value
addressBookPersonal Allow the Web User to use No None
the personal address book
in the GoAnywhere Web
Client. Valid values are true
or false.
addressBookRestrictShared Restrict the Web User to No None
using only address books
created and shared by an
admin. Valid values are
true or false.

GoAnywhere API Guide www.goanywhere.com page: 262

Dashboard Gadget Commands / Active Jobs

Dashboard Gadget Commands

The GoAnywhere MFT Dashboard provides 26 Gadgets that allow administrators to quickly display
vital GoAnywhere statistics and activity. The data provided in the Dashboard can be accessed by
using REST Get requests.

Active Jobs
Returns details for the active Jobs in the queue.
To retrieve active job details, authenticate as an Admin User with the Job Manager or Project
Executor role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/jobs/active

JSON Output Sample:

{
  "data":
[
{    
      "jobNumber": 10000000000110,
      "startTime" : "03-21-17 03:03:11 PM",
      "project" : "Daily Transfer"
      }
    ]
}

Active Sessions - Detail

Returns the service, IP address, user, device, and connection information for each active session.
To retrieve active session details, authenticate as an Admin User with the Product Administrator
role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/services/sessions

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/services/sessions?servic
es=1&max_rows=20

page: 263 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Active Sessions - Summary

The following table lists the available query parameters when getting Active Sessions.

Parameter Description Required? Default

Name Value
services The GoAnywhere Services that will be returned No All
from the request. Valid values are:

l 1 - returns HTTPS sessions

l 2 - returns FTP sessions
l 4 - returns FTPS sessions
l 8 - returns SFTP sessions
l 16 - returns AS2 sessions
l 32 - returns GoFast sessions
l 64 - returns Agent sessions
l 128 - returns Admin sessions
max_rows The number of records that will be returned. No 5

JSON Output Sample:

{
 "data:"
[
{
    "service": "https",
    "userName": "kharris",
    "remoteAddress": "0:0:0:0:0:0:0:1",
    "gateway": true,
    "localAddress": "0:0:0:0:0:0:0:1",
    "localPort": 443,
    "bytesSent": 0,
    "bytesReceived": 0
     }
  ]
}

Active Sessions - Summary

Returns the number of active sessions by service.
To retrieve sessions summary details, authenticate as an Admin User with the Product
Administrator role.

GoAnywhere API Guide www.goanywhere.com page: 264

Dashboard Gadget Commands / Cluster Information

REST Method & URL

GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/services/sessions/summary

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/services/sessions/summar
y?service=1

The following table lists the available query parameters when getting sessions summary details.

Parameter Description Required? Default

Name Value
service Specify the GoAnywhere modules that will be No All
included in the service statistics. Valid values are:

l 1 - HTTPS
l 2 - FTP
l 4 - FTPS
l 8 - SFTP
l 16 - AS2
l 32 - GoFast
l 64 - Agent
l 128 - Admin

JSON Output Sample:

{
 "data:"
[
{
    "sessionCount": "1",
    "serviceName": "HTTPS"
     }
  ]
}

Cluster Information
Returns the status of all nodes in a cluster.
To retrieve cluster details, authenticate as an Admin User with the Product Administrator role.
REST Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/system/cluster

page: 265 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Completed Jobs - Summary

JSON Output Sample:

{
  "data":
[
{
      "name":"prod_01",
      "role" : "Participant",
      "address" : "10.1.2.43",
      "port" : "8006",
      "status" : "Active",
      "statusLastUpdated" : "04-19-2012 02:47:50 PM"
    }
  ]
}

Status Values for Clusters:

l Active
l Inactive

Completed Jobs - Summary

Returns the number of completed Jobs for the specified date range.
To retrieve completed Jobs details, authenticate as an Admin User with the Auditor, Job Manager,
or Project Executor role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/jobs/completed/summary

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/jobs/completed/
summary?date_range=1&status=2

The following table lists the available query parameters when getting the Completed Jobs
Summary.

GoAnywhere API Guide www.goanywhere.com page: 266

Dashboard Gadget Commands / Expiring OpenPGP Keys

Parameter Description Required? Default

Name Value
date_range The scope of the statistics based on date and No Today
time. Valid values are:

l 1 - today (default value)

l 2 - yesterday
l 7 - last 7 days
l 30 - last 30 days
l 90 - last 90 days
l 180 - last 180 days
l 365 - last 365 days
group_by Determines how the statistics are grouped by. No Hour
Valid values are:

l 1 - hour (default value)

l 2 - day of week
l 3 - day of month
l 4 - month
status Narrow the results by Job Status. Valid values No All
are:

l 2 - success
l 4 - failed
l 8 - canceled

JSON Output Sample:

{
  "data" :
[
{
        "label":"0",
        "count" : 50
      }
    ]
}

Expiring OpenPGP Keys

Returns OpenPGP keys that are set to expire.

page: 267 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Expiring SSL Certificates

To retrieve expiring OpenPGP key details, authenticate as an Admin User with the Key Manager
role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/system/pgpkeys/expiring

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/system/pgpkeys/expiring?
date_range=365

The following table lists the available query parameters when getting Expiring OpenPGP keys.

Parameter Description Required? Default

Name Value
date_range The scope of the statistics based on date and No Next 30
time. Valid values are: Days

l 1 - today
l 2 - tomorrow
l 7 - next 7 days
l 30 - next 30 days (default value)
l 90 - next 90 days
l 180 - next 180 days
l 365 - next 365 days

JSON Output Sample:

{
  "data" :
[
{
     "keyID":"3121459703709493829",
     "userName" : "File Encryption 
         \u003ckharris@example.com\u003e",
     "expiresOn" : "06-01-2017 11:59:58 PM"
     }
    ]
}

Expiring SSL Certificates

Returns SSL Certificates that are set to expire.

GoAnywhere API Guide www.goanywhere.com page: 268

Dashboard Gadget Commands / File Transfer - Summary

To retrieve expiring SSL Certificate details, authenticate as an Admin User with the Key Manager
role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/system/certificates/expiring

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/system/certificates/expi
ring?date_range=365

The following table lists the available query parameters when getting expiring SSL Certificates.

Parameter Description Required? Default

Name Value
date_range The scope of the statistics based on date and No Next 30
time. Valid values are: Days

l 1 - today
l 2 - tomorrow
l 7 - next 7 days
l 30 - next 30 days (default value)
l 90 - next 90 days
l 180 - next 180 days
l 365 - next 365 days

JSON Output Sample:

{
  "data" :
[
{
      "alias":"secure file transfer",
      "subject" : "www.example.com",
      "expiresOn" : "06-01-2017 11:59:58 PM"
    }
  ]
}

File Transfer - Summary

Returns the number of file transfers for a specified service.
To retrieve file transfer summary details, authenticate as an Admin User with the Auditor role.

page: 269 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / File Transfer - Summary

REST Method & URL

GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/filetransfers/summary

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/filetransfers/s
ummary?module=1&date_range=365

The following table lists the available query parameters when getting File Transfer statistics.

Parameter Description Required? Default

Name Value
module Specify the GoAnywhere modules that will be No All
included in the file transfer statistics. Valid values
are:

l 1 - AS2
l 2 - FTP
l 4 - FTPS
l 8 - SFTP
l 16 - GoFast
l 32 - GoDrive
l 64 - Projects
l 128 - Secure Folders
l 256 - Secure Forms
l 512 - Triggers
l 1024 - Secure Mail
date_range The scope of the statistics based on date and time. No Today
Valid values are:

l 1 - today
l 2 - yesterday
l 7 - last 7 days
l 30 - last 30 days
l 90 - last 90 days
l 180 - last 180 days
l 365 - last 365 days

GoAnywhere API Guide www.goanywhere.com page: 270

Dashboard Gadget Commands / Gateway Information

Parameter Description Required? Default

Name Value
group_by Determines how the statistics are grouped by. Valid No Hour
values are:

l 1 - hour (default value)

l 2 - day of week
l 3 - day of month
l 4 - month

JSON Output Sample:

{
  "data" :
[
{
    "label":"0",
    "count" : 100
    }
   ]
}

Gateway Information
Returns information about GoAnywhere Gateway.
To retrieve Gateway details, authenticate as an Admin User with the Product Administrator role.
REST Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/system/gateway

JSON Output Sample:

{
 "data:"
[
{
    "enabled": "true",
    "address" : "10.1.2.43",
       "status": "CONNECTED",
    "activeProxies": 4
     }
  ]
}

page: 271 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Job Statistics

Status Values for Gateways:

l CONNECTING
l CONNECTED
l DISCONNECTING
l DISCONNECTED
l RETRYING

Job Statistics
Returns the number of active, completed, failed, or canceled jobs for the specified date range.
To retrieve Job Statistic details, authenticate as an Admin User with the Auditor, Job Manager, or
Project Executor role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/jobs/statistics

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/jobs/statistics
?date_range=180

The following table lists the available query parameters when getting Job Statistics.

Parameter Description Required? Default

Name Value
date_range The scope of the statistics based on date and No Today
time. Valid values are:

l 1 - today (default value)

l 2 - yesterday
l 7 - last 7 days
l 30 - last 30 days
l 90 - last 90 days
l 180 - last 180 days
l 365 - last 365 days

JSON Output Sample:

{
 "data:"
[

GoAnywhere API Guide www.goanywhere.com page: 272

Dashboard Gadget Commands / Recent Blacklisted IP Addresses - Detail

{
    "activeCount": 400,
    "successfulCount": 1000000,
    "failedCount": 0,
    "canceledCount": 15
     }
  ]
}

Recent Blacklisted IP Addresses - Detail

Returns recently blacklisted IP addresses.
To retrieve Blacklisted IP Address details, authenticate as an Admin User with the Security Officer
role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/system/ips/blacklisted

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/system/ips/blacklisted?d
ate_range=30

The following table lists the available query parameters when getting Recent Blacklisted
IP Addresses.

Parameter Description Required? Default

Name Value
date_range The scope of the statistics based on date and No Last 7
time. Valid values are: Days

l 1 - today
l 2 - yesterday
l 7 - last 7 days (default value)
l 30 - last 30 days
max_rows The number of records that will be returned. No 5

JSON Output Sample:

{
 "data:"
[
{
    "remoteAddress": "10.1.1.205",

page: 273 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Recent Completed Jobs

    "reason": "Brute-force",
    "date": "02-28-17 08:40:10 AM"
     }
  ]
}

Recent Completed Jobs

Returns the most recent completed Jobs and their completion status.
To retrieve completed Jobs details, authenticate as an Admin User with the Auditor, Job Manager,
or Project Executor role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/jobs/completed

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/jobs/completed?
status=2

The following table lists the available query parameters when getting recently completed Jobs.

Parameter Description Required? Default

Name Value
status Narrow the results by Job Status. Valid No All
values are:

l 2 - success
l 4 - failed
l 8 - canceled
max_rows The number of records that will be No 5
returned.

JSON Output Sample:

{
 "data:"
[
{
    "jobNumber": "100000000016",
    "status": "S",
    "project": "Call Agent Project",
    "userName": "root",
    "endTime": "3/28/17 4:02:00 PM"

GoAnywhere API Guide www.goanywhere.com page: 274

Dashboard Gadget Commands / Recent File Activity

     }
  ]
}

Recent File Activity

Returns the recent files that have been transferred, the module that was used to transfer the files,
and the user who initiated the transfer.
To retrieve recent file activity details, authenticate as an Admin User with the Auditor role.
REST Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/activity/file

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/file?status=2&m
odule=256

The following table lists the available query parameters when getting recent file activity.

Parameter Description Required? Default

Name Value
status Narrow the results by transfer status. Valid values No All
are:

l 2 - success
l 4 - failed
l 8 - warning

page: 275 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Recent File Activity

Parameter Description Required? Default

Name Value
module Specify the GoAnywhere modules that will be No All
included in the file transfer statistics. Valid values
are:

l 1 - AS2
l 2 - FTP
l 4 - FTPS
l 8 - SFTP
l 16 - GoFast
l 32 - GoDrive
l 64 - Projects
l 128 - Secure Folders
l 256 - Secure Forms
l 512 - Triggers
l 1024 - Secure Mail
max_rows The number of records that will be returned. No 5

JSON Output Sample:

{
 "data:"
[
{
    "filePath": "W:\\gamft\\userdata\\packages\\2017-04-12
    \\3f8a0d00-63ca-4a57-b272-dcb1283b8539\\image001.png",
    "status": "Successful",
    "activity": "Download Attachment",
    "moduleName": "Secure Mail",
    "userName": "kharris",
     }
  ]
}

Status Values for File Activity:

l Warning
l Failed
l Successful

GoAnywhere API Guide www.goanywhere.com page: 276

Dashboard Gadget Commands / Recent Secure Mail Activity

Recent Secure Mail Activity

Returns recent Secure Mail activity, the recipient of the Secure Mail message, and the message
status.
To retrieve Recent Secure Mail details, authenticate as an Admin User with the Secure Mail
Manager role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/securemail

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/securemail?max_
rows=20

The following table lists the available query parameters when getting recent Secure Mail activity.

Parameter Description Required? Default

Name Value
max_rows The number of records that will be No 5
returned.

JSON Output Sample:

{
 "data:"
[
{
    "userName": "kharris",
    "date": "04-12-2017 01:50:08 PM",
    "toAddress": "tim@example.com",
    "ccAddress": "mhatfield@example.com",
    "bccAddress": "kathy.harris@goanywhere.com",
    "status": "Active"
     }
  ]
}

Recent Triggers
Returns recent Trigger activity and the status of the Trigger event.
To retrieve recent Trigger details, authenticate as an Admin User with the Auditor or Trigger
Manager role.

page: 277 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Recent Web User Activity

REST Method & URL

GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/triggers

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/triggers?status
=2

The following table lists the available query parameters when getting Recent Triggers.

Parameter Description Required? Default

Name Value
status Narrow the results by status. Valid values No All
are:

l 1 - active
l 2 - success
l 4 - failed
max_rows The number of records that will be No 5
returned.

JSON Output Sample:

{
 "data:"
[
{
    "name": "File Upload Trigger",
    "date": "04-19-2017 02:50:15 PM",
    "event": "Upload Successful",
    "status": "S"
     }
  ]
}

Status Values for Triggers:

l A - Active
l S - Successful
l F - Failed

Recent Web User Activity

Returns recent Web User activity, the modules impacted, and the status of the activity.
To retrieve recent Web User activity details, authenticate as an Admin User with the Auditor role.

GoAnywhere API Guide www.goanywhere.com page: 278

Dashboard Gadget Commands / Recent Web User Activity

REST Method & URL

GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/webusers

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/webusers?status
=2&module=1

The following table lists the available query parameters when getting recent Web User activity.

Parameter Description Required? Default

Name Value
status Narrow the results by status. Valid values are: No All

l 2 - success
l 4 - failed
l 8 - warning
module Specify the GoAnywhere modules that will be No All
included in the Web User statistics. Valid values
are:

l 1 - AS2
l 2 - FTP
l 4 - FTPS
l 8 - SFTP
l 16 - GoFast
l 32 - GoDrive
l 128 - Secure Folders
l 256 - Secure Forms
l 1024 - Secure Mail
max_rows The number of records that will be returned. No 5

JSON Output Sample:

{
 "data:"
[
{
    "userName": "kharris",
    "date": "04-19-2017 02:50:15 PM",
    "activity": "Upload",
    "module": "Secure Folders",

page: 279 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Recent Web User Logins

    "status": "Successful"
     }
  ]
}

Status Values for Web User Activity:

l Warning
l Failed
l Successful

Recent Web User Logins

Returns the most recent Web User Logins, the date and time the Web User logged in, the service
they logged in to, and the status of the login attempt.
To retrieve recent Web User login details, authenticate as an Admin User with the Web Users
Manager role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/webusers/logins

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/webusers/logins
?status=2

The following table lists the available query parameters when getting recent Web User logins.

Parameter Description Required? Default

Name Value
status Narrow the results by status. Valid values are: No All

l 2 - success
l 4 - failed
l 8 - warning

GoAnywhere API Guide www.goanywhere.com page: 280

Dashboard Gadget Commands / Service Statistics - Inbound Connections

Parameter Description Required? Default

Name Value
service Specify the GoAnywhere modules that will be No All
included in the Web User statistics. Valid values are:

l 1 - HTTPS
l 2 - FTP
l 4 - FTPS
l 8 - SFTP
l 16 - AS2
l 32 - GoFast
max_rows The number of records that will be returned. No 5

JSON Output Sample:

{
 "data:"
[
{
    "userName": "kharris",
    "firstName": "Kathy",
    "lastName": "Harris,
    "status": "S",
    "service": "HTTPS",
    "loggedOn": "04-13-2017 02:33:33 PM"
     }
  ]
}

Status Values for Web User Logins:

l W - Warning
l F - Failed
l S - Successful

Service Statistics - Inbound Connections

Returns upload and download file transfer activity for services.
To retrieve service statistics, authenticate as an Admin User with the Auditor role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/services/statistics

page: 281 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Service Statistics - Inbound Connections

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/services/statistics?dat
e_range=365&service=1

The following table lists the available query parameters when getting service statistics.

Parameter Description Required? Default

Name Value
date_range The scope of the statistics based on date and time. No Today
Valid values are:

l 1 - today (default value)

l 2 - yesterday
l 7 - last 7 days
l 30 - last 30 days
l 90 - last 90 days
l 180 - last 180 days
l 365 - last 365 days
service Specify the GoAnywhere modules that will be No All
included in the service statistics. Valid values are:

l 1 - HTTPS
l 2 - FTP
l 4 - FTPS
l 8 - SFTP
l 16 - AS2
l 32 - GoFast

JSON Output Sample:

{
 "data:"
[
{
    "uploads": 260,
    "downloads": "3000"
     }
  ]
}

GoAnywhere API Guide www.goanywhere.com page: 282

Dashboard Gadget Commands / Service Status

Service Status
Returns the status and active sessions for each file transfer service.
To retrieve service details, authenticate as an Admin User with the Product Administrator role.
REST Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/services/status

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/services/status?services
=1

The following table lists the available query parameters when getting service information.

Parameter Description Required? Default

Name Value
services Specify the GoAnywhere modules that will be No All
included in the service statistics. Valid values are:

l 1 - HTTPS
l 2 - FTP
l 4 - FTPS
l 8 - SFTP
l 16 - AS2
l 32 - GoFast

JSON Output Sample:

{
 "data:"
[
{
    "service": "https",
    "status": "STARTED",
    "activeSessions": "1"
     }
  ]
}

page: 283 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / System Information

Status Values for Services:

l STARTING
l STOPPING
l STARTED
l STOPPED

System Information
Returns system information and GoAnywhere license details.
To retrieve system and license information, authenticate as an Admin User with the Product
Administrator role.
REST Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/system/info

JSON Output Sample:

{
 "data:"
[
{
    "productVersion": "5.5.0",
    "operatingSystem": "Windows",
    "javaVersion": "1.7.0_60",
    "licenseInfo": {
        "licenseType": "PERM",
        "createdOn": "03-22-2017 12:00:00 AM",
        "expiresOn": "03-22-2018 12:00:00 AM",
        "activatedOn": "03-22-2017 12:00:00 AM",
        "activatedBy": "Sample User",
        "serverID": "ZZZZ-ZZZZ-ZZZZ-ZZZZ",
        "features": 
[
{ "name": "Advanced Workflows",
                 "description": "GoAnywhere Advanced
                  Workflow tasks"
               }
                 ]            
              }
     }
  ]
}

System Status
Returns system memory use information. All memory statistics are in megabytes (MB).

GoAnywhere API Guide www.goanywhere.com page: 284

Dashboard Gadget Commands / Top GoDrive Users by Disk Usage

To retrieve system information details, authenticate as an Admin User with the

Product Administrator role.
REST Method & URL
GET http://[server URL]:[port]/goanywhere/rest/gacmd/v1/system/status

JSON Output Sample:

{
 "data:"
[
{
    "heapMemoryUsed": 191,
    "heapMemoryCommitted": 415,
    "heapMemoryInitial": 253,
    "heapMemoryMaximum": 1820,
    "nonHeapMemoryUsed": 83,
    "nonHeapMemoryCommitted": 83,
    "nonHeapMemoryInitial": 23,
    "nonHeapMemoryMaximum": 432,
       "activeThreadCount": 82,
    "peakThreadCount": 87
     }
  ]
}

Top GoDrive Users by Disk Usage

Returns the Web Users who have the most files stored in GoDrive.
To retrieve top GoDrive Web User details, authenticate as an Admin User with the GoDrive
Manager role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/webusers/godrive/disk

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/webusers/godriv
e/disk?max_rows=50

The following table lists the available query parameters when getting top GoDrive users by disk
usage.

Parameter Description Required? Default

Name Value
max_rows The number of records that will be No 5
returned.

page: 285 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Top Secure Mail Packages by Size

JSON Output Sample:

{
 "data:"
[
{
    "userName": "kharris",
    "firstName": "Kathy",
    "lastName": "Harris",
    "diskUsage": "2.62 GB"
     }
  ]
}

Top Secure Mail Packages by Size

Returns the Web Users who have the largest Secure Mail Packages, and the recipient's email
address where the Package was sent.
To retrieve the top Secure Mail Packages by size, authenticate as an Admin User with the Secure
Mail Manager role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/securemail/size

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/securemail/size
?max_rows=10

The following table lists the available query parameters when getting the top Secure Mail Packages
by size.

Parameter Description Required? Default

Name Value
max_rows The number of records that will be No 5
returned.

JSON Output Sample:

{
 "data:"
[
{
    "userName": "kharris",
    "toAddress": "jsmith@example.com",
    "ccAddress": "mhatfield@example.com",
    "bccAddress": "kathy.harris@goanywhere.com",

GoAnywhere API Guide www.goanywhere.com page: 286

Dashboard Gadget Commands / Top Secure Mail Users by Disk Usage

    "status": "Active",
    "size": "71.13 MB"
     }
  ]
}

Top Secure Mail Users by Disk Usage

Returns the Web Users who utilize the largest amount of file storage in Secure Mail.
To retrieve Secure Packages by disk usage details, authenticate as an Admin User with the Secure
Mail Manager role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/securemail/disk

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/securemail/disk
?max_rows=100

The following table lists the available query parameters when getting the top Secure Packages by
disk usage.

Parameter Description Required? Default

Name Value
max_rows The number of records that will be No 5
returned.

JSON Output Sample:

{
 "data:"
[
{
    "userName": "kharris",
    "firstName": "Kathy",
    "lastName": "Harris",
    "diskUsage": "90.87 MB"
     }
  ]
}

page: 287 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Top Web Users by Transfers

Top Web Users by Transfers

Returns the Web Users who have the most file upload and download activity across each of the
selected modules.
To retrieve top Web Users by transfer details, authenticate as an Admin User with the Web Users
Manager role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/webusers/transfers

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/webusers/transf
ers?date_range=365

The following table lists the available query parameters when getting the top Web Users by
transfer.

Parameter Description Required? Default

Name Value
transfer_ The type of file transfer to return, either upload or No All
type download. Valid values are:

l 1 - upload
l 2 - download

GoAnywhere API Guide www.goanywhere.com page: 288

Dashboard Gadget Commands / Top Web Users by Transfers

Parameter Description Required? Default

Name Value
module Specify the GoAnywhere modules that will be No All
included in the file transfer statistics. Valid values
are:

l 1 - AS2
l 2 - FTP
l 4 - FTPS
l 8 - SFTP
l 16 - GoFast
l 32 - GoDrive
l 64 - Projects
l 128 - Secure Folders
l 256 - Secure Forms
l 512 - Triggers
l 1024 - Secure Mail
date_range The scope of the statistics based on date and time. No Today
Valid values are:

l 1 - today
l 2 - yesterday
l 7 - last 7 days
l 30 - last 30 days
l 90 - last 90 days
l 180 - last 180 days
l 365 - last 365 days
summarize_ Determines how the statistics are summarized. No Number
by Valid values are: of
Transfers
l 1 - Number of Transfers (default value)
l 2 - Bytes Transferred
max_rows The number of records that will be returned. No 5

JSON Output Sample:

page: 289 www.goanywhere.com GoAnywhere API Guide

 Dashboard Gadget Commands / Unresolved Jobs

 "data:"
[
{
    "userName": "kharris",
    "firstName": "Kathy",
    "lastName": "Harris",
    "transfers": 41
     }
  ]
}

Unresolved Jobs
Returns the failed or canceled Jobs that have not been marked Resolved from the Completed Jobs
page.
To retrieve unresolved Job details, authenticate as an Admin User with the Auditor, Job Manager,
or Project Executor role.
REST Method & URL
GET http://[server URL]:
[port]/goanywhere/rest/gacmd/v1/activity/jobs/unresolved

REST URL Example with Query Parameters

http://10.1.2.43:8000/goanywhere/rest/gacmd/v1/activity/jobs/unresolved
?date_range=365

The following table lists the available query parameters when getting unresolved Jobs.

Parameter Description Required? Default

Name Value
status Narrow the results by Job status. Valid values No All
are:

l 4 - failed
l 8 - canceled

GoAnywhere API Guide www.goanywhere.com page: 290

Dashboard Gadget Commands / Unresolved Jobs

Parameter Description Required? Default

Name Value
date_range The scope of the statistics based on date and No Last 7
time. Valid values are: days

l 1 - today
l 2 - yesterday
l 7 - last 7 days (default value)
l 30 - last 30 days
l 90 - last 90 days
l 180 - last 180 days
l 365 - last 365 days
max_rows The number of records that will be returned. No 5

JSON Output Sample:

{
 "data:"
[
{
    "jobNumber": 1000000000011,
    "status": "F",
    "project": "Daily Transfer",
    "userName": "root",
    "endTime": "3/21/17 3:03:11 PM"
     }
  ]
}

Status Values for Unresolved Jobs:

l F - Failed
l C - Canceled

page: 291 www.goanywhere.com GoAnywhere API Guide