WebDAV

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to WEB_DAV.
login
Required
StringThe username required to connect to the server.
password
Required
StringThe password required to connect to the server.
web_dav_url
Required
StringThe URL to your WebDAV server.
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.

Example

Request

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

JSON

{
"name": "Upload files to localhost",
"type": "WEB_DAV",
"trigger_time": "ON_EVERY_EXECUTION",
"web_dav_url": "https://mysite.com/webdav/",
"login": "webdav",
"password": "webdav123",
"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/861",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/861/edit",
"id": 861,
"name": "Upload files to localhost",
"type": "WEB_DAV",
"trigger_time": "ON_EVERY_EXECUTION",
"last_execution_status": "INITIAL",
"local_path": "/assets/",
"remote_path": "Home/www/",
"login": "webdav",
"web_dav_url": "https://mysite.com/webdav/",
"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"
}
}