跳到主要内容

FTP

Learn how to add and configure the "FTP Transfer" action in your Buddy pipeline

POST参数

名称类型描述
name
必填
String操作名称
type
必填
StringThe type of the action. Should be set to FTP.
host
必填
StringThe host for the connection.
login
必填
StringThe username required to connect to the server.
password
必填
StringThe password required to connect to the server.
port
必填
StringThe port 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.
use_temporary_filesBooleanThe files will be uploaded with a "tmp" suffix that will be removed once the upload has finished.

示例

请求

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",
"local_path": "/asset/",
"remote_path": "Home/www/",
"use_temporary_files": true,
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
}

示例响应

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",
"input_type": "SCM_REPOSITORY",
"local_path": "/asset/",
"remote_path": "Home/www/",
"use_temporary_files": true,
"login": "root",
"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",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}