Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitCLIAPIFAQ

YAML for environments

View as Markdown

Learn how to configure environments with variables and permissions using YAML format.

YAML parameters for YAML for environments

Environment
environmentrequiredstring
The environment identifier (human-readable ID)
namerequiredstring
The display name of the environment
tagsstring[]
The list of tags associated with the environment
scopestring enum
The scope of the environment
Allowed enum:
PROJECT,
WORKSPACE,
ANY
base_environmentsstring[]
The list of base environment identifiers this environment inherits from (specified by project slug and environment slug)
variablesVariableYaml[]
The list of environment variables
permissionsEnvironmentPermissionsYaml
Access control settings for the environment
base_onlyboolean
Whether this environment serves only as a base for other environments
iconstring
The environment icon (a single emoji character)
urlstring
The target URL associated with the environment
targets(string | TargetYaml)[]
The list of deployment targets associated with the environment
sandboxesSandboxYaml[]
The list of sandboxes scoped to the environment
notestring
Note for this resource
agent_notestring
YAML note for AI agents operating on this resource
Target
targetrequiredstring
The human-readable ID of the target
disabledboolean
Indicates if this target is disabled (default: false)
tagsstring[]
The list of tags associated with the target
permissionsPermissionsYaml
The permissions for the target
use_asUseAsYaml
Defines how the target can be used (as deployment target, proxy, or both)
notestring
Note for this resource
agent_notestring
YAML note for AI agents operating on this resource
Type-specific fields, by target type:
SSH Server - SSH target for deploying to remote servers via SSH connection.
hostrequiredstring
The host for the connection
namestring
The name of the target
portstring
The port for the connection
pathstring
Path on the server defined in the target
authSSHAuthYaml
Authentication details
proxystring | TargetSSHProxyYaml
Define a SSH proxy server using the following parameters
typestring

Value: SSH

FTP Server - FTP/FTPS target for file transfer deployments.
hostrequiredstring
The host for the connection
secureboolean
Whether connection is secure (SFTP/FTPS)
namestring
The name of the target
portstring
The port for the connection
authFTPAuthYaml
Authentication details
pathstring
Path on the server defined in the target
typestring

Value: FTP

Vultr Server - Vultr server target for deploying to Vultr virtual machines.
integrationrequiredstring
The integration identifier
hostrequiredstring
The host for the connection
namestring
The name of the target
portstring
The port for the connection
pathstring
Path on the server defined in the target
authSSHAuthYaml
Authentication details
proxystring | TargetSSHProxyYaml
Define a SSH proxy server using the following parameters
typestring

Value: VULTR

UpCloud Server - UpCloud server target for deploying to UpCloud virtual machines.
integrationrequiredstring
The integration identifier
hostrequiredstring
The host for the connection
namestring
The name of the target
portstring
The port for the connection
pathstring
Path on the server defined in the target
authSSHAuthYaml
Authentication details
proxystring | TargetSSHProxyYaml
Define a SSH proxy server using the following parameters
typestring

Value: UPCLOUD

DigitalOcean Droplet - DigitalOcean Droplet target for deploying to DigitalOcean virtual machines.
integrationrequiredstring
The integration identifier
hostrequiredstring
The host for the connection
namestring
The name of the target
portstring
The port for the connection
pathstring
Path on the server defined in the target
authSSHAuthYaml
Authentication details
proxystring | TargetSSHProxyYaml
Define a SSH proxy server using the following parameters
typestring

Value: DIGITAL_OCEAN

Git Repository - Git target for pushing changes to remote Git repositories.
repositoryrequiredstring
The URL to the Git repository
namestring
The name of the target
authGitAuthYaml
Authentication details
typestring

Value: GIT

