Deployhq

Learn how to use Deployhq with Composio

Overview

SLUG: DEPLOYHQ

Description

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

Authentication Details

subdomain
stringRequired
username
stringRequired
password
stringRequired

Connecting to Deployhq

Create an auth config

Use the dashboard to create an auth config for the Deployhq toolkit. This allows you to connect multiple Deployhq accounts to Composio for agents to use.

1

Select App

Navigate to Deployhq.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Deployhq Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using Basic Auth

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5deployhq_auth_config_id = "ac_YOUR_DEPLOYHQ_CONFIG_ID"
6user_id = "user@example.com"
7username = "your_deployhq_username"
8password = "your_deployhq_password"
9
10composio = Composio()
11
12# Create a new connected account for Deployhq using Basic Auth
13connection_request = composio.connected_accounts.initiate(
14 user_id=user_id,
15 auth_config_id=deployhq_auth_config_id,
16 config=auth_scheme.basic_auth(
17 username=username,
18 password=password
19 )
20)
21
22# Basic authentication is immediate - no redirect needed
23print(f"Successfully connected Deployhq for user {user_id}")
24
25# You can verify the connection using:
26# connected_account = composio.connected_accounts.get(user_id=user_id, app_id="DEPLOYHQ")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Deployhq toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Delete Command

Description

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

Action Parameters

identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Project

Description

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

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Build Cache File

Description

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.

Action Parameters

identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Excluded File Rule

Description

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

Action Parameters

identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Server Group

Description

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.

Action Parameters

identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Projects

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project

Description

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

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Build Known Hosts

Description

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.

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Commands

Description

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.

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Config Files

Description

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.

Action Parameters

project
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Project Deployments

Description

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.

Action Parameters

page
integer
project
stringRequired
to
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Excluded Files

Description

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.

Action Parameters

project
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Config File

Description

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.

Action Parameters

id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Excluded File

Description

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.

Action Parameters

id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Server Group

Description

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.

Action Parameters

id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Repository

Description

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.

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Repository Branches

Description

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.

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Repository Commit Info

Description

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.

Action Parameters

commit
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Latest Repository Revision

Description

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.

Action Parameters

branch
string
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Recent Commits and Tags

Description

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.

Action Parameters

branch
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Scheduled Deployments

Description

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.

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Server Groups

Description

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

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Project Servers

Description

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

Action Parameters

project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Templates

Description

Tool to retrieve all templates from DeployHQ account. Use when you need to list all configured templates and their identifiers.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Public Template

Description

Tool to retrieve a specific public template from DeployHQ. Use when you need to view details of a public framework template using both template identifier and public template identifier.

Action Parameters

public_id
stringRequired
template_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Public Templates

Description

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Project

Description

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

Action Parameters

id
stringRequired
project
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Build Cache File

Description

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.

Action Parameters

build_cache_file
objectRequired
id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Build Command

Description

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.

Action Parameters

build_command
objectRequired
id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Language Version

Description

Tool to update the version of a language in a project's build environment. Use when you need to change the version of PHP, Node.js, Python, Ruby, Java, Go, .NET, or Composer used in a project's build pipeline.

Action Parameters

build_environment
objectRequired
id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Project Command

Description

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.

Action Parameters

command
objectRequired
id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Config File

Description

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.

Action Parameters

config_file
objectRequired
id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Excluded File

Description

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.

Action Parameters

excluded_file
objectRequired
id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Project Repository

Description

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.

Action Parameters

project_id
stringRequired
repository
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Server Group

Description

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.

Action Parameters

id
stringRequired
project_id
stringRequired
server_group
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Template

Description

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

Action Parameters

id
stringRequired
template
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Project

Description

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

Action Parameters

project
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Generate AI Deployment Overview

Description

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.

Action Parameters

end_ref
stringRequired
id
stringRequired
start_ref
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Build Cache File

Description

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.

Action Parameters

build_cache_file
objectRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Build Command

Description

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.

Action Parameters

build_command
objectRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Project Build Known Host

Description

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.

Action Parameters

build_known_host
objectRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create SSH Command

Description

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.

Action Parameters

command
objectRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Config File

Description

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.

Action Parameters

config_file
objectRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Config File Deployment

Description

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.

Action Parameters

deployment
objectRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Excluded File

Description

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.

Action Parameters

excluded_file
objectRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Abort Deployment

Description

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

Action Parameters

id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Project Repository

Description

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.

Action Parameters

project
stringRequired
repository
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Server Group

Description

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.

Action Parameters

project
stringRequired
server_group
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Server

Description

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.).

Action Parameters

project
stringRequired
server
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Template

Description

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

Action Parameters

template
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Project Settings

Description

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.

Action Parameters

project
objectRequired
project_identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit Build Cache File

Description

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.

Action Parameters

build_cache_file
objectRequired
identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit Build Command

Description

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.

Action Parameters

build_command
objectRequired
identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit SSH Command

Description

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.

Action Parameters

command
objectRequired
identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit Config File

Description

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.

Action Parameters

config_file
objectRequired
identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Edit Excluded File

Description

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.

Action Parameters

excluded_file
objectRequired
identifier
stringRequired
project
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Excluded File

Description

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.

Action Parameters

excluded_file
objectRequired
id
stringRequired
project_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Project Repository

Description

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.

Action Parameters

project_id
stringRequired
repository
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Server Group

Description

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.

Action Parameters

identifier
stringRequired
project
stringRequired
server_group
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired