PostgreSQL

View as Markdown

POST
/workspaces
/:workspace
/targets

Create a new PostgreSQL deployment target

Request

REQUIRED SCOPES

TARGET_ADD

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

BODY PARAMETERS

typestring

The type of the target

Value: POSTGRESQL

identifierrequiredstring

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

hostrequiredstring

The hostname or IP address of the PostgreSQL server

authrequiredPostgresqlAuthView

PostgreSQL authentication credentials

idstring

The ID of the target

namestring

The name of the target

projectShortProjectView

Short representation of a project

pipelineShortPipelineView

Short representation of a pipeline

environmentShortEnvironmentView

Short representation of an environment object

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)

portstring

The port of the PostgreSQL server. Default: 5432

databasestring

The default database name

proxyTargetK8sProxyView

SSH proxy target for tunneling to private PostgreSQL servers

Response

RESPONSE BODY

typestring

The type of the target

Value: 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

Short representation of an environment object

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)

hostrequiredstring

The hostname or IP address of the PostgreSQL server

portstring

The port of the PostgreSQL server. Default: 5432

databasestring

The default database name

authrequiredPostgresqlAuthView

PostgreSQL authentication credentials

proxyTargetK8sProxyView

SSH proxy target for tunneling to private PostgreSQL servers

Last modified on Apr 27, 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": "POSTGRESQL",
  "identifier": "production-pg",
  "name": "Production PostgreSQL",
  "host": "pg.example.com",
  "port": 5432,
  "database": "myapp",
  "auth": {
    "method": "PASSWORD",
    "username": "deploy_user",
    "password": "secured"
  },
  "tags": [
    "postgresql",
    "production"
  ]
}'

STATUS
201 Created