DeployHQ

deployhq

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

Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (61)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Delete CommandDEPLOYHQ_DELETE_COMMANDAcción

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

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier
identifierstringObligatorio
The unique identifier of the command to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ProjectDEPLOYHQ_DELETE_PROJECTS_PROJECTAcción

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

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Build Cache FileDEPLOYHQ_DELETE_PROJECTS_PROJECT_BUILD_CACHE_FILES_IDENTIFIERAcción

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.

Parámetros de entrada

projectstringObligatorio
The project permalink or identifier that identifies the project
identifierstringObligatorio
The build cache file's unique identifier (UUID format) that identifies the specific build cache file to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Excluded File RuleDEPLOYHQ_DELETE_PROJECTS_PROJECT_EXCLUDED_FILES_IDENTIFIERAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Server GroupDEPLOYHQ_DELETE_PROJECTS_PROJECT_SERVER_GROUPS_IDENTIFIERAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier
identifierstringObligatorio
The server group's unique identifier (UUID format)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete TemplateDEPLOYHQ_DELETE_TEMPLATES_PERMALINKAcción

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

Parámetros de entrada

permalinkstringObligatorio
The template's unique permalink identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProjectsDEPLOYHQ_GET_PROJECTSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProjectDEPLOYHQ_GET_PROJECTS_PROJECTAcción

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

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project Build Known HostsDEPLOYHQ_GET_PROJECTS_PROJECT_BUILD_KNOWN_HOSTSAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project CommandsDEPLOYHQ_GET_PROJECTS_PROJECT_COMMANDSAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project Config FilesDEPLOYHQ_GET_PROJECTS_PROJECT_CONFIG_FILESAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobject[]Obligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project DeploymentsDEPLOYHQ_GET_PROJECTS_PROJECT_DEPLOYMENTSAcción

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.

Parámetros de entrada

tostring
Filters deployments by server or server group UUID.
pageinteger
Specifies which page number to retrieve for pagination (10 deployments per page).
projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project Excluded FilesDEPLOYHQ_GET_PROJECTS_PROJECT_EXCLUDED_FILESAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier

Parámetros de salida

dataobject[]Obligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Config FileDEPLOYHQ_GET_PROJECTS_PROJECT_ID_CONFIG_FILES_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The unique identifier for the config file.
project_idstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Excluded FileDEPLOYHQ_GET_PROJECTS_PROJECT_ID_EXCLUDED_FILES_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The unique identifier (UUID) of the excluded file entry.
project_idstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Server GroupDEPLOYHQ_GET_PROJECTS_PROJECT_ID_SERVER_GROUPS_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The server group's unique identifier (UUID format).
project_idstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project RepositoryDEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORYAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Repository BranchesDEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_BRANCHESAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Repository Commit InfoDEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_COMMIT_INFOAcción

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.

Parámetros de entrada

commitstringObligatorio
The commit reference/hash of the revision to retrieve.
projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Latest Repository RevisionDEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_LATEST_REVISIONAcción

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.

Parámetros de entrada

branchstring
Specifies which branch to retrieve the latest revision for. If not provided, the default branch is used.
projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Recent Commits and TagsDEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_RECENT_COMMITSAcción

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.

Parámetros de entrada

branchstringObligatorio
The branch name for viewing recent revisions.
projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project Scheduled DeploymentsDEPLOYHQ_GET_PROJECTS_PROJECT_SCHEDULED_DEPLOYMENTSAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project Server GroupsDEPLOYHQ_GET_PROJECTS_PROJECT_SERVER_GROUPSAcción

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

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Project ServersDEPLOYHQ_GET_PROJECTS_PROJECT_SERVERSAcción

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

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TemplatesDEPLOYHQ_GET_TEMPLATESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Public TemplateDEPLOYHQ_GET_TEMPLATES_ID_PUBLIC_IDAcción

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.

Parámetros de entrada

public_idstringObligatorio
The public identifier for the template
template_idstringObligatorio
The unique identifier for the template

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Public TemplatesDEPLOYHQ_GET_TEMPLATES_PUBLIC_TEMPLATESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ProjectDEPLOYHQ_PATCH_PROJECTS_IDAcción

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

Parámetros de entrada

