List

GET
/workspaces
/:workspace
/targets

Retrieves targets from the workspace scope or from a specific entity if one filter (projectName, pipelineId, environmentId, or actionId) is provided. Only one filter can be used at a time.

Request

REQUIRED SCOPES

WORKSPACE, TARGET_INFO

URL PARAMETERS

workspacerequired string

The workspace name.

GET PARAMETERS

projectNamestring

Name of the project.

pipelineIdinteger

ID of the pipeline.

environmentIdinteger

ID of the environment.

actionIdinteger

ID of the action.

Last modified on May 19, 2025

Get Edit

Example:

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

EXAMPLE RESPONSE
{
  "targets": [
    {
      "type": "SSH",
      "identifier": "ubuntu_tests",
      "id": "tg-plib9o13mdapr",
      "host": "ubuntu.tests",
      "port": "22",
      "auth": {
        "method": "PASSWORD",
        "username": "buddy",
        "password": "secure!AF+pL5fhP8FQ2xjf15IbiQ==.+znyFTURT05v8zCHLD7Dow=="
      }
    },
    {
      "type": "MATCH",
      "identifier": "dev*",
      "scope": "ANY"
    }
  ]
}

STATUS
200 OK

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