Google Kubernetes Engine - Google Kubernetes Engine (GKE) target for deploying to Google Cloud.
integrationrequiredstring
The integration. Required when adding GKE/EKS/AKS/DOKS
clusterrequiredstring
The ID of the cluster or fully qualified identifier for the cluster
namestring
The name of the target
regionstring
Cloud region, e.g. eu-central-1
application_idstring
The ID of the application/project
projectstring
The ID of the Google Cloud project
subscriptionstring
Type of AKS subscription
resource_groupstring
Azure resource group containing the AKS cluster
zonestring
GKE zone. E.g., europe-west3-a
proxystring
Proxy configuration to route K8s API traffic through (for private clusters)
typestring

Value: GKE

DigitalOcean Kubernetes - DigitalOcean Kubernetes Service (DOKS) target for deploying to DigitalOcean.
integrationrequiredstring
The integration. Required when adding GKE/EKS/AKS/DOKS
clusterrequiredstring
The ID of the cluster or fully qualified identifier for the cluster
namestring
The name of the target
regionstring
Cloud region, e.g. eu-central-1
application_idstring
The ID of the application/project
projectstring
The ID of the Google Cloud project
subscriptionstring
Type of AKS subscription
resource_groupstring
Azure resource group containing the AKS cluster
zonestring
GKE zone. E.g., europe-west3-a
proxystring
Proxy configuration to route K8s API traffic through (for private clusters)
typestring

Value: DOKS

Azure Kubernetes Service - Azure Kubernetes Service (AKS) target for deploying to Azure.
integrationrequiredstring
The integration. Required when adding GKE/EKS/AKS/DOKS
clusterrequiredstring
The ID of the cluster or fully qualified identifier for the cluster
namestring
The name of the target
regionstring
Cloud region, e.g. eu-central-1
application_idstring
The ID of the application/project
projectstring
The ID of the Google Cloud project
subscriptionstring
Type of AKS subscription
resource_groupstring
Azure resource group containing the AKS cluster
zonestring
GKE zone. E.g., europe-west3-a
proxystring
Proxy configuration to route K8s API traffic through (for private clusters)
typestring

Value: AKS

Amazon Elastic Kubernetes Service - Amazon Elastic Kubernetes Service (EKS) target for deploying to AWS.
integrationrequiredstring
The integration. Required when adding GKE/EKS/AKS/DOKS
clusterrequiredstring
The ID of the cluster or fully qualified identifier for the cluster
role_arnstring
Amazon resource name specifying the IAM role to assume
namestring
The name of the target
regionstring
Cloud region, e.g. eu-central-1
application_idstring
The ID of the application/project
projectstring
The ID of the Google Cloud project
subscriptionstring
Type of AKS subscription
resource_groupstring
Azure resource group containing the AKS cluster
zonestring
GKE zone. E.g., europe-west3-a
proxystring
Proxy configuration to route K8s API traffic through (for private clusters)
typestring

Value: EKS

Kubernetes Cluster - Self-managed Kubernetes cluster target.
clusterrequiredstring
The ID of the cluster or fully qualified identifier for the cluster
authK8sAuthYaml
Kubernetes cluster authentication configuration
namestring
The name of the target
integrationstring
The integration. Required when adding GKE/EKS/AKS/DOKS
regionstring
Cloud region, e.g. eu-central-1
application_idstring
The ID of the application/project
projectstring
The ID of the Google Cloud project
subscriptionstring
Type of AKS subscription
resource_groupstring
Azure resource group containing the AKS cluster
zonestring
GKE zone. E.g., europe-west3-a
proxystring
Proxy configuration to route K8s API traffic through (for private clusters)
typestring

Value: K8S_CLUSTER

MySQL - MySQL target for executing queries on a MySQL database.
hostrequiredstring
The hostname or IP address of the MySQL server
namestring
The name of the target
portstring
The port of the MySQL server. Default: 3306
databasestring
The default database name
authMysqlAuthYaml
MySQL authentication credentials
proxystring
SSH proxy target for tunneling to private MySQL servers
typestring

Value: MYSQL

