Update the SFTP properties on the server
put
/mftapp/rest/v1/artifacts/sftpProperties
Request
Supported Media Types
- application/json
Header Parameters
-
location: string
Relative URL of the update SFTP properties event.
Root Schema : schema
Type:
Show Source
object
-
enableSftp(optional):
boolean
Whether to enable the sFTP server.
-
keyAlias(optional):
string
-
privateKeyPassword(optional):
string
Example Request (application/json)
{
"enableSftp":"true",
"keyAlias":"aliasName",
"privateKeyPassword":"password"
}
Response
Supported Media Types
- application/json
201 Response
SFTP properties were updated.
500 Response
Root Schema : schema
Type:
Show Source
object
-
errorCode(optional):
string
The error code that Oracle Managed File Transfer returns.
-
errorKey(optional):
string
The error key that Oracle Managed File Transfer returns.
-
errorMessage(optional):
string
A message describing the error that Oracle Managed File Transfer returns.
Example Response (application/json)
{
"errorCode":"MFT-6036",
"errorKey":"MFT_CSF_KEY_DOES_NOT_EXIST_EXCEPTION",
"errorMessage":"Key not found for the given key alias aliasName in credential store."
}
Examples
The following example shows how to update the SFTP properties on the server by submitting a PUT request on the REST resource using cURL.
curl -i -X PUT -u <username>:<password> -H "Content-type: application/json" -d '{"enableSftp":"true", "keyAlias":"test_modify_key", "privateKeyPassword":"password"}' http://host:port/mftapp/rest/v1/artifacts/sftpProperties