AWS RDS for PostgreSQL

View as Markdown

POST
/workspaces
/:workspace
/targets

Create a new AWS RDS for PostgreSQL deployment target

Request

REQUIRED SCOPES

TARGET_WRITE

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

BODY PARAMETERS

typestring

The type of the target

Value: RDS_POSTGRESQL

idstring

The ID of the target

identifierrequiredstring

A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end).

namestring

The name of the target

projectShortProjectView

Short representation of a project

pipelineShortPipelineView

Short representation of a pipeline

environmentShortEnvironmentView

permissionsPermissionsView

Access permissions configuration

pipelines_access_levelstring enum

Pipelines access level for this target

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_pipelinesAllowedPipelineView[]

List of specific pipelines allowed to use this target

sandboxes_access_levelstring enum

Sandboxes access level for this target

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_sandboxesAllowedSandboxView[]

List of specific sandboxes allowed to use this target

disabledboolean

Indicates if this target is disabled (default: false)

tagsstring[]

The list of tags associated with the target

Constraints: Unique items required

use_asUseAsView

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

regionrequiredstring

AWS region of the RDS instance, e.g. us-east-1

db_instance_identifierrequiredstring

RDS DB instance identifier

integrationrequiredstring

Hash ID or identifier of an AWS integration

hostrequiredstring

The hostname or IP address of the PostgreSQL server

portstring

The port of the PostgreSQL server. Default: 5432

databasestring

The default database name

ssl_modestring enum

SSL mode: DISABLE (no encryption), REQUIRE (default; encrypted but server certificate is NOT validated, vulnerable to MITM), or VERIFY_FULL (encrypted with full server certificate validation; requires caCertificate). VERIFY_FULL cannot be combined with proxy: through an SSH tunnel the client connects to 127.0.0.1, so the server certificate fails hostname validation. With a proxy keep REQUIRE — TLS still terminates on the RDS instance, so the bastion never sees the wire protocol.

Allowed enum:

DISABLE,

REQUIRE,

VERIFY_FULL

ca_certificatestring

PEM-encoded CA certificate (required when sslMode is VERIFY_FULL)

authrequiredPostgresqlAuthView

PostgreSQL authentication credentials

proxyTargetK8sProxyView

SSH proxy target for tunneling to private ClickHouse servers

Response

RESPONSE BODY

typestring

The type of the target

Value: RDS_POSTGRESQL

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

idstring

The ID of the target

identifierrequiredstring

A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end).

namestring

The name of the target

projectShortProjectView

Short representation of a project

pipelineShortPipelineView

Short representation of a pipeline

environmentShortEnvironmentView

permissionsPermissionsView

Access permissions configuration

pipelines_access_levelstring enum

Pipelines access level for this target

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_pipelinesAllowedPipelineView[]

List of specific pipelines allowed to use this target

sandboxes_access_levelstring enum

Sandboxes access level for this target

Allowed enum:

DENIED,

READ_ONLY,

USE_ONLY,

BLIND,

RUN_ONLY,

READ_WRITE,

MANAGE,

DEFAULT,

ALLOWED,

STAGE,

COMMIT

allowed_sandboxesAllowedSandboxView[]

List of specific sandboxes allowed to use this target

disabledboolean

Indicates if this target is disabled (default: false)

tagsstring[]

The list of tags associated with the target

Constraints: Unique items required

use_asUseAsView

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

regionrequiredstring

AWS region of the RDS instance, e.g. us-east-1

db_instance_identifierrequiredstring

RDS DB instance identifier

integrationrequiredstring

Hash ID or identifier of an AWS integration

hostrequiredstring

The hostname or IP address of the PostgreSQL server

portstring

The port of the PostgreSQL server. Default: 5432

databasestring

The default database name

ssl_modestring enum

Allowed enum:

DISABLE,

REQUIRE,

VERIFY_FULL

ca_certificatestring

PEM-encoded CA certificate (required when sslMode is VERIFY_FULL)

authrequiredPostgresqlAuthView

PostgreSQL authentication credentials

proxyTargetK8sProxyView

SSH proxy target for tunneling to private ClickHouse servers

Last modified on Sep 28, 2026

Get target Edit target

Request example


curl -X POST "https://api.buddy.works/workspaces/:workspace/targets" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "RDS_POSTGRESQL",
  "identifier": "rds-postgresql-prod",
  "name": "Production PostgreSQL on RDS",
  "integration": "aws-prod",
  "region": "us-east-1",
  "db_instance_identifier": "my-prod-postgresql",
  "host": "my-prod-postgresql.abc123.us-east-1.rds.amazonaws.com",
  "port": "5432",
  "database": "production",
  "ssl_mode": "REQUIRE",
  "auth": {
    "method": "PASSWORD",
    "username": "admin",
    "password": "secured"
  },
  "tags": [
    "rds",
    "postgresql",
    "production"
  ]
}'

STATUS
201 Created