Compress images

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to IMAGE_COMPRESSION.
local_path
Required
StringThe path in the repository.
destination
Required
StringOutput directory for compressed images.
level
Required
StringThe level of image compression. Can be set to 1 (low), 2 (medium) or 3 (high).
types
Required
StringSupported image formats. Available types: jpg, png, gif, svg.
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":"Compress images",
"type":"IMAGE_COMPRESSION",
"trigger_time":"ON_EVERY_EXECUTION",
"trigger_condition":"ALWAYS",
"local_path":"/local",
"destination":"/destination",
"level":"1",
"types":"jpg,png,gif,svg"
}

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/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
"id": 2,
"name": "Compression images",
"type": "IMAGE_COMPRESSION",
"trigger_time": "ON_EVERY_EXECUTION",
"last_execution_status": "INITIAL",
"local_path": "/assets",
"destination": "/destination",
"level": "1",
"types": "jpg,png,gif,svg",
"trigger_condition": "ALWAYS",
"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": "test server",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}