Rsync (Password)

  • 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 RSYNC.
authentication_moderequired string
The authentication mode for SSH. Should be set to PASS.
hostrequired string
The host for the connection.
loginrequired string
The username required to connect to the server.
passwordrequired string
The password required to connect to the server.
portrequired string
The port for the connection.
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.
remote_pathoptional string
The absolute or relative path on the remote server.
archiveoptional boolean
An equivalent for rsync -a option. See here.
compressoptional boolean
An equivalent for rsync -z option. See here.
recursiveoptional boolean
An equivalent for rsync -r option. See here.
dirsoptional boolean
An equivalent for rsync -d option. See here.
delete_extra_filesoptional boolean
Defines whether additional files on the server (that are not present in repository or in the filesystem), should be deleted.
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.

Last modified on Sep 23, 2024

{
  "name": "Upload files to 123.45.67.89",
  "type": "RSYNC",
  "trigger_time": "ON_EVERY_EXECUTION",
  "authentication_mode": "PASS",
  "host": "123.45.67.89",
  "port": "22",
  "login": "api_tests_user",
  "password": "${rsync_password}",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/",
  "remote_path": "Home/www/",
  "archive": true,
  "compress": false,
  "recursive": true,
  "dirs": true,
  "delete_extra_files": false,
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ]
}
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/855",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/855/edit",
  "id": 855,
  "name": "Upload files to 123.45.67.89",
  "type": "RSYNC",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/",
  "remote_path": "Home/www/",
  "login": "root",
  "host": "123.45.67.89",
  "port": "22",
  "authentication_mode": "PASS",
  "archive": true,
  "compress": false,
  "recursive": true,
  "dirs": true,
  "delete_extra_files": false,
  "deployment_excludes": [
    "/assets/",
    "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"
  }
}