Contentful CLI

POST
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

workspacerequired string

The workspace name.

project_namerequired string

The name ID of the project.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to CONTENTFUL_CLI.

environmentrequired string

The ID of the environment.

integrationrequired Integration

The integration configuration with identifier, type, and scope.

execute_commandsrequired string[]

The commands that will be executed.

spacerequired string

The Contentful space ID where the operations will be performed.

Last modified on Sep 16, 2025

Compress images Copy files

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Run Contentful CLI",
  "type": "CONTENTFUL_CLI",
  "trigger_time": "ON_EVERY_EXECUTION",
  "integration": {
    "identifier": "CONTENTFUL_TOKEN",
    "type": "CONTENTFUL",
    "scope": "WORKSPACE"
  },
  "environment": "master",
  "execute_commands": [
    "contentful space list"
  ],
  "space": "Blank"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/30337/actions/884",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/30337/action/884/edit",
  "id": 884,
  "name": "Run Contentful CLI",
  "type": "CONTENTFUL_CLI",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "disabled": false,
  "environment": "master",
  "integration": {
    "identifier": "CONTENTFUL_TOKEN"
  },
  "execute_commands": [
    "contentful space list"
  ],
  "space": "Blank",
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/30337",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/30337",
    "id": 30337,
    "identifier": "add-action-content",
    "name": "add-action-content",
    "definition_source": "LOCAL",
    "git_config_ref": "NONE",
    "refs": [
      ":default"
    ],
    "events": [
      {
        "type": "WEBHOOK",
        "totp": false
      }
    ],
    "priority": "NORMAL",
    "disabled": false,
    "last_execution_status": "INITIAL",
    "always_from_scratch": false,
    "ignore_fail_on_project_status": false,
    "strict_context": false,
    "no_skip_to_most_recent": false,
    "terminate_stale_runs": false,
    "auto_clear_cache": false,
    "fetch_all_refs": false,
    "fail_on_prepare_env_warning": true,
    "concurrent_pipeline_runs": false,
    "do_not_create_commit_status": false,
    "stale": false,
    "waiting_for_push": false,
    "resources": "DEFAULT",
    "git_changeset_base": "LATEST_RUN",
    "filesystem_changeset_base": "DATE_MODIFIED",
    "cpu": "X64",
    "description_required": false
  },
  "ignore_errors": false,
  "shell": "SH",
  "run_next": "WAIT_ON_SUCCESS"
}

STATUS
201 Created

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