Skip to content

FOUR-25147 | Create Generic SFTP API Endpoint #8337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: epic/FOUR-25145
Choose a base branch
from

Conversation

mcraeteisha
Copy link
Contributor

@mcraeteisha mcraeteisha commented Jul 2, 2025

Feature

Ticket: FOUR-25147

This pull request introduces a new SFTP API endpoint to facilitate secure file transfer connections.

Key Changes:

  • New sftpConnection method: A sftpConnection method has been added to ProcessMaker/Http/Controllers/Api/ProcessRequestController.php to handle SFTP connection requests.
  • API Route Registration: A new API route, requests/{request}/sftp-connection, has been registered in routes/api.php. This route points to the newly created sftpConnection method and is accessible via a POST request.

How to Test

  1. Go to branch task/FOUR-25147 in processmaker.
  2. Run the TCE Transripts Reader process.
  3. Using the request id of the process, test the POST sftpConnection route via Postman:
    • {ngrok_url}/api/1.0/requests/{request_id}/sftp-connection
    • Ensure the response status is 200 OK.

Code Review Checklist

  • I have pulled this code locally and tested it on my instance, along with any associated packages.
  • This code adheres to ProcessMaker Coding Guidelines.
  • This code includes a unit test or an E2E test that tests its functionality, or is covered by an existing test.
  • This solution fixes the bug reported in the original ticket.
  • This solution does not alter the expected output of a component in a way that would break existing Processes.
  • This solution does not implement any breaking changes that would invalidate documentation or cause existing Processes to fail.
  • This solution has been tested with enterprise packages that rely on its functionality and does not introduce bugs in those packages.
  • This code does not duplicate functionality that already exists in the framework or in ProcessMaker.
  • This ticket conforms to the PRD associated with this part of ProcessMaker.

Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants