Elastic Beanstalk Monitor

  • 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 MONITOR.
application_namerequired string
The name of the application.
environmentrequired string
The Amazon S3 environment.
integrationrequired Integration
The integration.
regionrequired string
The name of the Amazon S3 region. The full list of regions is available here.
fail_on_yellowoptional boolean
Defines whether or not the action should be marked as failed when Amazon returns ‘yellow’ health status.
verboseoptional boolean
Defines whether or not to show verbose logs.

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": "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
}'
EXAMPLE RESPONSE
{ "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999