Azure

  • 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 AZURE.
push_urlrequired string
The url to the repository.
git_auth_moderequired string
The authentication mode for Git Push. Should always be set to HTTP.
loginstring
The username required to connect to the server.
passwordstring
The password required to connect to the server.
use_custom_gitignoreboolean
When set to false the push will ignore paths listed in .gitignore file.
isolatedboolean
When set to true, action will push only repository files (without artifacts).
target_branchstring
Defines the remote branch to which the push will be performed. If empty, files will be pushed to the same branch.
deployment_excludesstring[]
The paths and/or files that will be left out during the push. Only works when use_custom_gitignore is set to true.
deployment_includesstring[]
The exceptions from the ignore patterns set in deployment_excludes.
without_forceboolean
Defines whether the --force flag should be used when invoking the git push command or not.

Last modified on Oct 7, 2024

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": "Push to Your Repo",
  "type": "AZURE",
  "git_auth_mode": "HTTP",
  "trigger_time": "ON_EVERY_EXECUTION",
  "push_url": "https://buddytestapp.scm.azurewebsites.net:443/BuddyTestApp.git",
  "login": "api_tests_user",
  "password": "api_tests_password",
  "isolated": true,
  "target_branch": "stage",
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ]
}'
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/851", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/851/edit", "id": 851, "name": "Push to Your Repo", "type": "AZURE", "git_auth_mode": "HTTP", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "deployment_excludes": [ "/tmp/", "*.log" ], "deployment_includes": [ "/assets/style", "/tmp/file.txt" ], "login": "api_tests_user", "push_url": "https://buddytestapp.scm.azurewebsites.net:443/BuddyTestApp.git", "push_tags": true, "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