Azure CLI

  • 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_CLI.
execute_commandsrequired string[]
The commands that will be executed.
integrationrequired Integration
The integration.
application_nameoptional string
The name of the application.
shelloptional string
The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.
setup_commandsoptional string[]
The command that will be executed only on the first run.

Last modified on Sep 27, 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": "Azure Cli",
  "type": "AZURE_CLI",
  "trigger_time": "ON_EVERY_EXECUTION",
  "integration": {
    "hash_id": "5ed4fe6446e03e110be748d5"
  },
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "az webapp list"
  ],
  "shell": "SH"
}'
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions/1", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1/action/1/edit", "id": 1, "name": "Azure Cli", "type": "AZURE_CLI", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "disabled": false, "integration": { "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1", "html_url": "https://app.dev.io/my-id", "hash_id": "5ed4fe6446e03e110be748d5" }, "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "az webapp list" ], "shell": "SH", "pipeline": { "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1", "id": 1, "name": "test server", "on": "CLICK", "refs": [ "refs/heads/master" ], "last_execution_status": "SUCCESSFUL" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999