Elastic Beanstalk Monitor

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to MONITOR.
application_name
Required
StringThe name of the application.
environment
Required
StringThe Amazon S3 environment.
integration
Required
IntegrationThe integration.
region
Required
StringThe name of the Amazon S3 region. The full list of regions is available here.
fail_on_yellowBooleanDefines whether or not the action should be marked as failed when Amazon returns ‘yellow’ health status.
verboseBooleanDefines whether or not to show verbose logs.

Example

Request

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

JSON

{
  "name": "Monitor Elastic Beanstalk/tests",
  "type": "MONITOR",
  "trigger_time": "ON_EVERY_EXECUTION",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "application_name": "tests",
  "region": "us-west-2",
  "environment": "e-rnuptbebz2",
  "fail_on_yellow": true,
  "verbose": false,
  "timeout": 600
}

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/845",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/845/edit",
  "id": 845,
  "name": "Monitor Elastic Beanstalk/tests",
  "type": "MONITOR",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "application_name": "tests",
  "environment": "e-rnuptbebz2",
  "region": "us-east-1",
  "fail_on_yellow": true,
  "verbose": false,
  "timeout": 600,
  "integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/33",
    "html_url": "https://app.buddy.works/my-id",
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "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

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

Sign up for free and deploy your project in less than 10 minutes.