The DeployHQ connector lets your AI agent act in each user's DeployHQ account. Each user connects their own DeployHQ API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 31 · 21 · 831 read21 write8 destructive
- Users sign in with
- Username and password
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the DeployHQ connection
In AgentKit > Connections, create a DeployHQ connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_tooldeployhq_account_getGet the DeployHQ account: name, permalink, plan and limits.Read-onlyGet Account
Get the DeployHQ account: name, permalink, plan and limits. Use this to check the connection.
Inputs
This tool takes no inputs.
deployhq_auto_deployments_listList which servers and groups of a project deploy automatically on push, and the project's webhook URL.Read-onlyList Automatic Deployment Settings
List which servers and groups of a project deploy automatically on push, and the project's webhook URL.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_build_commands_listList the build pipeline commands of a project, in order.Read-onlyList Build Commands
List the build pipeline commands of a project, in order.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_config_file_getGet one config file of a project with its contents.Read-onlyGet Config File
Get one config file of a project with its contents.
Inputs
idstringrequired- Identifier of the config file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_config_files_listList the config files a project uploads on each deployment.Read-onlyList Config Files
List the config files a project uploads on each deployment.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_deployment_getGet one deployment.Read-onlyGet Deployment
Get one deployment. Returns its status (pending, running, completed, failed or a preview state), revisions, servers, files changed, steps and timings.
Inputs
idstringrequired- Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_deployment_step_logs_listList the log entries of one step of a deployment.Read-onlyList Deployment Step Logs
List the log entries of one step of a deployment. Use this to see why a deployment failed; step identifiers come from deployhq_deployment_get.
Inputs
deployment_idstringrequired- Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
step_idstringrequired- Identifier of the deployment step. Example: b2c3d4e5-f6a7-8901-bcde-f12345678901.
beforeinteger- Return log entries with an ID below this one, to page back. Example: 1500.
deployhq_deployments_listList the deployments of a project, newest first.Read-onlyList Deployments
List the deployments of a project, newest first. Returns per deployment its identifier, servers, start and end revisions, status, deployer and times. Use deployhq_deployment_get for its steps.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
currently_runningstring- Set to 1 to list only running deployments. Example: 1.one of
1 pageinteger- Page number, starting at 1. Example: 2.
per_pageinteger- Deployments per page (default 10). Example: 25.
tostring- Only deployments to this server or server group identifier. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
deployhq_environment_variable_getGet one environment variable of a project.Read-onlyGet Environment Variable
Get one environment variable of a project.
Inputs
idstringrequired- Identifier of the environment variable. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_environment_variables_listList a project's environment variables (locked values are masked).Read-onlyList Environment Variables
List a project's environment variables (locked values are masked).
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_excluded_files_listList the file patterns a project never uploads.Read-onlyList Excluded Files
List the file patterns a project never uploads.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_integrations_listList the notification integrations of a project (Slack, email, webhooks and others).Read-onlyList Integrations
List the notification integrations of a project (Slack, email, webhooks and others).
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_language_versions_listList the language runtimes and versions available to build pipelines (Node, Ruby, PHP, Python and so on).Read-onlyList Language Versions
List the language runtimes and versions available to build pipelines (Node, Ruby, PHP, Python and so on).
Inputs
This tool takes no inputs.
deployhq_profile_getGet the profile of the user whose API key is used: name, email, time zone and preferences.Read-onlyGet My Profile
Get the profile of the user whose API key is used: name, email, time zone and preferences.
Inputs
This tool takes no inputs.
deployhq_project_getGet one project by permalink.Read-onlyGet Project
Get one project by permalink. Returns its name, repository, zone, public key, notification settings and last deployment.
Inputs
idstringrequired- Permalink (identifier) of the project. Example: my-website.
deployhq_project_insights_getGet deployment statistics for a project over a period, such as deployment counts, success rate and durations.Read-onlyGet Project Deployment Insights
Get deployment statistics for a project over a period, such as deployment counts, success rate and durations.
Inputs
idstringrequired- Permalink (identifier) of the project. Example: my-website.
periodinteger- Days to aggregate: 30, 90, 180 or 365. Example: 90.
deployhq_project_undeployed_changes_listList the commits not yet deployed to each server of a project.Read-onlyList Undeployed Changes
List the commits not yet deployed to each server of a project. Use this before deploying to see what will go out.
Inputs
idstringrequired- Permalink (identifier) of the project. Example: my-website.
deployhq_projects_listList all projects.Read-onlyList Projects
List all projects. Returns per project its name, permalink (the identifier other tools take), repository, zone, last deployment and status. Use deployhq_project_get for one project.
Inputs
This tool takes no inputs.
deployhq_repository_branches_listList the branches of a project's repository with their latest commit.Read-onlyList Repository Branches
List the branches of a project's repository with their latest commit.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_repository_getGet the repository connected to a project: URL, scm type, branch, hosting service and root path.Read-onlyGet Repository
Get the repository connected to a project: URL, scm type, branch, hosting service and root path.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_repository_latest_revision_getGet the latest commit (revision) of a branch.Read-onlyGet Latest Revision
Get the latest commit (revision) of a branch. Use it as end_revision when deploying.
Inputs
branchstringrequired- Branch name. Example: main.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_repository_recent_commits_listList recent commits on a branch of a project's repository with message, author and date.Read-onlyList Recent Commits
List recent commits on a branch of a project's repository with message, author and date.
Inputs
branchstringrequired- Branch name. Example: main.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
updatestring- Set to 1 to fetch the repository before listing commits. Example: 1.one of
1
deployhq_scheduled_deployments_listList the scheduled deployments of a project with their server, frequency and next run.Read-onlyList Scheduled Deployments
List the scheduled deployments of a project with their server, frequency and next run.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_server_getGet one server of a project.Read-onlyGet Server
Get one server of a project. Returns its protocol, connection details (without secrets), path, branch, environment and last deployed revision.
Inputs
idstringrequired- Identifier of the server. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_server_group_getGet one server group of a project with its servers.Read-onlyGet Server Group
Get one server group of a project with its servers.
Inputs
idstringrequired- Identifier of the server group. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_server_groups_listList the server groups of a project (sets of servers deployed together).Read-onlyList Server Groups
List the server groups of a project (sets of servers deployed together). Returns per group its identifier, name, branch and servers.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_servers_listList the servers (deployment targets) of a project.Read-onlyList Servers
List the servers (deployment targets) of a project. Returns per server its identifier, name, protocol, host, path, branch, environment and last revision.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_ssh_commands_listList the SSH commands a project runs on its servers before or after deployments.Read-onlyList SSH Commands
List the SSH commands a project runs on its servers before or after deployments.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_test_access_getGet the results of a server connection test, per server.Read-onlyGet Server Access Test Results
Get the results of a server connection test, per server.
Inputs
idstringrequired- Identifier of the access test. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_users_listList the account's users.Read-onlyList Users
List the account's users. Returns per user their identifier, name, email, role and status.
Inputs
This tool takes no inputs.
deployhq_zones_listList the deployment zones (regions DeployHQ deploys from).Read-onlyList Deployment Zones
List the deployment zones (regions DeployHQ deploys from). Returns per zone its id and name. Use this to pick a zone_id for a project.
Inputs
This tool takes no inputs.
deployhq_auto_deployments_updateTurn automatic deployment on push on or off for servers and server groups of a project.WriteUpdate Automatic Deployment Settings
Turn automatic deployment on push on or off for servers and server groups of a project. Returns the settings.
- Idempotent
Inputs
deployablesarrayrequired- Servers or groups to set, each with identifier and auto_deploy. Example: [{"identifier": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "auto_deploy": true}]
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_build_command_createAdd a command to a project's build pipeline.WriteCreate Build Command
Add a command to a project's build pipeline. Returns the command.
Inputs
commandstringrequired- Shell command to run in the build pipeline. Example: npm ci && npm run build.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
descriptionstring- Description. Example: Install and build assets.
enabledboolean- Whether the command runs. Example: true.
halt_on_errorboolean- Stop the deployment if the command fails. Example: true.
deployhq_build_command_updateUpdate a build command of a project.WriteUpdate Build Command
Update a build command of a project. Returns the command.
- Idempotent
Inputs
idstringrequired- Identifier of the build command. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
commandstring- Shell command to run in the build pipeline. Example: npm ci && npm run build.
descriptionstring- Description. Example: Install and build assets.
enabledboolean- Whether the command runs. Example: true.
halt_on_errorboolean- Stop the deployment if the command fails. Example: true.
deployhq_config_file_createAdd a config file that is uploaded to the servers on each deployment.WriteCreate Config File
Add a config file that is uploaded to the servers on each deployment. Returns the config file.
Inputs
bodystringrequired- File contents. Example: production: host: db.internal.
pathstringrequired- Path the file is written to on the server, relative to the deployment path. Example: config/database.yml.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
buildboolean- Also write the file in the build environment. Example: false.
descriptionstring- Description. Example: Production database settings.
deployhq_config_file_updateUpdate a config file of a project.WriteUpdate Config File
Update a config file of a project. Returns the config file.
- Idempotent
Inputs
idstringrequired- Identifier of the config file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
bodystring- File contents. Example: production: host: db.internal.
buildboolean- Also write the file in the build environment. Example: false.
descriptionstring- Description. Example: Production database settings.
pathstring- Path the file is written to on the server, relative to the deployment path. Example: config/database.yml.
deployhq_deployment_abortAbort a running deployment.WriteAbort Deployment
Abort a running deployment. Returns the deployment.
Inputs
idstringrequired- Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_deployment_createQueue a deployment of a revision range to a server or server group, or create a preview of the changes without deploying (mode preview).WriteDeploy or Preview
Queue a deployment of a revision range to a server or server group, or create a preview of the changes without deploying (mode preview). Returns the deployment with its identifier and status. Use deployhq_deployment_get to follow it.
Inputs
parent_identifierstringrequired- Identifier of the server or server group, from deployhq_servers_list or deployhq_server_groups_list. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
branchstring- Branch to deploy. Example: main.
copy_config_filesboolean- Upload the project's config files. Example: true.
end_revisionstring- Commit to deploy up to. Leave empty with use_latest true to deploy the latest commit. Example: 4f2a9c1e8b7d6a5f4e3d2c1b0a9f8e7d6c5b4a39.
modestring- queue to deploy now, preview to see the changes without deploying. Example: queue.one of
queuepreview notification_addressesstring- Extra email addresses to notify, comma-separated. Example: ops@example.com.
run_build_commandsboolean- Run the build pipeline. Example: true.
skip_if_not_changesboolean- Skip the deployment when there are no changes. Example: false.
start_revisionstring- Commit to deploy from; defaults to the server's last deployed revision. Example: 1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b.
use_build_cacheboolean- Use the build cache. Example: true.
use_latestboolean- Deploy the latest commit of the branch. Example: true.
deployhq_deployment_retryRetry a failed deployment.WriteRetry Deployment
Retry a failed deployment. Returns the new deployment.
Inputs
idstringrequired- Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_deployment_rollbackRoll the servers of a deployment back to the revision before it, or preview the rollback.WriteRoll Back Deployment
Roll the servers of a deployment back to the revision before it, or preview the rollback. Returns the rollback deployment.
Inputs
idstringrequired- Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
copy_config_filesboolean- Copy config files during the rollback (default true). Example: true.
modestring- preview to preview the rollback, queue to run it now (default). Example: queue.one of
queuepreview run_build_commandsboolean- Run build commands during the rollback (default true). Example: true.
deployhq_environment_variable_createAdd an environment variable to a project.WriteCreate Environment Variable
Add an environment variable to a project. Returns the variable.
Inputs
namestringrequired- Variable name. Example: API_URL.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
valuestringrequired- Variable value. Example: https://api.example.com.
build_pipelineboolean- Also expose it to build commands. Example: true.
lockedboolean- Hide the value after saving. Example: false.
deployhq_environment_variable_updateUpdate an environment variable of a project.WriteUpdate Environment Variable
Update an environment variable of a project. Returns the variable.
- Idempotent
Inputs
idstringrequired- Identifier of the environment variable. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
build_pipelineboolean- Also expose it to build commands. Example: true.
lockedboolean- Hide the value after saving. Example: false.
namestring- Variable name. Example: API_URL.
valuestring- Variable value. Example: https://api.example.com.
deployhq_excluded_file_createExclude a file or pattern from deployments.WriteAdd Excluded File
Exclude a file or pattern from deployments. Returns the excluded file.
Inputs
pathstringrequired- Path or glob pattern to exclude. Example: node_modules/**.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_project_createCreate a project, optionally from a template or in a zone.WriteCreate Project
Create a project, optionally from a template or in a zone. Returns the new project with its permalink and public SSH key. Use deployhq_repository_update and deployhq_server_create to finish setup.
Inputs
namestringrequired- Project name. Example: My Website.
template_idstring- Identifier of a template to pre-populate servers, config files and settings. Example: wordpress-template.
zone_idstring- ID of the deployment zone, from deployhq_zones_list. Example: 3.
deployhq_project_updateUpdate a project's name, permalink, zone, notification settings or AI overview instructions.WriteUpdate Project
Update a project's name, permalink, zone, notification settings or AI overview instructions. Returns the updated project.
- Idempotent
Inputs
idstringrequired- Permalink (identifier) of the project. Example: my-website.
ai_overview_custom_instructionsstring- Instructions for the AI deployment overview. Example: Highlight database migrations.
email_notify_onstring- When to email notifications, e.g. never, failure or always. Example: failure.
namestring- Project name. Example: My Website.
notification_emailstring- Email address for deployment notifications. Example: ops@example.com.
notify_committerboolean- Also notify the committer of the deployed changes. Example: true.
permalinkstring- New permalink (URL identifier). Example: my-website-2.
zone_idstring- ID of the deployment zone. Example: 3.
deployhq_repository_updateChange the default branch, root path or hosting service of a project's repository.WriteUpdate Repository
Change the default branch, root path or hosting service of a project's repository. Returns the repository.
- Idempotent
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
branchstring- Default branch to deploy. Example: main.
hosting_service_typestring- Hosting service, e.g. github, gitlab or bitbucket. Example: github.
root_pathstring- Subdirectory of the repository to deploy. Example: public.
deployhq_scheduled_deployment_createSchedule a deployment to a server once in the future or on a recurring frequency.WriteSchedule Deployment
Schedule a deployment to a server once in the future or on a recurring frequency. Returns the scheduled deployment.
Inputs
frequencystringrequired- How often: future (once), daily, weekly, monthly or custom (cron schedule). Example: daily.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
server_identifierstringrequired- Identifier of the server or server group, from deployhq_servers_list or deployhq_server_groups_list. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
atstring- Time of day to deploy, HH:MM. Example: 02:30.
copy_config_filesboolean- Upload config files. Example: true.
dayinteger- Day of the month (monthly, or a one-off date). Example: 15.
monthinteger- Month of a one-off date. Example: 6.
run_build_commandsboolean- Run the build pipeline. Example: true.
schedulestring- Cron expression for custom schedules. Example: 0 3 * * 1-5.
skip_if_not_changesboolean- Skip when there are no changes. Example: true.
use_latestboolean- Deploy the latest commit at run time. Example: true.
weekdaystring- Day of the week for weekly schedules. Example: monday.
yearinteger- Year of a one-off date. Example: 2026.
deployhq_server_createAdd an SSH/SFTP, FTP/FTPS or Amazon S3 deployment target to a project.WriteCreate Server
Add an SSH/SFTP, FTP/FTPS or Amazon S3 deployment target to a project. SSH needs hostname and username; FTP also needs password; S3 needs bucket_name, access_key_id and secret_access_key. Returns the new server with its identifier.
Inputs
namestringrequired- Server name. Example: production-web-01.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
protocol_typestringrequired- Connection protocol: ssh (SSH/SFTP), ftp, ftps or s3. Example: ssh.one of
sshftpftpss3 access_key_idstring- AWS access key ID (S3). Example: AKIAIOSFODNN7EXAMPLE.
auto_deployboolean- Deploy automatically on push. Example: true.
branchstring- Branch to deploy to this server. Example: main.
bucket_namestring- S3 bucket name. Example: my-site-bucket.
email_notify_onstring- When to email notifications for this server: never, failure or always. Example: failure.one of
neverfailurealways enabledboolean- Whether the server receives deployments. Example: true.
environmentstring- Environment label, e.g. production or staging. Example: production.
hostnamestring- Host name or IP of the server (SSH, FTP). Example: example.com.
notification_emailstring- Email address for notifications. Example: ops@example.com.
passwordstring- Password (FTP, or SSH without key). Example: s3cret.
portinteger- Port, e.g. 22 for SSH or 21 for FTP. Example: 22.
root_pathstring- Subdirectory of the repository to deploy from. Example: public.
secret_access_keystring- AWS secret access key (S3). Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY.
server_group_identifierstring- Identifier of the server group to put the server in. Example: web-servers.
server_pathstring- Path on the server to deploy to. Example: /var/www/app.
use_ssh_keysboolean- Authenticate SSH with the project's key pair instead of a password. Example: true.
usernamestring- Login user name (SSH, FTP). Example: deploy.
deployhq_server_updateUpdate the fields you pass on a server.WriteUpdate Server
Update the fields you pass on a server. Returns the updated server.
- Idempotent
Inputs
idstringrequired- Identifier of the server. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
auto_deployboolean- Deploy automatically on push. Example: true.
branchstring- Branch to deploy to this server. Example: main.
email_notify_onstring- When to email notifications for this server: never, failure or always. Example: failure.one of
neverfailurealways enabledboolean- Whether the server receives deployments. Example: true.
environmentstring- Environment label, e.g. production or staging. Example: production.
namestring- Server name. Example: production-web-01.
notification_emailstring- Email address for notifications. Example: ops@example.com.
root_pathstring- Subdirectory of the repository to deploy from. Example: public.
server_group_identifierstring- Identifier of the server group to put the server in. Example: web-servers.
server_pathstring- Path on the server to deploy to. Example: /var/www/app.
deployhq_ssh_command_createAdd an SSH command that runs on the servers before or after each deployment.WriteCreate SSH Command
Add an SSH command that runs on the servers before or after each deployment. Returns the command.
Inputs
commandstringrequired- Shell command to run on the servers. Example: touch tmp/restart.txt.
descriptionstringrequired- Description of the command. Example: Restart the application.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
timeoutintegerrequired- Timeout in seconds: 300, 600, 1800, 3600, 5400 or 10800. Example: 300.
timingstringrequired- Which deployments run it: all, first (only the first deployment to a server) or after_first. Example: all.one of
allfirstafter_first cbackstring- Deployment stage: before_changes (default, before files change), before_symlink (zero-downtime deployments, before the release goes live) or after_changes. Example: after_changes.one of
before_changesbefore_symlinkafter_changes enabledboolean- Whether the command runs. Example: true.
halt_on_errorboolean- Stop the deployment if the command fails. Example: true.
deployhq_ssh_command_updateUpdate an SSH command of a project.WriteUpdate SSH Command
Update an SSH command of a project. Returns the command.
- Idempotent
Inputs
idstringrequired- Identifier of the SSH command. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
cbackstring- Deployment stage: before_changes (default, before files change), before_symlink (zero-downtime deployments, before the release goes live) or after_changes. Example: after_changes.one of
before_changesbefore_symlinkafter_changes commandstring- Shell command to run on the servers. Example: touch tmp/restart.txt.
descriptionstring- Description of the command. Example: Restart the application.
enabledboolean- Whether the command runs. Example: true.
halt_on_errorboolean- Stop the deployment if the command fails. Example: true.
timeoutinteger- Timeout in seconds: 300, 600, 1800, 3600, 5400 or 10800. Example: 300.
timingstring- Which deployments run it: all, first (only the first deployment to a server) or after_first. Example: all.one of
allfirstafter_first
deployhq_test_access_runStart a connection test from DeployHQ to every server of the project.WriteRun Server Access Test
Start a connection test from DeployHQ to every server of the project. Returns the test with its identifier; read results with deployhq_test_access_get.
Inputs
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_build_command_deleteDelete a build command from a project.DestructiveDelete Build Command
Delete a build command from a project.
- Idempotent
Inputs
idstringrequired- Identifier of the build command. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_config_file_deleteDelete a config file from a project.DestructiveDelete Config File
Delete a config file from a project.
- Idempotent
Inputs
idstringrequired- Identifier of the config file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_environment_variable_deleteDelete an environment variable from a project.DestructiveDelete Environment Variable
Delete an environment variable from a project.
- Idempotent
Inputs
idstringrequired- Identifier of the environment variable. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_excluded_file_deleteStop excluding a file or pattern.DestructiveDelete Excluded File
Stop excluding a file or pattern.
- Idempotent
Inputs
idstringrequired- Identifier of the excluded file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_project_deleteDelete a project with its servers, deployments and settings.DestructiveDelete Project
Delete a project with its servers, deployments and settings. This cannot be undone.
- Idempotent
Inputs
idstringrequired- Permalink (identifier) of the project. Example: my-website.
deployhq_scheduled_deployment_deleteCancel a scheduled deployment.DestructiveCancel Scheduled Deployment
Cancel a scheduled deployment.
- Idempotent
Inputs
idstringrequired- Identifier of the scheduled deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_server_deleteDelete a server from a project.DestructiveDelete Server
Delete a server from a project.
- Idempotent
Inputs
idstringrequired- Identifier of the server. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
deployhq_ssh_command_deleteDelete an SSH command from a project.DestructiveDelete SSH Command
Delete an SSH command from a project.
- Idempotent
Inputs
idstringrequired- Identifier of the SSH command. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
project_idstringrequired- Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
No tools match.