Updates the SFTP properties on the server

put

/mftapp/rest/v1/artifacts/sftpProperties

• Request
• Response

Request

Supported Media Types

• application/json

Header Parameters

location

Type: string

Required: true

Relative URL of the update SFTP properties event.

Body Parameter

Root Schema : /paths/~1artifacts~1sftpProperties/put/parameters/1/schema

Type: object

Properties

enableSftp

Type: boolean

keyAlias

Type: string

privateKeyPassword

Type: string

Example application/json

{
    "enableSftp":"true",
    "keyAlias":"aliasName",
    "privateKeyPassword":"welcome1"
}

Response

Supported Media Types

• application/json

201 Response

SFTP properties were updated.

500 Response

Body

Root Schema : /paths/~1artifacts~1sftpProperties/put/responses/500/schema

Type: object

Properties

errorCode

Type: string

errorKey

Type: string

errorMessage

Type: string

Example 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."
}