idstringObligatorio
The project's permalink or unique identifier
projectobjectObligatorio
Project update parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Build Cache FileDEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_CACHE_FILES_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The build cache file's unique identifier (UUID format) that identifies the specific build cache file to update
project_idstringObligatorio
The project permalink or identifier that identifies the project
build_cache_fileobjectObligatorio
Build cache file update parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Build CommandDEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_COMMANDS_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The build command's unique identifier (UUID format) that identifies the specific build command to update
project_idstringObligatorio
The project's permalink or identifier that identifies the project
build_commandobjectObligatorio
Build command update parameters. Include only the fields you want to modify (partial update).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Language VersionDEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_LANGUAGES_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The language identifier/name whose version requires updating. Valid values include: 'php', 'nodejs', 'python', 'ruby', 'java', 'go', 'dotnet', 'composer'
project_idstringObligatorio
The project's permalink or identifier
build_environmentobjectObligatorio
Build environment update parameters containing the version

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Project CommandDEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_COMMANDS_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The command's unique identifier (UUID format) that identifies the specific command to update
commandobjectObligatorio
Command update parameters
project_idstringObligatorio
The project identifier or permalink that identifies the project

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Config FileDEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_CONFIG_FILES_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The config file's unique identifier (UUID format)
project_idstringObligatorio
The project's permalink or identifier
config_fileobjectObligatorio
Config file update parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Excluded FileDEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_EXCLUDED_FILES_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The excluded file's unique identifier (UUID format) that identifies the specific excluded file rule to update
project_idstringObligatorio
The project permalink or identifier that identifies the project
excluded_fileobjectObligatorio
Excluded file update parameters including path pattern and server associations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Project RepositoryDEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_REPOSITORYAcción

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.

Parámetros de entrada

project_idstringObligatorio
The unique identifier or permalink for the project.
repositoryobjectObligatorio
Repository update parameters.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Server GroupDEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_SERVER_GROUPS_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The server group's unique identifier (UUID format)
project_idstringObligatorio
The project's permalink or identifier
server_groupobjectObligatorio
Server group update parameters. Include only the fields you want to modify (partial update).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update TemplateDEPLOYHQ_PATCH_TEMPLATES_IDAcción

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

Parámetros de entrada

idstringObligatorio
Template identifier (can be template ID or permalink)
templateobjectObligatorio
Template update parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ProjectDEPLOYHQ_POST_PROJECTSAcción

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

Parámetros de entrada

projectobjectObligatorio
Project creation parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate AI Deployment OverviewDEPLOYHQ_POST_PROJECTS_ID_AI_DEPLOYMENT_OVERVIEWAcción

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.

Parámetros de entrada

idstringObligatorio
The project's identifier (UUID or permalink)
end_refstringObligatorio
The ending revision/reference (commit SHA) for the deployment range
start_refstringObligatorio
The starting revision/reference (commit SHA) for the deployment range

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Build Cache FileDEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_CACHE_FILESAcción

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.

Parámetros de entrada

projectstringObligatorio
The project permalink or identifier that identifies the project
build_cache_fileobjectObligatorio
Build cache file creation parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Build CommandDEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_COMMANDSAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier that identifies the project
build_commandobjectObligatorio
Build command creation parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Project Build Known HostDEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_KNOWN_HOSTSAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier
build_known_hostobjectObligatorio
Known host creation parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create SSH CommandDEPLOYHQ_POST_PROJECTS_PROJECT_COMMANDSAcción

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.

Parámetros de entrada

commandobjectObligatorio
SSH command creation parameters
projectstringObligatorio
The project's permalink or identifier that identifies the project

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Config FileDEPLOYHQ_POST_PROJECTS_PROJECT_CONFIG_FILESAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier
config_fileobjectObligatorio
Config file creation parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Config File DeploymentDEPLOYHQ_POST_PROJECTS_PROJECT_DEPLOYMENTSAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier that identifies the project
deploymentobjectObligatorio
Deployment creation parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Excluded FileDEPLOYHQ_POST_PROJECTS_PROJECT_EXCLUDED_FILESAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier
excluded_fileobjectObligatorio
Excluded file creation parameters including path pattern and server associations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Abort DeploymentDEPLOYHQ_POST_PROJECTS_PROJECT_ID_DEPLOYMENTS_ID_ABORTAcción

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

Parámetros de entrada

