Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

AWS RDS for SQL Server

View as Markdown
  • PATCH
  • /workspaces
  • /:workspace
  • /targets
  • /:target_id

Update AWS RDS for SQL Server target configuration

Request

REQUIRED SCOPES
TARGET_MANAGE
URL PARAMETERS
workspacerequiredstring
The human-readable ID of the workspace

Example: "my-company"

target_idrequiredstring
Target unique identifier (hash ID)

Example: "tgt-1234567890abcdef"

BODY PARAMETERS
typestring
The type of the target

Value: RDS_MSSQL

identifierrequiredstring
A human-readable ID. Alphanumeric characters, underscores, and hyphens (hyphens cannot appear at the start or end).
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 MSSQL server
authrequiredMssqlAuthView
MSSQL 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 MSSQL server. Default: 1433
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)
Allowed enum:
DISABLE,
REQUIRE,
VERIFY_FULL
ca_certificatestring
PEM-encoded CA certificate (required when sslMode is VERIFY_FULL)
proxyTargetK8sProxyView
SSH proxy target for tunneling to private MSSQL servers

Response

RESPONSE BODY
typestring
The type of the target

Value: RDS_MSSQL

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)
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 MSSQL server
portstring
The port of the MSSQL server. Default: 1433
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)
Allowed enum:
DISABLE,
REQUIRE,
VERIFY_FULL
ca_certificatestring
PEM-encoded CA certificate (required when sslMode is VERIFY_FULL)
authrequiredMssqlAuthView
MSSQL authentication credentials
proxyTargetK8sProxyView
SSH proxy target for tunneling to private MSSQL servers

Last modified on May 19, 2026

Previous pageCreate targetNext pageGet target

Request example

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