TCP monitoring

POST Parameters

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to TCP.
destination
Required
StringThe target URL.
portStringThe port for the connection.
post_dataStringThe data that will be sent.
textStringText that should or should not be present in the response.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Check site status",
"type": "TCP",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"variables": [
{
"key": "hostName",
"value": "app.buddy.works"
}
],
"port": "8080",
"destination": "$hostName",
"post_data": "{\r\n\"test\": \"ok\"\r\n}",
"text": "ok"
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"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",
"trigger_condition": "ALWAYS",
"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",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}