REST API for Oracle Managed File Transfer

Update the SFTP properties on the server

put

/mftapp/rest/v1/artifacts/sftpProperties

Updates the SFTP properties on the server.

Request

Supported Media Types

application/json

Header Parameters

location(required): string

Relative URL of the update SFTP properties event.

Root Schema : schema

Type: object

Show Source

enableSftp: boolean

Whether to enable the sFTP server.
keyAlias: string
privateKeyPassword: string

{
    "type":"object",
    "properties":{
        "enableSftp":{
            "type":"boolean",
            "description":"Whether to enable the sFTP server."
        },
        "keyAlias":{
            "type":"string"
        },
        "privateKeyPassword":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

SFTP properties were updated.

500 Response

Root Schema : schema

Type: object

Show Source

errorCode: string

The error code that Oracle Managed File Transfer returns.
errorKey: string

The error key that Oracle Managed File Transfer returns.
errorMessage: string

A message describing the error that Oracle Managed File Transfer returns.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code that Oracle Managed File Transfer returns."
        },
        "errorKey":{
            "type":"string",
            "description":"The error key that Oracle Managed File Transfer returns."
        },
        "errorMessage":{
            "type":"string",
            "description":"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