PostgreSQL - PostgreSQL target for executing queries on a PostgreSQL database.
hostrequiredstring
The hostname or IP address of the PostgreSQL server
namestring
The name of the target
portstring
The port of the PostgreSQL server. Default: 5432
databasestring
The default database name
authPostgresqlAuthYaml
PostgreSQL authentication credentials
proxystring
SSH proxy target for tunneling to private PostgreSQL servers
typestring

Value: POSTGRESQL

MongoDB - MongoDB target for executing queries on a MongoDB database.
hostrequiredstring
The hostname or IP address of the MongoDB server
namestring
The name of the target
portstring
The port of the MongoDB server. Default: 27017
databasestring
The default database name
auth_sourcestring
The authentication database (e.g. admin). If not set, the target database is used
authMongoAuthYaml
MongoDB authentication credentials
proxystring
SSH proxy target for tunneling to private MongoDB servers
typestring

Value: MONGO

Microsoft SQL Server - Microsoft SQL Server target for executing queries on an MSSQL database.
hostrequiredstring
The hostname or IP address of the MSSQL server
namestring
The name of the target
portstring
The port of the MSSQL server. Default: 1433
databasestring
The default database name
ssl_modestring enum
SSL connection mode. Default: REQUIRE, which encrypts but does NOT validate the server certificate (vulnerable to MITM); full certificate validation requires ca_certificate.
Allowed enum:
DISABLE,
REQUIRE,
VERIFY_FULL
ca_certificatestring
PEM-encoded CA certificate (required when ssl_mode is VERIFY_FULL)
authMssqlAuthYaml
MSSQL authentication credentials
proxystring
SSH proxy target for tunneling to private MSSQL servers
typestring

Value: MSSQL

AWS RDS for SQL Server - AWS RDS for SQL Server target for executing queries on an RDS-managed MSSQL instance.
integrationrequiredstring
Hash ID or identifier of an AWS integration
regionrequiredstring
AWS region of the RDS instance, e.g. us-east-1
db_instance_identifierrequiredstring
RDS DB instance identifier
hostrequiredstring
The endpoint hostname of the RDS instance
namestring
The name of the target
portstring
The port of the RDS MSSQL instance. Default: 1433
databasestring
The default database name
ssl_modestring enum
SSL connection mode. Default: REQUIRE.
Allowed enum:
DISABLE,
REQUIRE,
VERIFY_FULL
ca_certificatestring
PEM-encoded CA certificate (required when ssl_mode is VERIFY_FULL)
authMssqlAuthYaml
MSSQL authentication credentials
proxystring
SSH proxy target for tunneling to RDS instances in private VPCs
typestring

Value: RDS_MSSQL

ClickHouse - ClickHouse target for executing queries on a ClickHouse database.
hostrequiredstring
The hostname or IP address of the ClickHouse server
namestring
The name of the target
portstring
The native protocol port of the ClickHouse server. Default: 9000
databasestring
The default database name
secureboolean
Whether to use a TLS-secured native protocol connection. Default: false
authClickhouseAuthYaml
ClickHouse authentication credentials
proxystring
SSH proxy target for tunneling to private ClickHouse servers
typestring

Value: CLICKHOUSE

Last modified on Jul 21, 2026

Previous pageVultr ServerNext pageYAML for sandboxes

YAML examples for YAML for environments

Minimal environment

yaml
- environment: my-env
  name: My Environment

Environment with variables, permissions and targets

yaml
- environment: stage
  name: Stage
  scope: WORKSPACE
  url: https://stage.company.com
  icon: 🚀
  tags:
    - backend-api
    - staging
  base_only: false
  base_environments:
    - production
  variables:
    - key: DATABASE_URL
      value: postgres://staging:5432/app
      type: VAR
      note: Database connection string
    - key: API_KEY
      value: secret
      type: VAR
      settable: ENABLED
  permissions:
    others: DENIED
    users:
      user@example.com: MANAGE
    groups:
      developers: USE_ONLY
    pipelines:
      - project: my-project
        pipeline: deploy
        access: USE_ONLY
    environments:
      - project: my-project
        environment: production
        access: USE_ONLY
  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: secret