SSH Server

View as Markdown

GET
/workspaces
/:workspace
/targets
/:target_id

Get a specific SSH Server target by ID

Request

REQUIRED SCOPES

TARGET_INFO

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

target_idrequiredstring

Target unique identifier (hash ID)

Example: "tgt-1234567890abcdef"

Response

RESPONSE BODY

typestring enum

The type of the target

Allowed enum:

SSH

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 host for the connection

portrequiredstring

The port for the connection

pathstring

Path on the server defined in the target

authrequiredSSHAuthView

Define proxy servers' authentication method using the following parameters

proxyTargetSSHProxyView

Define a SSH proxy server using the following parameters (available only for SSH targets)

Last modified on Feb 18, 2026

Edit target Create target

Request example

CURL
curl -X GET "https://api.buddy.works/workspaces/:workspace/targets/:target_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json"

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/my-workspace/targets/tg-12345",
  "html_url": "https://app.buddy.works/targets/tg-12345",
  "id": "tg-12345",
  "identifier": "production-web-server",
  "name": "Production Web Server",
  "type": "SSH",
  "host": "web.example.com",
  "port": "22",
  "path": "/var/www/html",
  "auth": {
    "method": "SSH_KEY",
    "username": "deploy",
    "asset": "production-ssh-key"
  },
  "tags": [
    "production",
    "web",
    "deploy"
  ],
  "allPipelinesAllowed": false,
  "allowedPipelines": [
    {
      "project": "my-project",
      "pipeline": "deploy-pipeline"
    },
    {
      "project": "my-project",
      "pipeline": "hotfix-pipeline"
    }
  ],
  "permissions": {
    "others": "READ_ONLY",
    "users": [
      {
        "id": 42,
        "access_level": "USE_ONLY"
      }
    ],
    "groups": []
  }
}

STATUS
200 OK