Skip to main content
PUT
Update an SFTP destination

Authorizations

Authorization
string
header
required

Path Parameters

sftpDestinationId
string
required

Body

application/json

Body of a PUT /v6/sftp-destinations/{sftpDestinationId} request.

type
enum<string>
required
Available options:
EXTERNAL
extole_key_id
string
name
string
partner_key_id
string
dropbox_path
string
host
string
key_id
string
port
integer<int32>
username
string

Response

Successful response

External sftp destination response.

created_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

dropbox_path
string
required
extole_key_id
string
required
host
string
required
id
string
required
name
string
required
partner_key_id
string
required
port
integer<int32>
required
type
enum<string>
required
Available options:
EXTERNAL
updated_date
string
required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$
Example:

"2025-10-24T02:00:00-07:00"

username
string
required
key_id
string
required