Skip to main content
DeployHQ logo
  • Category: developer tools
  • Auth: BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 60
  • Triggers: 0
  • Slug: DEPLOYHQ
  • Version: 20261101_00

Tools

Slug: DEPLOYHQ_DELETE_COMMANDTool to delete a command from a specified project. Use when you need to remove an SSH command from a project’s configuration.

Input Parameters

string
required
The project’s permalink or identifier
string
required
The unique identifier of the command to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_DELETE_PROJECTS_PROJECTTool to delete a project from DeployHQ. Use when you need to permanently remove a project by its permalink or identifier.

Input Parameters

string
required
The project’s permalink or identifier to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_DELETE_PROJECTS_PROJECT_BUILD_CACHE_FILESTool 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.

Input Parameters

string
required
The project permalink or identifier that identifies the project
string
required
The build cache file’s unique identifier (UUID format) that identifies the specific build cache file to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_DELETE_PROJECTS_PROJECT_EXCLUDED_FILES_IDENTIFIERTool to delete an existing excluded file rule from a project. Use when you need to remove an excluded file pattern from deployment configuration.

Input Parameters

string
required
The project permalink that identifies the project
string
required
The excluded file identifier (UUID format) that identifies the specific excluded file rule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_DELETE_PROJECTS_PROJECT_SERVER_GROUPS_IDENTIFIERTool to delete a server group from a project using the DeployHQ API. Use when you need to remove a server group from deployment configuration.

Input Parameters

