DigitalOcean (Password)

  • 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 DIGITAL_OCEAN.
authentication_moderequired string
The authentication mode for SSH. Should be set to PASS.
hostrequired string
The host for the connection.
host_namerequired string
The hostname of the Digital server.
loginrequired string
The username required to connect to the server.
portrequired string
The port for the connection.
integrationrequired string
The integration.
input_typeoptional string
Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathoptional string
The path in the repository.
passwordoptional string
The password required to connect to the server.
remote_pathoptional string
The absolute or relative path on the remote server.
deployment_excludesoptional string[]
The paths and/or files that will be left out during the deployment.
deployment_includesoptional string[]
The exceptions from the ignore patterns set in deployment_excludes.

Last modified on Sep 23, 2024

{
  "name": "Upload files to DO droplet",
  "type": "DIGITAL_OCEAN",
  "trigger_time": "ON_EVERY_EXECUTION",
  "authentication_mode": "PASS",
  "host": "123.45.67.89",
  "host_name": "buddy-tests",
  "port": "22",
  "login": "DO_User",
  "password": "DO_Password",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/assets/",
  "remote_path": "Home/www/",
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ],
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}
{
  "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": "Upload files to DO droplet",
  "type": "DIGITAL_OCEAN",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/assets/",
  "remote_path": "Home/www/",
  "login": "DO_User",
  "host": "123.45.67.89",
  "host_name": "buddy-tests",
  "port": "22",
  "authentication_mode": "PASS",
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ],
  "integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
    "html_url": "https://app.buddy.works/my-id",
    "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",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}