# DeployHQ

Deployment made simple. We make it super easy to automate deploying projects from Git, SVN and Mercurial repositories.

- **Category:** developer tools
- **Auth:** BASIC
- **Tools:** 61
- **Triggers:** 0
- **Slug:** `DEPLOYHQ`
- **Version:** 20260203_00

## Tools

### Delete Command

**Slug:** `DEPLOYHQ_DELETE_COMMAND`

Tool to delete a command from a specified project. Use when you need to remove an SSH command from a project's configuration.

### Delete Project

**Slug:** `DEPLOYHQ_DELETE_PROJECTS_PROJECT`

Tool to delete a project from DeployHQ. Use when you need to permanently remove a project by its permalink or identifier.

### Delete Build Cache File

**Slug:** `DEPLOYHQ_DELETE_PROJECTS_PROJECT_BUILD_CACHE_FILES`

Tool to delete an existing build cache file from a project. Use when you need to remove a cached build artifact from the project's build cache storage.

### Delete Excluded File Rule

**Slug:** `DEPLOYHQ_DELETE_PROJECTS_PROJECT_EXCLUDED_FILES_IDENTIFIER`

Tool to delete an existing excluded file rule from a project. Use when you need to remove an excluded file pattern from deployment configuration.

### Delete Server Group

**Slug:** `DEPLOYHQ_DELETE_PROJECTS_PROJECT_SERVER_GROUPS_IDENTIFIER`

Tool to delete a server group from a project using the DeployHQ API. Use when you need to remove a server group from deployment configuration.

### Delete Template

**Slug:** `DEPLOYHQ_DELETE_TEMPLATES_PERMALINK`

Tool to delete a template by its unique permalink. Use when you need to permanently remove a template from DeployHQ.

### Get Projects

**Slug:** `DEPLOYHQ_GET_PROJECTS`

Tool to retrieve all projects from DeployHQ account. Use when you need to list all available projects and their configurations.

### Get Project

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT`

Tool to view an existing project in DeployHQ. Use when you need to retrieve details about a specific project by its permalink or identifier.

### Get Project Build Known Hosts

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_BUILD_KNOWN_HOSTS`

Tool to list all known hosts within a project using DeployHQ API. Use when you need to view SSH known hosts configured for a specific project.

### Get Project Commands

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_COMMANDS`

Tool to retrieve all SSH commands configured for a project. Use when you need to list all commands and their execution details for a specific project.

### Get Project Config Files

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_CONFIG_FILES`

Tool to retrieve a list of all config files in a DeployHQ project. Use when you need to view all configuration files that are configured for a specific project.

### Get Project Deployments

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_DEPLOYMENTS`

Tool to retrieve a paginated list of all deployments in a project. Use when you need to view deployment history for a specific project. Results are paginated with 10 deployments per page.

### Get Project Excluded Files

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_EXCLUDED_FILES`

Tool to list all excluded files within a project template. Use when you need to view which files or patterns are excluded from deployment for a specific project.

### Get Config File

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_ID_CONFIG_FILES_ID`

Tool to view a specific config file in a DeployHQ project. Use when you need to retrieve details about a particular configuration file by its identifier.

### Get Excluded File

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_ID_EXCLUDED_FILES_ID`

Tool to view a specific excluded file in a DeployHQ project. Use when you need to retrieve details about a particular excluded file by its identifier.

### Get Server Group

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_ID_SERVER_GROUPS_ID`

Tool to view a specific server group in a DeployHQ project. Use when you need to retrieve details about a particular server group by its identifier.

### Get Project Repository

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY`

Tool to view repository details for a specific project in DeployHQ. Use when you need to retrieve repository configuration including URL, branch, and hosting service details.

### Get Repository Branches

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_BRANCHES`

Tool to view all available branches in the connected repository for a project. Use when you need to list repository branches and their commit hashes.

### Get Repository Commit Info

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_COMMIT_INFO`

Tool to view detailed information about a specific revision in a project's connected repository. Use when you need to retrieve commit details including author, timestamp, message, and tags.

### Get Latest Repository Revision

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_LATEST_REVISION`

Tool to view the latest remote revision of your repository. Use when you need to get the most recent commit hash for a project's default branch or a specific branch.

### Get Recent Commits and Tags

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_RECENT_COMMITS`

Tool to view up to 15 most recent revisions and up to 15 most recent tags in a specific branch. Use when you need to retrieve recent commit history and tag information from a project's repository branch.

### Get Project Scheduled Deployments

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_SCHEDULED_DEPLOYMENTS`

Tool to retrieve all upcoming scheduled deployments for a project. Use when you need to view scheduled deployment configurations including server details, revision information, frequency settings, and execution times.

### Get Project Server Groups

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_SERVER_GROUPS`

Tool to retrieve all server groups configured for a project. Use when you need to list servers and their deployment configurations within a project.

### Get Project Servers

**Slug:** `DEPLOYHQ_GET_PROJECTS_PROJECT_SERVERS`

Tool to retrieve all servers configured for a project. Use when you need to view server configurations and deployment targets for a specific project.

### Get Templates

**Slug:** `DEPLOYHQ_GET_TEMPLATES`

Retrieves all deployment templates from the DeployHQ account. Templates in DeployHQ are reusable configurations that can be used to quickly set up new projects with predefined settings. This action returns the name, permalink (unique identifier), and description for each template. Use this when you need to: - List all available templates in the account - Find a template's permalink for use in other operations - Discover what templates exist before creating or modifying projects No parameters are required - this returns all templates in the account.

### Get Public Framework Template Details

**Slug:** `DEPLOYHQ_GET_TEMPLATES_ID_PUBLIC_ID`

Retrieves detailed configuration for a specific public framework template from DeployHQ's curated template library. Returns complete deployment settings including build commands, SSH commands, excluded files, and framework-specific features. Use this to inspect pre-configured templates for popular frameworks like Laravel, React, WordPress, Django, etc. First call GET_TEMPLATES_PUBLIC_TEMPLATES to get available template IDs and permalinks.

### Get Public Templates

**Slug:** `DEPLOYHQ_GET_TEMPLATES_PUBLIC_TEMPLATES`

Tool to retrieve publicly available deployment templates from DeployHQ. Use when you need to list framework templates for popular web platforms.

### Update Project

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_ID`

Tool to update project settings in DeployHQ. Use when you need to modify a project's name or region/zone configuration.

### Update Build Cache File

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_CACHE_FILES_ID`

Tool to update an existing build cache file in a project. Use when you need to modify the path of a cached build artifact in the project's build cache storage.

### Update Build Command

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_COMMANDS_ID`

Tool to update an existing build command in a project. Use when you need to modify the description, command, or error handling behavior of a build command. Supports partial updates - only include the fields you want to change.

### Update Build Language Version

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_LANGUAGES_ID`

Updates the version of a programming language in a project's build environment configuration. This action modifies which version of PHP, Node.js, Python, Ruby, Java, Go, .NET, or Composer will be used during the project's build process. Note: Some languages may not be available for all projects depending on the project configuration and DeployHQ account settings.

### Update Project Command

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_COMMANDS_ID`

Tool to update an existing SSH command in a project. Use when you need to modify command properties like description, command text, execution timing, timeout, or server assignments.

### Update Config File

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_CONFIG_FILES_ID`

Tool to update an existing config file in a DeployHQ project. Use when you need to modify the path or contents of a configuration file.

### Update Excluded File

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_EXCLUDED_FILES_ID`

Tool to update an existing excluded file rule in a project. Use when you need to modify the file path pattern or server associations for an excluded file in the deployment configuration.

### Update Project Repository

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_REPOSITORY`

Tool to update repository configuration for a project in DeployHQ. Use when you need to modify repository settings like branch, URL, SCM type, or authentication credentials.

### Update Server Group

**Slug:** `DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_SERVER_GROUPS_ID`

Tool to update an existing server group in a DeployHQ project. Use when you need to modify settings such as name, branch, auto-deploy, notification preferences, or deployment mode. Supports partial updates - only include the fields you want to change.

### Update Template

**Slug:** `DEPLOYHQ_PATCH_TEMPLATES_ID`

Tool to update an existing template in DeployHQ. Use when you need to modify the name or description of a template.

### Create Project

**Slug:** `DEPLOYHQ_POST_PROJECTS`

Tool to create a new project in DeployHQ. Use when you need to initialize a new project with a name and optional zone configuration.

### Generate AI Deployment Overview

**Slug:** `DEPLOYHQ_POST_PROJECTS_ID_AI_DEPLOYMENT_OVERVIEW`

Tool to generate an AI-powered deployment overview for a revision range. Use when you need to analyze commit messages between two references and get a concise summary of changes.

### Create Build Cache File

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_CACHE_FILES`

Tool to create a new build cached file within a project. Use when you need to add a new cached build artifact to the project's build cache storage.

### Create Build Command

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_COMMANDS`

Tool to create a new build command for a project in DeployHQ. Use when you need to add a new build command to a project.

### Create Project Build Known Host

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_KNOWN_HOSTS`

Tool to create a new known host in a project using DeployHQ API. Use when you need to add SSH known hosts for build processes in a specific project.

### Create SSH Command

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_COMMANDS`

Tool to create a new SSH command for a project in DeployHQ. Use when you need to add SSH commands that run before or after deployments.

### Create Config File

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_CONFIG_FILES`

Tool to create a new config file in a DeployHQ project. Use when you need to add a configuration file that will be deployed to specified servers.

### Create Config File Deployment

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_DEPLOYMENTS`

Tool to create a new config file deployment for a project. Use when you need to deploy only configuration files to a server or server group without deploying code changes.

### Create Excluded File

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_EXCLUDED_FILES`

Tool to add a new excluded file to a project. Use when you need to exclude specific files or patterns from deployment to prevent them from being deployed to servers.

### Abort Deployment

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_ID_DEPLOYMENTS_ID_ABORT`

Tool to abort a currently running deployment. Use when you need to terminate a deployment that is in progress.

### Add Project Repository

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_REPOSITORY`

Tool to add repository details to a project in DeployHQ. Use when you need to configure a repository for a project with URL, SCM type, branch, and authentication credentials.

### Create Server Group

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_SERVER_GROUPS`

Tool to create a new server group for automated deployments in a DeployHQ project. Use when you need to set up a group of servers for deploying from a specific branch with auto-deploy and notification settings.

### Create Server

**Slug:** `DEPLOYHQ_POST_PROJECTS_PROJECT_SERVERS`

Tool to create a new server configuration in a DeployHQ project. Use when you need to add a deployment destination with protocol-specific settings (SSH, FTP, S3, etc.).

### Create Template

**Slug:** `DEPLOYHQ_POST_TEMPLATES`

Tool to create a new template in DeployHQ. Use when you need to create a template, optionally copying configuration from an existing project.

### Update Project Settings

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT`

Tool to update settings of an existing DeployHQ project. Use when you need to modify project properties like name, permalink, notification settings, or zone. Warning: Changing the permalink requires updating the repository webhook URL to maintain automatic deployments.

### Edit Build Cache File

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT_BUILD_CACHE_FILES_IDENTIFIER`

Tool to edit an existing build cache file within a project. Use when you need to modify the path of a cached build artifact in the project's build cache storage.

### Edit Build Command

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT_BUILD_COMMANDS_IDENTIFIER`

Tool to edit an existing build command within a template in DeployHQ. Use when you need to modify the description, command, or error handling behavior of a build command.

### Edit SSH Command

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT_COMMANDS_IDENTIFIER`

Tool to edit an existing SSH command in a DeployHQ project. Use when you need to update command properties like description, command text, execution timing, timeout, or server assignments.

### Edit Config File

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT_CONFIG_FILES_IDENTIFIER`

Tool to edit an existing config file within a project. Use when you need to modify the path, contents, or server deployment settings of a configuration file.

### Edit Excluded File

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT_EXCLUDED_FILE_IDENTIFIER`

Tool to edit an existing excluded file rule within a project. Use when you need to modify the path pattern or server assignments of an existing exclusion rule.

### Update Excluded File

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT_ID_EXCLUDED_FILES_ID`

Tool to update an existing excluded file rule in a project. Use when you need to modify the path pattern or server assignments of an existing exclusion rule.

### Update Project Repository

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT_ID_REPOSITORY`

Tool to update repository details for an existing project in DeployHQ. Use when you need to replace the complete repository configuration including SCM type, URL, and branch.

### Update Server Group

**Slug:** `DEPLOYHQ_PUT_PROJECTS_PROJECT_SERVER_GROUPS_IDENTIFIER`

Tool to update a server group in a DeployHQ project using the API. Use when you need to modify server group configuration such as name, branch, auto-deploy settings, notification preferences, or deployment mode.

### Edit Template

**Slug:** `DEPLOYHQ_PUT_TEMPLATES_PERMALINK`

Tool to edit an existing template in DeployHQ. Use when you need to update the name of a template identified by its permalink.
