Go to appAcademyWhat's new?
Back
Artisan IMG > FTP Client (ftp-client) (5476d876a5d4c5435928544072f024ec)
FTP Client
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

FTP delete
Copy

Delete a file using FTP.

Sample Input

1
{
2
    "path": "/documents/report.pdf"
3
}

Sample Output

1
{
2
    "deleted": true
3
}

FTP download
Copy

Download a file using FTP.

Sample Input

1
{
2
    "path": "/documents/report.pdf",
3
    "debug": false
4
}

Sample Output

1
{
2
    "file": {
3
        "name": "report.pdf",
4
        "url": "https://example.com/temporary-download-link/report.pdf",
5
        "mime_type": "application/pdf",
6
        "expires": 1623456789
7
    }
8
}

FTP list files
Copy

List all accessible files in a directory.

Sample Input

1
{
2
    "path": "/documents"
3
}

Sample Output

1
{
2
    "files": [
3
        {
4
            "file_name": "report.pdf",
5
            "path": "/documents/report.pdf"
6
        },
7
        {
8
            "file_name": "presentation.pptx",
9
            "path": "/documents/presentation.pptx"
10
        },
11
        {
12
            "file_name": "data.xlsx",
13
            "path": "/documents/data.xlsx"
14
        },
15
        {
16
            "file_name": "image.jpg",
17
            "path": "/documents/image.jpg"
18
        }
19
    ]
20
}

FTP move
Copy

Move (or rename) a file using FTP.

Sample Input

1
{
2
    "old_path": "/documents/report_2023.pdf",
3
    "new_path": "/archive/2023/annual_report.pdf"
4
}

Sample Output

1
{
2
    "moved": true
3
}

FTP upload
Copy

Upload a file using FTP.

Sample Input

1
{
2
    "file": {
3
        "name": "example.txt",
4
        "content": "SGVsbG8gV29ybGQh",
5
        "mime_type": "text/plain"
6
    },
7
    "path": "/uploads/example.txt",
8
    "include_detailed_error": true
9
}

Sample Output

1
{
2
    "file": {
3
        "name": "example.txt",
4
        "url": "ftp://ftp.example.com/uploads/example.txt",
5
        "mime_type": "text/plain",
6
        "expires": 1672531200
7
    }
8
}

SFTP check file exists
Copy

Check whether a file exists with partial or full file name.

Sample Input

1
{
2
    "path": "/documents/reports",
3
    "file_name": "monthly_report"
4
}

Sample Output

1
{
2
    "Found": true
3
}

SFTP delete
Copy

Delete a file using SFTP (ssh).

Sample Input

1
{
2
    "path": "/home/user/documents/report.pdf"
3
}

Sample Output

1
{
2
    "deleted": true
3
}

SFTP download
Copy

Download a file using SFTP (ssh).

Sample Input

1
{
2
    "path": "/documents/report.pdf",
3
    "debug": false
4
}

Sample Output

1
{
2
    "file": {
3
        "name": "report.pdf",
4
        "url": "https://example.com/temporary-download-link/report.pdf",
5
        "mime_type": "application/pdf",
6
        "expires": 1623456789
7
    }
8
}

SFTP list directories
Copy

List all accessible subdirectories in a directory.

Sample Input

1
{
2
    "path": "/home/user/documents"
3
}

Sample Output

1
{
2
    "directories": [
3
        {
4
            "directory_name": "projects",
5
            "path": "/home/user/documents/projects"
6
        },
7
        {
8
            "directory_name": "reports",
9
            "path": "/home/user/documents/reports"
10
        },
11
        {
12
            "directory_name": "images",
13
            "path": "/home/user/documents/images"
14
        },
15
        {
16
            "directory_name": "backups",
17
            "path": "/home/user/documents/backups"
18
        }
19
    ]
20
}

SFTP list files
Copy

List all accessible files in a directory.

Sample Input

1
{
2
    "path": "/documents",
3
    "file_extension": ".pdf",
4
    "file_name": "report"
5
}

Sample Output

1
{
2
    "files": [
3
        {
4
            "file_name": "annual_report_2023.pdf",
5
            "path": "/documents/annual_report_2023.pdf"
6
        },
7
        {
8
            "file_name": "quarterly_report_Q2.pdf",
9
            "path": "/documents/quarterly_report_Q2.pdf"
10
        },
11
        {
12
            "file_name": "financial_report_2023.pdf",
13
            "path": "/documents/financial_report_2023.pdf"
14
        }
15
    ]
16
}

SFTP move
Copy

Move (or rename) a file using SFTP (ssh).

Sample Input

1
{
2
    "old_path": "/documents/report_2023.pdf",
3
    "new_path": "/archive/2023/annual_report.pdf"
4
}

Sample Output

1
{
2
    "moved": true
3
}

SFTP upload
Copy

Upload a file using SFTP (ssh).

Sample Input

1
{
2
    "file": {
3
        "name": "example.txt",
4
        "content": "This is the content of the file to be uploaded."
5
    },
6
    "path": "/remote/directory/example.txt",
7
    "stream": true,
8
    "buffer_size": 65536,
9
    "debug": false,
10
    "concurrency": 64,
11
    "include_detailed_error": false
12
}

Sample Output

1
{
2
    "uploaded": true,
3
    "connectionLogs": [
4
        "Connecting to SFTP server...",
5
        "Authentication successful",
6
        "Uploading file: /remote/directory/example.txt",
7
        "File upload completed successfully",
8
        "SFTP connection closed"
9
    ]
10
}
Previous

Overview

Next

Operations