YAML for targets

YAML parameters for targets

Name	Type	Description
target `required`	String	The target scope. Available values: `project-name`.
type `required`	String	The type of the target. Available values: `SSH`, `FTP`, `MATCH`, `UPCLOUD`, `VULTR`, `DIGITAL_OCEAN`, `GIT`, `EC2`.
name `required`	String	The name of the target.
host `required`	String	The host for the connection.
auth `required`	Auth	Authentication details for the target.
port	String	Port for the connection.
path	String	Path on the server defined in the target.
permissions	Permissions	Define permissions for the target.
tags	String[]	A list of tags associated with the target.
disabled	Boolean	When set to `true` the target is disabled. Default: `false`.
integration	String	Required when type is `UPCLOUD`, `VULTR`, `DIGITAL_OCEAN`, or `EC2`. Identifier of the integration.
region	String	Defines the source region of EC2 addresses. Required for EC2 target.
repository	String	The URL to the Git repository. Required when target type is `GIT`.
secure	Boolean	Determines whether the transfer is FTP or FTPS. `true` = FTPS, `false` = FTP.
proxy	Proxy	SSH proxy server configuration (available only for SSH targets).

Auth parameters

Name	Type	Description
method	String	Required for SSH, UPCLOUD, VULTR and DIGITAL_OCEAN. Available values: `PASSWORD`, `SSH_KEY`, `ASSETS_KEY`, `PROXY_CREDENTIALS`, `PROXY_KEY`.
username `required`	String	The username required to connect to the server.
password	String	The password required to connect to the server. Required for `PASSWORD` method.
asset	String	Name of the variable containing the private key. Required for `ASSETS_KEY` method.
passphrase	String	Passphrase for the SSH key.
key	String	Private key used for authentication. Required for `SSH_KEY` method.
key_path	String	Path to the key on proxy server. Required for method `PROXY_KEY`.

Permissions parameters

Name	Type	Description
others	String	Access level for others. Available values: `DEFAULT`, `DENIED`, `READ_ONLY`, `USE_ONLY`, `MANAGE`.
users	Object	Map of user emails to their access levels (`DENIED`, `READ_ONLY`, `USE_ONLY`, `MANAGE`).
groups	Object	Map of group names to their access levels (`DENIED`, `READ_ONLY`, `USE_ONLY`, `MANAGE`).
pipelines	PipelineAccess[]	List of pipeline access rules.

Pipeline access parameters

Name	Type	Description
all	Boolean	If `true`, grants access to all pipelines.
project	String	Project name for specific pipeline access.
pipeline	String	Pipeline name within the project.

Proxy parameters

Name	Type	Description
name	String	Name of the proxy server.
host `required`	String	Host for the proxy connection.
port	String	The port for the proxy connection.
auth `required`	ProxyAuth	Proxy server authentication method.

Proxy auth parameters

Name	Type	Description
method `required`	String	Method used for proxy server authentication. Available values: `PASSWORD`, `SSH_KEY`, `ASSETS_KEY`.
username `required`	String	Login to the proxy server.
password	String	Password to the proxy server. Required for `PASSWORD` method.
key	String	Proxy key used for authentication. Required for `SSH_KEY` method.
asset	String	Name of the variable containing the private key. Required for `ASSETS_KEY` method.
passphrase	String	Passphrase for the SSH key.

YAML example for SSH target with permissions

yaml
- target: target-test-yaml
  type: SSH
  name: target-test-yaml
  host: 192.168.1.1
  path: /var/www/html
  auth:
    username: deploy
    password: '!encrypted jnID5rObn/FzRtX0fRMPHA==.XVy23NcO6Im8AWAahARafg=='
  tags:
  - azure
  permissions:
    others: DENIED
    users:
      admin@example.com: MANAGE
      developer@example.com: READ_ONLY
    groups:
      Frontend: MANAGE
      Marketing: USE_ONLY
    pipelines:
    - all: true

YAML example for FTP target

yaml
- target: stage_http_cache
  type: FTP
  secure: true
  name: STAGE HTTP Cache
  host: domain.com
  port: 6464
  auth:
    username: deploy_user
    password: '!encrypted jnID5rObn/FzRtX0fRMPHA==.XVy23NcO6Im8AWAahARafg=='
  tags:
  - http_server
  permissions:
    others: USE_ONLY
    users:
      admin@example.com: MANAGE
    pipelines:
    - all: true

YAML example for target with specific pipelines

yaml
- target: restricted_deploy
  type: SSH
  name: Restricted Deploy Server
  host: 192.168.1.100
  auth:
    username: deploy
    password: '!encrypted sYCq9qPo23==.asd4t6+vev=='
  permissions:
    others: DENIED
    users:
      admin@example.com: MANAGE
      developer@example.com: USE_ONLY
    pipelines:
    - project: company-website
      pipeline: deploy-to-production
    - project: mobile-app
      pipeline: build-and-test

YAML example for target with no pipeline access

When the pipelines section is omitted, no pipelines can use this target.

yaml
- target: restricted_target
  type: SSH
  name: Restricted Server
  host: secure.example.com
  auth:
    username: admin
    password: '!encrypted ghp_token123=='
  permissions:
    others: DENIED
    users:
      admin@example.com: MANAGE
      developer@example.com: READ_ONLY

YAML example for SSH target with proxy

yaml
- target: secure_server
  type: SSH
  name: Secure Server with Proxy
  host: internal.server.local
  port: 22
  path: /app/deployment
  auth:
    username: deploy
    password: '!encrypted secure.password=='
  proxy:
    name: bastion_host
    host: bastion.example.com
    port: 22
    auth:
      method: SSH_KEY
      username: proxy_user
      key: '!encrypted ssh.private.key=='
  permissions:
    others: DENIED
    users:
      admin@example.com: MANAGE
    pipelines:
    - project: secure-app
      pipeline: prod-deploy

Last modified on Jan 27, 2026

ZIP YAML for environments