Rsync (Private key from environment variables)

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

Hint

List with common parameters for all Buddy 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 ENV_KEY.

hostrequired string

The host for the connection.

loginrequired string

The username required to connect to the server.

env_keyrequired string

The private SSH key name defined in environment variables.

portrequired string

The port for the connection.

input_typestring

Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.

local_pathstring

The path in the repository.

remote_pathstring

The absolute or relative path on the remote server.

archiveboolean

An equivalent for rsync -a option. See here.

compressboolean

An equivalent for rsync -z option. See here.

recursiveboolean

An equivalent for rsync -r option. See here.

dirsboolean

An equivalent for rsync -d option. See here.

deployment_excludesstring[]

The paths and/or files that will be left out during the deployment.

deployment_includesstring[]

The exceptions from the ignore patterns set in deployment_excludes.

delete_extra_filesboolean

Defines whether additional files on the server (that are not present in repository or in the filesystem), should be deleted.

Last modified on Oct 7, 2024

Rsync (Private key)Run Docker container

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 123.45.67.89",
  "type": "RSYNC",
  "trigger_time": "ON_EVERY_EXECUTION",
  "authentication_mode": "ENV_KEY",
  "env_key": "MyKey",
  "host": "123.45.67.89",
  "port": "22",
  "login": "api_tests_user",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/",
  "remote_path": "Home/www/",
  "archive": true,
  "compress": false,
  "delete_extra_files": false,
  "recursive": true,
  "dirs": false,
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ]
}'

EXAMPLE RESPONSE
{
  "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": "api_tests_user",
  "host": "123.45.67.89",
  "port": "22",
  "authentication_mode": "ENV_KEY",
  "archive": true,
  "compress": false,
  "delete_extra_files": false,
  "env_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