TCP monitoring

POST
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

workspacerequired string

The workspace name.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to TCP.

destinationrequired string

The target URL.

portstring

The port for the connection.

post_datastring

The data that will be sent.

textstring

Text that should or should not be present in the response.

Last modified on Apr 8, 2025

Tag Docker Image Telegram notification

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Check site status",
  "type": "TCP",
  "trigger_time": "ON_EVERY_EXECUTION",
  "variables": [
    {
      "key": "hostName",
      "value": "app.buddy.works"
    }
  ],
  "port": "8080",
  "destination": "$hostName",
  "post_data": "{\r\n\"test\": \"ok\"\r\n}",
  "text": "ok"
}'

EXAMPLE RESPONSE
  {
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/859",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/859/edit",
  "id": 859,
  "name": "Check site status",
  "type": "TCP",
  "trigger_time": "ON_EVERY_EXECUTION",
  "variables": [
    {
      "key": "hostName",
      "value": "app.buddy.works"
    }
  ],
  "last_execution_status": "INITIAL",
  "port": "8080",
  "destination": "$hostName",
  "post_data": "{\r\n\"test\": \"ok\"\r\n}",
  "text": "ok",
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "Live mirror",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
  201 Created

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