YAML for environments

YAML parameters for environments

Name	Type	Description
environment `Required`	String	The environment identifier.
name `Required`	String	The display name of the environment.
url	String	The target URL associated with the environment.
icon	String	The environment icon.
tags	String[]	Array of tags to categorize the environment.
base_only	Boolean	If `true`, the environment can only be used as a base for other environments.
base_environments	String[]	Array of base environment identifiers that this environment inherits from.
variables	Variable[]	Array of environment variables.
permissions	Permissions	Access control settings for the environment.
targets	Target[]	Array of deployment targets associated with the environment.

Variables parameters

Name	Type	Description
key `Required`	String	The name of the variable.
value `Required`	String	The value of the variable.
type	String	The type of the variable. Required if value is `SSH_KEY`, `SSH_PUBLIC_KEY` or `FILE`.
description	String	Optional description of the variable.

Permissions parameters

Name	Type	Description
others	String	Access level for others. Available values: `DEFAULT`, `DENIED`, `USE_ONLY`, `MANAGE`.
users	Object	Map of user emails to their access levels (`MANAGE`, `USE_ONLY`).
pipelines	PipelineAccess[]	List of pipeline access rules.
environments	EnvironmentAccess[]	List of environment 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.

Environment access parameters

Name	Type	Description
all	Boolean	If `true`, grants access to all environments.
project	String	Project name for specific environment access.
environment	String	Environment name within the project.

Target parameters

Name	Type	Description
target `Required`	String	Target identifier.
type `Required`	String	The type of the target. Possible values: `FTP`, `SSH`, `MATCH`, `UPCLOUD`, `VULTR`, `DIGITAL_OCEAN`.
name `Required`	String	The display name of the target.
host `Required`	String	The host for the connection.
auth `Required`	Auth	Authentication details using the following parameters.
port	String	Port for the connection.
path	String	Path on the server defined in the target.
integration	String	Required when type is `UPCLOUD`, `EC2`, `VULTR` or `DIGITAL_OCEAN`. Identifier of the integration.
secure	Boolean	For `FTP` type only. Determines whether the transfer is FTP or FTPS.
proxy	Proxy	Define a SSH proxy server using the following parameters (available only for SSH targets).
region	String	Defines the source region of EC2 addresses. Required for EC2 target.

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`.

Proxy parameters

Name	Type	Description
host	String	Host for the proxy connection.
port	String	The port for the proxy connection.
auth	Auth	Define proxy servers' authentication method using the auth parameters.

YAML example for environment

yaml
- environment: stage
  name: Stage
  url: https://stage.company.com
  icon: 👨‍💻
  tags:
  - backend-api
  - staging
  variables:
  - key: DATABASE_URL
    value: postgres://staging:5432/app
  - key: API_KEY
    value: '!encrypted kqB39uqDYsn7uQ...'
  permissions:
    others: DENIED
    users:
      user@example.com: MANAGE
      developer@example.com: USE_ONLY
    pipelines:
    - all: true
    environments:
    - all: true
  targets:
  - target: staging-ftp
    type: FTP
    name: Staging FTP Server
    host: 192.168.12.12
    path: /var/www/html/site.com
    auth:
      username: deploy-user
      password: '!encrypted VDip6H0x7GDGx/9I0yb4ew==.G+ohGoSbP4utpf3TVOmdQw=='

Last modified on Jan 21, 2026

ZIP YAML for sandboxes