Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesSelf-HostedAgents & TunnelsYAML

MySQL

View as Markdown
  • POST
  • /workspaces
  • /:workspace
  • /targets

Create a new MySQL deployment target

Request

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

Example: "my-company"

POST PARAMETERS
typestring enum
The type of the target
Allowed enum:
MYSQL
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
all_pipelines_allowedboolean
Indicates if all pipelines are allowed to use this target
allowed_pipelinesAllowedPipelineView[]
List of specific pipelines allowed to use this target

Constraints: Unique items required

disabledboolean
Indicates if this target is disabled (default: false)
tagsstring[]
The list of tags associated with the target

Constraints: Unique items required

hostrequiredstring
The hostname or IP address of the MySQL server
portstring
The port of the MySQL server. Default: 3306
databasestring
The default database name
authrequiredMysqlAuthView
MySQL authentication credentials
proxyTargetK8sProxyView
SSH proxy target for tunneling to private MySQL servers

Response

RESPONSE BODY
typestring enum
The type of the target
Allowed enum:
MYSQL
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
all_pipelines_allowedboolean
Indicates if all pipelines are allowed to use this target
allowed_pipelinesAllowedPipelineView[]
List of specific pipelines allowed to use this target

Constraints: Unique items required

disabledboolean
Indicates if this target is disabled (default: false)
tagsstring[]
The list of tags associated with the target

Constraints: Unique items required

hostrequiredstring
The hostname or IP address of the MySQL server
portstring
The port of the MySQL server. Default: 3306
databasestring
The default database name
authrequiredMysqlAuthView
MySQL authentication credentials
proxyTargetK8sProxyView
SSH proxy target for tunneling to private MySQL servers

Last modified on Feb 18, 2026

Previous pageGet targetNext pageEdit 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": "MYSQL",
  "identifier": "production-db",
  "name": "Production MySQL",
  "host": "db.example.com",
  "port": 3306,
  "database": "myapp",
  "auth": {
    "method": "PASSWORD",
    "username": "deploy_user",
    "password": "secured"
  },
  "tags": [
    "mysql",
    "production"
  ]
}'
STATUS
201 Created