FTP

POST Parameters

NameTypeDescription
host
Required
StringThe host for the connection.
login
Required
StringThe username required to connect to the server.
name
Required
StringThe name of the action.
password
Required
StringThe password required to connect to the server.
port
Required
StringThe port for the connection.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to FTP.
active_modeBooleanEnables the active mode for the connection.
input_typeStringDefines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathStringThe path in the repository.
remote_pathStringThe absolute or relative path on the remote server.
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.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Upload files to localhost",
"type": "FTP",
"input_type": "SCM_REPOSITORY",
"trigger_time": "ON_EVERY_EXECUTION",
"host": "localhost",
"port": "21",
"login": "api_tests_user",
"password": "api_tests_password",
"active_mode": true,
"local_path": "/asset/",
"remote_path": "Home/www/",
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"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": "FTP",
"trigger_time": "ON_EVERY_EXECUTION",
"last_execution_status": "INITIAL",
"run_only_on_first_failure": false,
"input_type": "SCM_REPOSITORY",
"local_path": "/asset/",
"remote_path": "Home/www/",
"login": "root",
"active_mode": true,
"host": "localhost",
"port": "21",
"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",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}

FTP over SSL action

POST Parameters

NameTypeDescription
host
Required
StringThe host for the connection.
login
Required
StringThe username required to connect to the server.
name
Required
StringThe name of the action.
password
Required
StringThe password required to connect to the server.
port
Required
StringThe port for the connection.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to FTPS.
input_typeStringDefines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathStringThe path in the repository.
remote_pathStringThe absolute or relative path on the remote server.
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.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Upload files to localhost",
"type": "FTPS",
"trigger_time": "ON_EVERY_EXECUTION",
"host": "localhost",
"port": "21",
"login": "api_tests_user",
"password": "api_tests_password",
"input_type": "SCM_REPOSITORY",
"local_path": "/assets/",
"remote_path": "Home/www/",
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"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": "FTPS",
"trigger_time": "ON_EVERY_EXECUTION",
"last_execution_status": "INITIAL",
"run_only_on_first_failure": false,
"input_type": "SCM_REPOSITORY",
"local_path": "/assets/",
"remote_path": "Home/www/",
"login": "root",
"active_mode": false,
"host": "localhost",
"port": "21",
"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",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}