Skip to content

NotificationFtp

QuantConnect.Notifications.NotificationFtp

NotificationFtp(
    hostname: str,
    username: str,
    password: str,
    file_path: str,
    file_content: List[int],
    secure: bool = True,
    port: Optional[int] = None,
)
NotificationFtp(
    hostname: str,
    username: str,
    private_key: str,
    private_key_passphrase: str,
    file_path: str,
    file_content: List[int],
    port: Optional[int] = None,
)
NotificationFtp(
    hostname: str,
    username: str,
    password: str,
    file_path: str,
    file_content: str,
    secure: bool = True,
    port: Optional[int] = None,
)
NotificationFtp(
    hostname: str,
    username: str,
    private_key: str,
    private_key_passphrase: str,
    file_path: str,
    file_content: str,
    port: Optional[int] = None,
)

Bases: Notification

FTP notification data

Signature descriptions:

  • Constructor for a notification to sent as a file to an FTP server using password authentication.

  • Constructor for a notification to sent as a file to an FTP server over SFTP using SSH keys.

Parameters:

Name Type Description Default
hostname str

FTP server hostname

required
username str

The FTP server username

required
password Optional[str]

The FTP server password

None
file_path str

The path to file on the FTP server

required
file_content List[int] | str

The contents of the file

required
secure Optional[bool]

Whether to use SFTP or FTP. Defaults to true

True
port Optional[int]

The FTP server port. Defaults to 21

None
private_key Optional[str]

The private SSH key to use for authentication

None
private_key_passphrase Optional[str]

The optional passphrase to decrypt the private key.

None

secure

secure: bool

Whether to use SFTP or FTP.

hostname

hostname: str

The FTP server hostname.

port

port: int

The FTP server port.

username

username: str

The FTP server username.

password

password: str

The FTP server password.

file_path

file_path: str

The path to file on the FTP server.

file_content

file_content: str

The contents of the file to send.

private_key

private_key: str

The private key to use for authentication (optional).

private_key_passphrase

private_key_passphrase: str

The passphrase for the private key (optional).

send

send() -> None

Method for sending implementations of notification object types.