create_project
Create Project
Create a new DeployHQ project. After creation, you can configure the repository and add servers.
create_project
Create a new DeployHQ project. After creation, you can configure the repository and add servers.
get_project
Retrieve detailed information about a specific DeployHQ project by its permalink. Includes repository info, public key, and deployment zone.
list_server_groups
List all server groups for a DeployHQ project, including the servers in each group. Server groups allow coordinated deployments to multiple servers at once.
list_deployments
List recent deployments for a DeployHQ project. Returns deployment status, deployer, branch, revision, and timestamps.
delete_config_file
Remove a configuration file from a DeployHQ project. The file will no longer be deployed to any servers.
create_config_file
Add a new configuration file to a DeployHQ project. Config files are deployed to servers but not tracked in version control. Useful for environment-specific settings like database credentials or API keys.
list_scheduled_deployments
List all scheduled deployments for a DeployHQ project. Shows recurring deployment schedules with their frequency, timing, and target servers.
create_ssh_command
Add a new SSH command to a DeployHQ project. SSH commands execute on servers before or after deployments for tasks like restarting services, running migrations, or clearing caches.
delete_server
Remove a server from a DeployHQ project. This permanently deletes the server configuration and cannot be undone.
delete_ssh_command
Remove an SSH command from a DeployHQ project. The command will no longer execute during deployments.
list_servers
List all servers configured for a DeployHQ project. Returns server connection details, protocol type, deployment path, and auto-deploy settings.
update_config_file
Update an existing configuration file in a DeployHQ project. You can modify the path, contents, or which servers it deploys to.
get_deployment
Retrieve detailed information about a specific deployment including status, timing, revision details, deployer, and file changes. Use this to check the progress or results of a deployment.
delete_project
Permanently delete a DeployHQ project and all associated servers, deployments, and configuration. This action cannot be undone.
list_config_files
List all configuration files for a DeployHQ project. Config files are static files uploaded to servers during deployment but not stored in the repository (e.g., database.yml, .env files).
list_projects
List all projects in your DeployHQ account. Returns project names, permalinks, repository details, and deployment information.
list_ssh_commands
List all SSH commands configured for a DeployHQ project. SSH commands run on servers before or after a deployment (e.g., service restarts, database migrations).
create_server
Add a new deployment server to a DeployHQ project. Supports SSH/SFTP, FTP, FTPS, Amazon S3, S3-compatible storage, Shopify, Netlify, Elastic Beanstalk, and other protocols. Provide the common parameters along with protocol-specific fields.
create_deployment
Trigger a new deployment for a DeployHQ project. Can deploy to a specific server or server group, with options for revision range, config file copying, build commands, and scheduling. Supports both immediate and scheduled deployments.
Automate code deployments from version control repositories to servers. Create and manage projects that connect repositories (Git, SVN, Mercurial) to deployment targets. Add and configure servers with protocols like SSH/SFTP, FTP, S3, Cloudflare R2, Shopify, Netlify, and Elastic Beanstalk. Trigger deployments to specific servers or server groups, preview file changes before deploying, schedule recurring deployments, and roll back to previous revisions. Manage build pipelines for tasks like installing dependencies and compiling assets. Configure SSH commands to run before or after deployments. Organize servers into groups for coordinated deployments. Manage configuration files uploaded during deployment. Use templates to share configuration across projects. Set up notification integrations for deployment lifecycle events (started, succeeded, failed).
Common questions about connecting Deployhq to AI agents with Metorial.