---
title: SFTP File Download
slug: sftp-file-download
docTags: 
createdAt: 2022-11-25T15:32:17.000Z
---

Reads contents of the file and returns the data encoded in base64





### API Definition

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://orca.pathfix.com/functions/web/sftpdownload",
  "name": "SFTP File Download API",
  "method": "POST",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "28UsDqyeH3QRdmtVamSQT",
        "code": "{\n    \"output\": \"Base64 encoded data from file\"\n    ]\n}",
        "language": "200"
      },
      {
        "id": "yIX64DyIuDPJgBRFSfAWb",
        "code": "{\n    \"message\": \"error\"\n}",
        "language": "404"
      }
    ],
    "selectedLanguageId": "28UsDqyeH3QRdmtVamSQT"
  },
  "examples": {
    "languages": [
      {
        "id": "ENcJz9TStG38F0X-taA4x",
        "code": "{\r\n\t\"input\": {\r\n\t\t\"file_format\": \"text or binary\",\r\n\t\t\"user_name\": \"User Name\",\r\n\t\t\"password\": \"Password\",\r\n\t\t\"file_path\": \"ftp://test.yourdomain.net:22/folder/subfolder/textfile.txt\"\r\n\t}\r\n}",
        "language": "json"
      }
    ],
    "selectedLanguageId": "ENcJz9TStG38F0X-taA4x"
  },
  "description": "\nCall the following API:",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  }
}
```
:::