string
required
The project’s permalink or identifier
string
required
The server group’s unique identifier (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_DELETE_TEMPLATES_PERMALINKTool to delete a template by its unique permalink. Use when you need to permanently remove a template from DeployHQ.

Input Parameters

The template’s unique permalink identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTSTool to retrieve all projects from DeployHQ account. Use when you need to list all available projects and their configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECTTool to view an existing project in DeployHQ. Use when you need to retrieve details about a specific project by its permalink or identifier.

Input Parameters

string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_BUILD_KNOWN_HOSTSTool 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.

Input Parameters

string
required
The project’s permalink (URL-friendly identifier, not UUID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_COMMANDSTool 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.

Input Parameters

string
required
The project’s permalink or identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_CONFIG_FILESTool 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.

Input Parameters

string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_DEPLOYMENTSTool 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.

Input Parameters

string
Filters deployments by server or server group UUID.
integer
Specifies which page number to retrieve for pagination (10 deployments per page).
string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_EXCLUDED_FILESList excluded file rules for a DeployHQ project, including paths or patterns excluded from deployment.

Input Parameters

string
required
The project’s permalink or identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_ID_CONFIG_FILES_IDTool 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.

Input Parameters

string
required
The unique identifier for the config file.
string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_ID_EXCLUDED_FILES_IDTool 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.

Input Parameters

string
required
The unique identifier (UUID) of the excluded file entry.
string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_ID_SERVER_GROUPS_IDTool 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.

Input Parameters

string
required
The server group’s unique identifier (UUID format).
string
required
The project’s permalink (not UUID). Use the human-readable slug identifier for the project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORYTool 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.

Input Parameters

string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_BRANCHESTool to view all available branches in the connected repository for a project. Use when you need to list repository branches and their commit hashes.

Input Parameters

string
required
The project’s permalink (e.g., ‘my-project’, ‘composio’). Note: UUID identifiers are not supported for this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_COMMIT_INFOTool 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.

Input Parameters

string
required
The commit reference/hash of the revision to retrieve.
string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_LATEST_REVISIONTool 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.

Input Parameters

string
Specifies which branch to retrieve the latest revision for. If not provided, the default branch is used.
string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_RECENT_COMMITSTool 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.

Input Parameters

string
required
The branch name for viewing recent revisions.
string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_SCHEDULED_DEPLOYMENTSTool 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.

Input Parameters

string
required
The project’s permalink (e.g., ‘my-project’, ‘composio’). While the API documentation mentions both permalink and identifier are supported, testing shows permalinks work reliably.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_SERVER_GROUPSTool to retrieve all server groups configured for a project. Use when you need to list servers and their deployment configurations within a project.

Input Parameters

string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_PROJECTS_PROJECT_SERVERSTool to retrieve all servers configured for a project. Use when you need to view server configurations and deployment targets for a specific project.

Input Parameters

string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_TEMPLATESRetrieves 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_TEMPLATES_ID_PUBLIC_IDRetrieve details for a public DeployHQ framework template by template ID and permalink. The response can include build commands, SSH commands, excluded files, and framework features.

Input Parameters

string
required
The permalink (URL-friendly identifier) of the public template (e.g., ‘laravel’, ‘wordpress’, ‘react’). Get this from the ‘permalink’ field in GET_TEMPLATES_PUBLIC_TEMPLATES response.
string
required
The numeric identifier of the public template (e.g., ‘15249’ for Laravel, ‘15288’ for WordPress). Get this from the ‘id’ field in GET_TEMPLATES_PUBLIC_TEMPLATES response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_GET_TEMPLATES_PUBLIC_TEMPLATESTool to retrieve publicly available deployment templates from DeployHQ. Use when you need to list framework templates for popular web platforms.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_IDTool to update project settings in DeployHQ. Use when you need to modify a project’s name or region/zone configuration.

Input Parameters

string
required
The project’s permalink or unique identifier
object
required
Project update parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_CACHE_FILES_IDTool 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.

Input Parameters

string
required
The build cache file’s unique identifier (UUID format) that identifies the specific build cache file to update
string
required
The project permalink or identifier that identifies the project
object
required
Build cache file update parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_COMMANDS_IDTool 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.

Input Parameters

string
required
The build command’s unique identifier (UUID format) that identifies the specific build command to update
string
required
The project’s permalink or identifier that identifies the project
object
required
Build command update parameters. Include only the fields you want to modify (partial update).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_LANGUAGES_IDUpdates 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.

Input Parameters

string
required
The language identifier/name whose version requires updating. Valid values include: ‘php’, ‘nodejs’, ‘python’, ‘ruby’, ‘java’, ‘go’, ‘dotnet’, ‘composer’
string
required
The project’s permalink (URL-friendly identifier). Use the project permalink, not the UUID identifier.
object
required
Build environment update parameters containing the version

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_COMMANDS_IDTool 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.

Input Parameters

string
required
The command’s unique identifier (UUID format) that identifies the specific command to update
object
required
Command update parameters
string
required
The project identifier or permalink that identifies the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_CONFIG_FILES_IDUpdate a config file in a DeployHQ project. Both the file path and complete contents are required, with optional server targeting.

Input Parameters

string
required
The config file’s unique identifier (UUID format)
string
required
The project’s permalink or identifier
object
required
Config file update parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_EXCLUDED_FILES_IDUpdate an excluded file rule in a project, including its path pattern and server associations. A path is required; omitting server associations sends an empty server list.

Input Parameters

string
required
The excluded file’s unique identifier (UUID format) that identifies the specific excluded file rule to update
string
required
The project permalink or identifier that identifies the project
object
required
Excluded file update parameters including path pattern and server associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_REPOSITORYTool 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.

Input Parameters

string
required
The unique identifier or permalink for the project.
object
required
Repository update parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_SERVER_GROUPS_IDTool 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.

Input Parameters

string
required
The server group’s unique identifier (UUID format)
string
required
The project’s permalink or identifier
object
required
Server group update parameters. Include only the fields you want to modify (partial update).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PATCH_TEMPLATES_IDUpdate the name of an existing DeployHQ template identified by its ID or permalink.

Input Parameters

string
required
Template identifier (can be template ID or permalink)
object
required
Template update parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTSTool to create a new project in DeployHQ. Use when you need to initialize a new project with a name and optional zone configuration.

Input Parameters

object
required
Project creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_ID_AI_DEPLOYMENT_OVERVIEWTool 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.

Input Parameters

string
required
The project’s identifier (UUID or permalink)
string
required
The ending revision/reference (commit SHA) for the deployment range
string
required
The starting revision/reference (commit SHA) for the deployment range

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_CACHE_FILESCreate a build cache file entry for a project using a path or pattern to cache.

Input Parameters

string
required
The project permalink or identifier that identifies the project
object
required
Build cache file creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_COMMANDSTool to create a new build command for a project in DeployHQ. Use when you need to add a new build command to a project.

Input Parameters

string
required
The project’s permalink or identifier that identifies the project
object
required
Build command creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_KNOWN_HOSTSTool 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.

Input Parameters

string
required
The project’s permalink or identifier
object
required
Known host creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_COMMANDSTool 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.

Input Parameters

object
required
SSH command creation parameters
string
required
The project’s permalink or identifier that identifies the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_CONFIG_FILESTool 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.

Input Parameters

string
required
The project’s permalink or identifier
object
required
Config file creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_DEPLOYMENTSCreate a config-only deployment for a project targeting a server or server group, either queued for execution or prepared as a preview.

Input Parameters

string
required
The project’s permalink or identifier that identifies the project
object
required
Deployment creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_EXCLUDED_FILESTool 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.

Input Parameters

string
required
The project’s permalink or identifier
object
required
Excluded file creation parameters including path pattern and server associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_ID_DEPLOYMENTS_ID_ABORTTool to abort a currently running deployment. Use when you need to terminate a deployment that is in progress.

Input Parameters

string
required
The UUID identifier of the deployment to abort
string
required
The project’s permalink or identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_REPOSITORYTool 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.

Input Parameters

string
required
The project’s permalink or identifier.
object
required
Repository creation parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_SERVER_GROUPSTool 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.

Input Parameters

string
required
The project’s permalink or identifier that identifies the project
object
required
Server group creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_PROJECTS_PROJECT_SERVERSTool 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.).

Input Parameters

object
required
Server creation parameters
string
required
The project’s permalink or identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_POST_TEMPLATESTool to create a new template in DeployHQ. Use when you need to create a template, optionally copying configuration from an existing project.

Input Parameters

object
required
Template creation parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_PROJECTS_PROJECTTool 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.

Input Parameters

object
required
Project update parameters. All fields are optional.
string
required
The project’s permalink or identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_PROJECTS_PROJECT_BUILD_CACHE_FILES_IDENTIFIERTool 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.

Input Parameters

string
required
The project permalink or identifier that identifies the project
string
required
The build cache file’s unique identifier (UUID format) that identifies the specific build cache file to edit
object
required
Build cache file update parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_PROJECTS_PROJECT_BUILD_COMMANDS_IDENTIFIEREdit an existing build command in a DeployHQ project, including its description, command, or error handling behavior.

Input Parameters

string
required
The project’s permalink or identifier that identifies the project
string
required
The build command’s unique identifier (UUID format) that identifies the specific build command to edit
object
required
Build command update parameters. Include only the fields you want to modify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_PROJECTS_PROJECT_COMMANDS_IDENTIFIERTool 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.

Input Parameters

object
required
Command update parameters including description, command text, timing, and server assignments
string
required
The project identifier or permalink that identifies the project
string
required
The command’s unique identifier (UUID format) that identifies the specific command to edit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_PROJECTS_PROJECT_CONFIG_FILES_IDENTIFIERTool 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.

Input Parameters

string
required
The project’s permalink or identifier
string
required
The config file’s unique identifier (UUID format) that identifies the specific config file to edit
object
required
Config file update parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_PROJECTS_PROJECT_ID_EXCLUDED_FILES_IDUpdate an existing excluded file rule in a project, including its path pattern and server assignments. The request sends an empty server list by default when server identifiers are omitted.

Input Parameters

string
required
The excluded file rule’s unique identifier (UUID format) that identifies the specific excluded file to update
string
required
The project’s permalink or identifier
object
required
Excluded file update parameters including path pattern and server associations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_PROJECTS_PROJECT_ID_REPOSITORYTool 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.

Input Parameters

string
required
The project permalink or identifier.
object
required
Repository configuration including SCM type, URL, branch, and optional authentication credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_PROJECTS_PROJECT_SERVER_GROUPS_IDENTIFIERTool 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.

Input Parameters

string
required
The project’s permalink or identifier
string
required
The server group’s unique identifier (UUID format)
object
required
Server group update parameters including name, branch, auto_deploy, email_notify_on, and transfer_order

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DEPLOYHQ_PUT_TEMPLATES_PERMALINKTool to edit an existing template in DeployHQ. Use when you need to update the name of a template identified by its permalink.

Input Parameters

object
required
Template update parameters
The URL-friendly identifier of the template to edit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not