WEBINARSandboxes for AI agents, Oct 7th.Claude Code and Cursor get their own Sandbox. See it live Oct 7th.Save my seat
Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitCLIAPIFAQ

Microsoft SQL Server

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

Update Microsoft SQL Server target configuration

Request

REQUIRED SCOPES
TARGET_WRITE
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: MSSQL

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
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). 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)
authrequiredMssqlAuthView
MSSQL authentication credentials
proxyTargetK8sProxyView
SSH proxy target for tunneling to private ClickHouse servers

Response

RESPONSE BODY
typestring
The type of the target

Value: 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
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
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). 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)
authrequiredMssqlAuthView
MSSQL authentication credentials
proxyTargetK8sProxyView
SSH proxy target for tunneling to private ClickHouse servers

Last modified on Sep 28, 2026

Previous pageCreate targetNext pageCreate target with YAML

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": "MSSQL",
  "identifier": "production-mssql",
  "name": "Production MSSQL",
  "host": "mssql.example.com",
  "port": "1433",
  "database": "app",
  "auth": {
    "method": "PASSWORD",
    "username": "app_user",
    "password": "secured"
  },
  "tags": [
    "mssql",
    "production"
  ]
}'
STATUS
200 OK