idstringObligatorio
The UUID identifier of the deployment to abort
project_idstringObligatorio
The project's permalink or identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Project RepositoryDEPLOYHQ_POST_PROJECTS_PROJECT_REPOSITORYAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier.
repositoryobjectObligatorio
Repository creation parameters.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Server GroupDEPLOYHQ_POST_PROJECTS_PROJECT_SERVER_GROUPSAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier that identifies the project
server_groupobjectObligatorio
Server group creation parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ServerDEPLOYHQ_POST_PROJECTS_PROJECT_SERVERSAcción

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

Parámetros de entrada

serverobjectObligatorio
Server creation parameters
projectstringObligatorio
The project's permalink or identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create TemplateDEPLOYHQ_POST_TEMPLATESAcción

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

Parámetros de entrada

templateobjectObligatorio
Template creation parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Project SettingsDEPLOYHQ_PUT_PROJECTS_PROJECTAcción

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.

Parámetros de entrada

projectobjectObligatorio
Project update parameters. All fields are optional.
project_identifierstringObligatorio
The project's permalink or identifier.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Build Cache FileDEPLOYHQ_PUT_PROJECTS_PROJECT_BUILD_CACHE_FILES_IDENTIFIERAcción

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.

Parámetros de entrada

projectstringObligatorio
The project permalink or identifier that identifies the project
identifierstringObligatorio
The build cache file's unique identifier (UUID format) that identifies the specific build cache file to edit
build_cache_fileobjectObligatorio
Build cache file update parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Build CommandDEPLOYHQ_PUT_PROJECTS_PROJECT_BUILD_COMMANDS_IDENTIFIERAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier that identifies the project
identifierstringObligatorio
The build command's unique identifier (UUID format) that identifies the specific build command to edit
build_commandobjectObligatorio
Build command update parameters. Include only the fields you want to modify.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit SSH CommandDEPLOYHQ_PUT_PROJECTS_PROJECT_COMMANDS_IDENTIFIERAcción

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.

Parámetros de entrada

commandobjectObligatorio
Command update parameters including description, command text, timing, and server assignments
projectstringObligatorio
The project identifier or permalink that identifies the project
identifierstringObligatorio
The command's unique identifier (UUID format) that identifies the specific command to edit

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Config FileDEPLOYHQ_PUT_PROJECTS_PROJECT_CONFIG_FILES_IDENTIFIERAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier
identifierstringObligatorio
The config file's unique identifier (UUID format) that identifies the specific config file to edit
config_fileobjectObligatorio
Config file update parameters

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Excluded FileDEPLOYHQ_PUT_PROJECTS_PROJECT_EXCLUDED_FILE_IDENTIFIERAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier
identifierstringObligatorio
The excluded file rule's unique identifier (UUID format) that identifies the specific excluded file to edit
excluded_fileobjectObligatorio
Excluded file update parameters including path pattern and server associations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Excluded FileDEPLOYHQ_PUT_PROJECTS_PROJECT_ID_EXCLUDED_FILES_IDAcción

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.

Parámetros de entrada

idstringObligatorio
The excluded file rule's unique identifier (UUID format) that identifies the specific excluded file to update
project_idstringObligatorio
The project's permalink or identifier
excluded_fileobjectObligatorio
Excluded file update parameters including path pattern and server associations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Project RepositoryDEPLOYHQ_PUT_PROJECTS_PROJECT_ID_REPOSITORYAcción

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.

Parámetros de entrada

project_idstringObligatorio
The project permalink or identifier.
repositoryobjectObligatorio
Repository configuration including SCM type, URL, branch, and optional authentication credentials.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Server GroupDEPLOYHQ_PUT_PROJECTS_PROJECT_SERVER_GROUPS_IDENTIFIERAcción

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.

Parámetros de entrada

projectstringObligatorio
The project's permalink or identifier
identifierstringObligatorio
The server group's unique identifier (UUID format)
server_groupobjectObligatorio
Server group update parameters including name, branch, auto_deploy, email_notify_on, and transfer_order

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit TemplateDEPLOYHQ_PUT_TEMPLATES_PERMALINKAcción

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

Parámetros de entrada

templateobjectObligatorio
Template update parameters
permalinkstringObligatorio
The URL-friendly identifier of the template to edit

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not