REST API Reference

Back Next

Encrypt and transfer files

Encrypt and transfer files from the source location to a remote server using connectors or to the directory specified in the REST API param within the remote server's home directory. You can encrypt single or multiple files.

POST Request

To encrypt and transfer files, include the connection ID in the following URI.

mftsaas/api/v1/filetransferTask/execute/1001

Include the following information in the request:

Field	Type	Required	Description
agentGroupId	String	Yes	The ID of the agent group.
connectionId	String	Yes	The connection ID of the Advanced FTP, Advanced FTPS, or Advanced SFTP V2 connector.
portalUser	String	-	Whether the user is a portal user. Default is false.
relativeTargetLocation	String	-	The relative target location within the remote server home directory.
pattern	String	Yes	The file pattern to identify the files to collect for encryption. The regular expression pattern is supported.
sourceLocation	String	Yes	The source directory that contains the files you want to encrypt.
SIGN	String	-	Whether the file is signed by PGP. The values are not case sensitive. Default is false.
PUBLIC_KEY_ID	String	Yes	The ID of the key that is used to encrypt the file.
SECRET_KEY_ID	String	Yes	The ID of the secret key that is used to sign the file, if the value of the SIGN variable is true.
SECRET_KEY_PASSPHRASE	String	Yes	The passphrase used to access the secret key if the value of the SIGN variable is true.

For example, to encrypt and transfer a file, you might use the following request:

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1001
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
    "agentGroupId": "01000125000000000002",
    "portalUser": "false",
     "connectionId": "0100010B000000000002",
    "pattern":"arun.txt",
    "relativeTargetLocation":"/",
    "sourceLocation":"C:\\FIS_Home\\DOCSTORE",  
    "taskVariables": {
    	"SIGN":"true",
        "PUBLIC_KEY_ID":"0x51986F687ADACBE1",
        "SECRET_KEY_ID":"0x51986F687ADACBE1",
        "SECRET_KEY_PASSPHRASE":"TESTER"
    }
}

POST Response

If successful,

IDMC

returns the run ID for the job. Use the run ID to monitor the job status.

The following example shows a successful response:

{
        "projectId": 0,
    "timeTaken": 0,
    "queuePriority": 0,
    "runPriority": 0,
    "runMode": "UNKNOWN",
    "submitSourceId": -1,
    "runModeInteractive": false,
    "runModeBatch": false,
    "runModeDebug": false,
    "runModeUnknown": true,
    "formattedTimeTaken": "0.00",
    "id": 1000000007165,
    "runId": 24
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Encrypt and transfer files

Encrypt and transfer files

POST Request

POST Response