Compress images

POST Parameters

Name	Type	Description
name `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `IMAGE_COMPRESSION`.
local_path `Required`	String	The path in the repository.
destination `Required`	String	Output directory for compressed images.
level `Required`	String	The level of image compression. Can be set to `1` (low), `2` (medium) or `3` (high).
types `Required`	String	Supported image formats. Available types: `jpg`, `png`, `gif`, `svg`.

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",
  "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",
  "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",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

Last modified on September 26, 2022

Compress images

Knowledge is power!