SFTP (Private key from environment variables)

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to SFTP.
authentication_moderequired string
The authentication mode for SSH. Should be set to ENV_KEY.
hostrequired string
The host for the connection.
loginrequired string
The username required to connect to the server.
portrequired string
The port for the connection.
env_keyrequired string
The private SSH key name defined in environment variables.
input_typeoptional string
Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathoptional string
The path in the repository.
passphraseoptional string
The passphrase for the private SSH key.
remote_pathoptional string
The absolute or relative path on the remote server.
deployment_excludesoptional string[]
The paths and/or files that will be left out during the deployment.
deployment_includesoptional string[]
The exceptions from the ignore patterns set in deployment_excludes.
use_temporary_filesoptional boolean
The files will be uploaded with a 'tmp' suffix that will be removed once the upload has finished.

Last modified on Oct 7, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Upload files to localhost",
  "type": "SFTP",
  "trigger_time": "ON_EVERY_EXECUTION",
  "authentication_mode": "ENV_KEY",
  "host": "localhost",
  "port": "22",
  "login": "api_tests_user",
  "passphrase": "password",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/assets-old/",
  "remote_path": "Home/www/",
  "use_temporary_files": true,
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ],
  "server_key": "MyKey"
}'
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit", "id": 2, "name": "Upload files to localhost", "type": "SFTP", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "input_type": "SCM_REPOSITORY", "local_path": "/assets-old/", "remote_path": "Home/www/", "use_temporary_files": true, "login": "root", "host": "localhost", "port": "22", "authentication_mode": "ENV_KEY", "server_key": "MyKey", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "pipeline": { "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2", "id": 2, "name": "Live mirror", "on": "CLICK", "refs": [ "refs/heads/master" ], "last_execution_status": "SUCCESSFUL", "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999