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

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. Must be set to GIT_LAB_CLI.

setup_commandsstring

The command that will be executed only on the first run.

execute_commandsrequired string

The commands that will be executed.

integrationrequired Integration

Integration details.

integration_hashrequired string

The ID of the integration.

shellstring

The name of the shell that will be used to execute commands. Can be one of BASH (default) or SH.

Last modified on Apr 8, 2025

Previous pageGitHub Release Next pageGKE Apply Deployment

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 GitLab CLI command",
 "type": "GIT_LAB_CLI",
 "trigger_time": "ON_EVERY_EXECUTION",
 "setup_commands": [
 "apt-get update && apt-get -y install git"
 ],
 "execute_commands": [
 "glab auth status"
 ],
 "shell": "BASH",
 "integration": {
 "hash_id": "5ddb7c180fb38be67bd78a88a"
 }
}'

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/action/2/edit",
 "id": 2,
 "name": "Run GitLab CLI command",
 "type": "GIT_LAB_CLI",
 "trigger_time": "ON_EVERY_EXECUTION",
 "last_execution_status": "INITIAL",
 "setup_commands": [
 "apt-get update && apt-get -y install git"
 ],
 "execute_commands": [
 "glab auth status"
 ],
 "shell": "BASH",
 "integration": {
 "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