# SourceSftp


## Fields

| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        | Example                                                                            |
| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| `host`                                                                             | *str*                                                                              | :heavy_check_mark:                                                                 | The server host address                                                            | www.host.com                                                                       |
| `user`                                                                             | *str*                                                                              | :heavy_check_mark:                                                                 | The server user                                                                    |                                                                                    |
| `credentials`                                                                      | [Optional[models.SourceSftpAuthentication]](../models/sourcesftpauthentication.md) | :heavy_minus_sign:                                                                 | The server authentication method                                                   |                                                                                    |
| `file_pattern`                                                                     | *Optional[str]*                                                                    | :heavy_minus_sign:                                                                 | The regular expression to specify files for sync in a chosen Folder Path           | log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which  `log-yearmmdd`  |
| `file_types`                                                                       | *Optional[str]*                                                                    | :heavy_minus_sign:                                                                 | Coma separated file types. Currently only 'csv' and 'json' types are supported.    | csv,json                                                                           |
| `folder_path`                                                                      | *Optional[str]*                                                                    | :heavy_minus_sign:                                                                 | The directory to search files for sync                                             | /logs/2022                                                                         |
| `port`                                                                             | *Optional[int]*                                                                    | :heavy_minus_sign:                                                                 | The server port                                                                    | 22                                                                                 |
| `source_type`                                                                      | [models.Sftp](../models/sftp.md)                                                   | :heavy_check_mark:                                                                 | N/A                                                                                |                                                                                    |