TCP monitoring
Learn more about:
POST Parameters
| Name | Type | Description |
|---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to TCP. |
destination Required | String | The target URL. |
| port | String | The port for the connection. |
| post_data | String | The data that will be sent. |
| text | String | Text that should or should not be present in the response. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actionsJSON
{
"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"
}Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999JSON
{
"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"
}
}Last modified on November 16, 2022