Compress images

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 IMAGE_COMPRESSION.

local_pathrequired string

The path in the repository.

destinationrequired string

Output directory for compressed images.

levelrequired string

The level of image compression. Can be set to 1 (low), 2 (medium) or 3 (high).

typesrequired string

Supported image formats. Available types: jpg, png, gif, svg.

Last modified on Sep 27, 2024

CodeDeploy Copy files

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": "Compress images",
  "type": "IMAGE_COMPRESSION",
  "trigger_time": "ON_EVERY_EXECUTION",
  "local_path": "/local",
  "destination": "/destination",
  "level": "1",
  "types": "jpg,png,gif,svg"
}'

EXAMPLE RESPONSE
{
  "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"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999