Elastic Beanstalk Monitor

POST Parameters

NameTypeDescription
application_name
Required
StringThe name of the application.
environment
Required
StringThe Amazon S3 environment.
region
Required
StringThe Amazon S3 region.
integration
Required
IntegrationThe integration.
name
Required
StringThe name of the action.
region
Required
StringThe name of the Amazon S3 region. The full list of regions is available here.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to MONITOR.
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.
wait_if_greyIntegerThe maximum time (in minutes) to wait while the application health is ‘grey’.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS or VAR_NOT_CONTAINS.

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",
"trigger_condition": "ALWAYS",
"integration": {
"id": 33
},
"application_name": "tests",
"region": "us-west-2",
"environment": "e-rnuptbebz2",
"fail_on_yellow": true,
"verbose": false,
"wait_if_grey": 5
}

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",
"trigger_condition": "ALWAYS",
"last_execution_status": "INITIAL",
"run_only_on_first_failure": false,
"application_name": "tests",
"environment": "e-rnuptbebz2",
"region": "us-east-1",
"fail_on_yellow": true,
"verbose": false,
"wait_if_grey": 5,
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/33",
"html_url": "https://app.buddy.works/my-id",
"id": 33
},
"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"
}
}