Azure Storage

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. Should be set to AZURE_STORAGE.

bucket_namerequired string

The name of the bucket.

integrationrequired Integration

The integration.

input_typestring

Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.

local_pathstring

The path in the repository.

remote_pathstring

The absolute or relative path on the remote server.

deployment_excludesstring[]

The paths and/or files that will be left out during the deployment.

deployment_includesstring[]

The exceptions from the ignore patterns set in deployment_excludes.

application_namestring

The name of the application.

deletion_disabledboolean

If set to true, files are not deleted if changeset indcates that.

skip_content_type_settingboolean

When set to true, all files will have their mime-types set to application/octet-stream.

content_encodingstring

ContentEncoding that will be set for the deployed files e.g. "gzip".

Last modified on Apr 8, 2025

Previous pageAzure CLI Next pageBackblaze B2

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": "Upload files to Azure Storage",
 "type": "AZURE_STORAGE",
 "input_type": "BUILD_ARTIFACTS",
 "trigger_time": "ON_EVERY_EXECUTION",
 "local_path": "/assets",
 "remote_path": "/remote",
 "bucket_name": "buddytest",
 "deletion_disabled": true,
 "integration": {
 "hash_id": "5ed4fe6446e03e110be748d5"
 },
 "application_name": "buddytests",
 "application_display_name": "buddytests",
 "skip_content_type_setting": false,
 "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/2",
 "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
 "id": 2,
 "name": "Upload files to Azure Storage",
 "type": "AZURE_STORAGE",
 "trigger_time": "ON_EVERY_EXECUTION",
 "input_type": "BUILD_ARTIFACTS",
 "local_path": "/assets",
 "remote_path": "/remote",
 "bucket_name": "buddytest",
 "application_name": "buddytests",
 "application_display_name": "buddytests",
 "integration": {
 "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
 "html_url": "https://app.buddy.works/my-id",
 "hash_id": "5ed4fe6446e03e110be748d5"
 },
 "deletion_disabled": true,
 "skip_content_type_setting": false,
 "deployment_excludes": [
 "/tmp/",
 "*.log"
 ],
 "deployment_includes": [
 "/assets/style",
 "/tmp/file.txt"
 ],
 "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