Datadog Service Check

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
domainrequired string
The workspace domain.
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 DATADOG_STATUS_CHECK.
host_nameoptional string
The Host name to associate with the event. Any tags associated with the host will also be applied to this event.
statusoptional integer
An integer for the status of the check.
checkoptional string
The text for the message.
messageoptional string
A description of why this status occurred.
regionoptional string
The Datadog region. Can be one of US1, US3, US5, EU1, AP1, US1_FED. If not set, the default is US1.

Last modified on Oct 7, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Datadog Status Check Action",
  "type": "DATADOG_STATUS_CHECK",
  "trigger_time": "ON_EVERY_EXECUTION",
  "variables": [
    {
      "key": "datadogHost",
      "value": "linux"
    }
  ],
  "host_name": "$datadogHost",
  "status": 1,
  "check": "Pipeline Execution",
  "message": "And let me tell you all about it here!",
  "region": "EU1",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}'
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions/1", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1/action/1/edit", "id": 1, "name": "Datadog Status Check Action", "type": "DATADOG_STATUS_CHECK", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "datadogHost", "value": "linux" } ], "host_name": "$datadogHost", "check": "Pipeline Execution", "status": "OK", "message": "And let me tell you all about it here!", "region": "EU1", "integration": { "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1", "html_url": "https://app.buddy.works/integrations", "hash_id": "5ddb7c180fb38be67bd78a88a" }, "pipeline": { "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1", "id": 1, "name": "test server", "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