YAML for SSH Server

View as Markdown

SSH target for deploying to remote servers via SSH connection.

YAML parameters for SSH Server

PARAMETERS

hostrequiredstring

The host for the connection

targetrequiredstring

The human-readable ID of the target

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

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

typestring

Value: SSH

Last modified on Sep 17, 2026

PostgreSQL UpCloud Server

YAML examples for SSH Server

SSH target with password authentication and proxy

yaml
- target: my_ssh_target_action
  type: SSH
  name: name
  host: ubuntu.tests
  path: /path
  auth:
    method: PASSWORD
    username: buddy
    password: $password
  proxy: my_ssh_2
  tags:
    - tag1

With Proxy Inline

yaml
- target: ssh_with_proxy_inline
  type: SSH
  name: name
  host: ubuntu.tests
  auth:
    method: PASSWORD
    username: buddy
    password: $password
  proxy:
    host: ubuntu.tests
    auth:
      method: PASSWORD
      username: buddy
      password: $password

With Permissions

yaml
- target: ubuntu_project
  type: SSH
  host: ubuntu.testss
  auth:
    method: "PASSWORD"
    username: buddy
    password: secure!+EeFMrybg4nNIbPaNi51dg==.9aJZfUp7fN1FjqgGWwQKlA==
  permissions:
    others: USE_ONLY
    users:
      user@gmail.com: MANAGE
    pipelines:
      - all: READ_WRITE
      - project: sroda
        pipeline: dsadsa123
      - project: sroda
        pipeline: dsadsa