Rsync

View as Markdown

POST
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Creates a new Rsync action in the pipeline

Request

REQUIRED SCOPES

EXECUTION_MANAGE

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

project_namerequiredstring

The human-readable ID of the project

Example: "my-project"

pipeline_idrequiredinteger

The ID of the pipeline

Example: 123

POST PARAMETERS

typerequiredstring enum

The type of the action

Allowed enum:

RSYNC

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

after_action_idinteger

The numerical ID of the action, after which this action should be added

namerequiredstring

The name of the action

trigger_timestring enum

Specifies when the action should be executed

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

trigger_conditionsTriggerConditionView[]

The list of trigger conditions to meet so that the action can be triggered

run_nextstring enum

Defines whether the action should run in parallel with the next one

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE

variablesEnvironmentVariableView[]

The list of variables you can use the action

disabledboolean

When set to true the action is disabled. By default it is set to false

timeoutinteger

The timeout in seconds

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions

retry_countinteger

Number of retries if the action fails

retry_intervalinteger

Delay time between auto retries in seconds

loopstring[]

The list of commands that will be executed in a loop

current_revisionstring

The git revision of the last successful run of the action

permissionsPermissionsView

Access permissions configuration

local_pathstring

The path to the local files to synchronize

deployment_excludesstring[]

The list of paths to exclude from synchronization

deployment_includesstring[]

The list of paths to include in synchronization

archiveboolean

Enables archive mode, preserving permissions, timestamps, and symbolic links

delete_extra_filesboolean

Deletes files on the destination that don't exist in the source

recursiveboolean

Synchronizes directories recursively

dirsboolean

Transfers directories without their contents

compressboolean

Compresses files during transfer

remote_pathstring

The path on the remote server where files will be synchronized

argumentsstring

Additional rsync command-line arguments

targetsTargetView[]

The list of servers to synchronize files to

Response

RESPONSE BODY

typestring enum

The type of the action

Allowed enum:

RSYNC

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

idinteger

The ID of the action

namestring

The name of the action

current_revisionstring

The git revision of the last successful run of the action

trigger_timestring enum

Specifies when the action should be executed

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

trigger_conditionsTriggerConditionView[]

The list of trigger conditions to meet so that the action can be triggered

run_nextstring enum

Defines whether the action should run in parallel with the next one

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE

variablesEnvironmentVariableView[]

The list of variables you can use the action

disabledboolean

When set to true the action is disabled. By default it is set to false

timeoutinteger

The timeout in seconds

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions

retry_countinteger

Number of retries if the action fails

retry_intervalinteger

Delay time between auto retries in seconds

last_execution_statusstring enum

The status of the last run of the action

Allowed enum:

INPROGRESS,

ENQUEUED,

TERMINATED,

SUCCESSFUL,

FAILED,

INITIAL,

NOT_EXECUTED,

SKIPPED,

TERMINATING,

WAITING_FOR_APPLY,

WAITING_FOR_VARIABLES,

WAITING_FOR_SETTABLE_VARIABLES,

WAITING_FOR_VT_SESSION

pipelineShortPipelineView

Short representation of a pipeline

permissionsPermissionsView

Access permissions configuration

loopstring[]

The list of commands that will be executed in a loop

local_pathstring

The path to the local files to synchronize

deployment_excludesstring[]

The list of paths to exclude from synchronization

deployment_includesstring[]

The list of paths to include in synchronization

archiveboolean

Enables archive mode, preserving permissions, timestamps, and symbolic links

delete_extra_filesboolean

Deletes files on the destination that don't exist in the source

recursiveboolean

Synchronizes directories recursively

dirsboolean

Transfers directories without their contents

compressboolean

Compresses files during transfer

remote_pathstring

The path on the remote server where files will be synchronized

argumentsstring

Additional rsync command-line arguments

targetsTargetView[]

The list of servers to synchronize files to

Last modified on Mar 18, 2026

Edit action Get action

Request example


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sync files",
  "disabled": true,
  "type": "RSYNC",
  "trigger_time": "ON_EVERY_EXECUTION",
  "local_path": "/source_path",
  "remote_path": "/target_path",
  "deployment_excludes": [
    "/assets/",
    "/myDir"
  ],
  "deployment_includes": [
    "/assets/dir",
    "/myDir/dir1"
  ],
  "archive": false,
  "compress": false,
  "recursive": true,
  "dirs": true,
  "delete_extra_files": true,
  "targets": [
    {
      "identifier": "my_target_id",
      "name": "my-target",
      "type": "SSH",
      "scope": "ACTION",
      "path": "target/path/on/server",
      "host": "my-server.tests",
      "port": "1234",
      "auth": {
        "username": "my-user",
        "password": "my-password",
        "method": "PASSWORD"
      },
      "tags": [
        "olive",
        "orange",
        "rabsperry"
      ]
    }
  ],
  "variables": [
    {
      "key": "env_key",
      "value": "env_value",
      "type": "VAR",
      "settable": false,
      "run_only_settable": false,
      "encrypted": false,
      "description": "nnnmstgikb"
    }
  ],
  "timeout": 1800,
  "retry_interval": 60,
  "retry_count": 5,
  "ignore_errors": true,
  "arguments": "--times --links",
  "current_revision": "21825f31ddce8a89b3ed9f4c92f038b339cde150",
  "loop": [
    "env_key"
  ]
}'

STATUS
200 OK