YAML for PostgreSQL

View as Markdown

PostgreSQL target for executing queries on a PostgreSQL database.

YAML parameters for PostgreSQL

PARAMETERS

hostrequiredstring

The hostname or IP address of the PostgreSQL server

targetrequiredstring

The human-readable ID of the target

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

permissionsPermissionsYaml

Access permissions for the target

disabledboolean

Indicates if this target is disabled (default: false)

tagsstring[]

The list of tags associated with 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: POSTGRESQL

Last modified on Sep 17, 2026

MySQL SSH Server

YAML examples for PostgreSQL

PostgreSQL target with password authentication

yaml
- target: production_pg
  type: POSTGRESQL
  name: Production PostgreSQL
  host: pg.example.com
  port: "5432"
  database: myapp
  auth:
    username: deploy_user
    password: $password
  proxy: my_ssh_bastion
  tags:
    - postgresql
    - production

Minimal

yaml
- target: production_pg
  type: POSTGRESQL
  host: pg.example.com
  auth:
    username: deploy_user
    password: $password