Get

GET
/workspaces
/:workspace
/targets
/:target_id

Returns the details of a single target.

Request

REQUIRED SCOPES

WORKSPACE, TARGET_INFO

URL PARAMETERS

workspacerequired string

The workspace name.

target_idrequired string

ID of the desired target.

Last modified on May 19, 2025

Create List

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/buddy/targets/tg-nd2oxobzr7p2r",
  "html_url": "https://app.buddy.works/buddy/targets/tg-nd2oxobzr7p2r/edit",
  "id": "tg-nd2oxobzr7p2r",
  "identifier": "stage_env",
  "permissions": {
    "others": "USE_ONLY",
    "users": [
      {
        "id": 5,
        "access_level": "MANAGE"
      }
    ]
  },
  "tags": [
    "tag1",
    "staging"
  ],
  "name": "Staging environment",
  "host": "192.168.0.100",
  "port": "22",
  "path": "/var/www/stage",
  "auth": {
    "method": "PASSWORD",
    "username": "deploy_user",
    "password": "!encrypted 3PA3jdHEb0WutNZNaGFXvWMSh0oAD0CxLkUzSq0cKCxPYPxtmIL3dQlFMAjvbcvL.hLyKo3tOxlgpSTieglJTJw=="
  },
  "type": "SSH"
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999