COMMAND.31 Modify FTP configuration

Overview

This command is used to modify a FTP configuration.

URI

/catramms/v1/conf/ftp/:confKey

Method

PUT

URL Params

Required

• confKey: configuration key to be modified
  • Example: 4

Optional

None

Payload Data

It is a JSON containing the following fields:

• Label: the new name of this configuration
• Server:
• Port:
• UserName:
• Password:
• RemoteDirectory:

Success Response

Code

200 OK

Content

The API returns the confKey identifying the configuration.

{ 
    "confKey": 8
}

Error Response

See Common Error Responses

Sample Call

Assuming:

• UserKey: 5
• APIKey: SU1.8ZO1O2zVeBMNv9lzZ0whABXSAdjWrR~rpcnI5eaHNO2gysrNdAv8BNoWZB1eLP
• configurationMetadata.json is a file containing the metadata about the FTP configuration.
• confKey: 4, the key of the configuration to be modified

curl -k -v -X PUT -u 5:SU1.8ZO1O2zVeBMNv9lzZ0whABXSAdjWrR~rpcnI5eaHNO2gysrNdAv8BNoWZB1eLP -d @configurationMetadata.json -H "Content-Type: application/json" https://mms-api.catrasoft.cloud/catramms/v1/conf/ftp/4