YAML for WebDAV

View as Markdown

Deploy files to a WebDAV server.

YAML parameters for WebDAV

PARAMETERS

web_dav_urlrequiredstring

The WebDAV server URL

loginrequiredstring

The login username for WebDAV authentication

passwordrequiredstring

The password for WebDAV authentication

typerequiredstring

Value: WEB_DAV

actionrequiredstring

Unique identifier for the action within the pipeline.

local_pathstring

Path in the repository to deploy. Use '/' for entire repository.

remote_pathstring

Destination path on the remote server.

deployment_excludesstring[]

Paths to exclude from deployment. One path per line.

deployment_includesstring[]

Paths to include in deployment. Only these paths will be transferred.

input_typestring enum

Source type: PIPELINE (repository) or BUILD_ARTIFACTS.

Allowed enum:

SCM_REPOSITORY,

BUILD_ARTIFACTS

deletion_disabledboolean

When true, do not delete files on remote that don't exist locally.

use_temporary_filesboolean

When true, upload to temporary location first, then move.

content_encodingstring

Content encoding for transferred files (e.g., gzip).

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

loopstring[]

The list of variables for dynamic action execution. The action runs once for each value.

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.

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_intervalinteger

Delay time between auto retries in seconds.

retry_countinteger

Number of retries if the action fails.

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

trigger_conditionsTriggerConditionYaml[]

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

variablesVariableYaml[]

The list of variables you can use in the action.

Last modified on Jul 31, 2025

Web monitoring Windows

YAML examples for WebDAV

Deploy to WebDAV server

yaml
  - action: Deploy to WebDAV
    type: WEB_DAV
    trigger_time: ON_EVERY_EXECUTION
    disabled: false
    input_type: BUILD_ARTIFACTS
    local_path: /
    remote_path: /public_html
    login: deployer
    password: $WEBDAV_PASSWORD
    web_dav_url: https://webdav.example.com/deploy
    deletion_disabled: false
    use_temporary_files: true
    deployment_excludes:
      - '*.log'
      - node_modules/**
      - .git/**
    deployment_includes:
      - dist/**
      - assets/**
    content_encoding: gzip
    ignore_errors: false
    retry_interval: 30
    retry_count: 2
    timeout: 300

Simple WebDAV deploy

yaml
  - action: WebDAV deploy
    type: WEB_DAV
    trigger_time: ON_EVERY_EXECUTION
    login: user
    password: $PASSWORD
    web_dav_url: https://webdav.example.com