Deployhq
Overview
SLUG: DEPLOYHQ
Description
Deployment made simple. We make it super easy to automate deploying projects from Git, SVN and Mercurial repositories.
Authentication Details
Basic Auth
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.
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
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
DEPLOYHQ_DELETE_COMMAND
Tool Name: Delete Command
Description
Action Parameters
Action Response
DEPLOYHQ_DELETE_PROJECTS_PROJECT
Tool Name: Delete Project
Description
Action Parameters
Action Response
DEPLOYHQ_DELETE_PROJECTS_PROJECT_BUILD_CACHE_FILES_IDENTIFIER
Tool Name: Delete Build Cache File
Description
Action Parameters
Action Response
DEPLOYHQ_DELETE_PROJECTS_PROJECT_EXCLUDED_FILES_IDENTIFIER
Tool Name: Delete Excluded File Rule
Description
Action Parameters
Action Response
DEPLOYHQ_DELETE_PROJECTS_PROJECT_SERVER_GROUPS_IDENTIFIER
Tool Name: Delete Server Group
Description
Action Parameters
Action Response
DEPLOYHQ_DELETE_TEMPLATES_PERMALINK
Tool Name: Delete Template
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS
Tool Name: Get Projects
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT
Tool Name: Get Project
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_BUILD_KNOWN_HOSTS
Tool Name: Get Project Build Known Hosts
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_COMMANDS
Tool Name: Get Project Commands
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_CONFIG_FILES
Tool Name: Get Project Config Files
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_DEPLOYMENTS
Tool Name: Get Project Deployments
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_EXCLUDED_FILES
Tool Name: Get Project Excluded Files
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_ID_CONFIG_FILES_ID
Tool Name: Get Config File
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_ID_EXCLUDED_FILES_ID
Tool Name: Get Excluded File
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_ID_SERVER_GROUPS_ID
Tool Name: Get Server Group
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY
Tool Name: Get Project Repository
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_BRANCHES
Tool Name: Get Repository Branches
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_COMMIT_INFO
Tool Name: Get Repository Commit Info
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_LATEST_REVISION
Tool Name: Get Latest Repository Revision
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_REPOSITORY_RECENT_COMMITS
Tool Name: Get Recent Commits and Tags
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_SCHEDULED_DEPLOYMENTS
Tool Name: Get Project Scheduled Deployments
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_SERVER_GROUPS
Tool Name: Get Project Server Groups
Description
Action Parameters
Action Response
DEPLOYHQ_GET_PROJECTS_PROJECT_SERVERS
Tool Name: Get Project Servers
Description
Action Parameters
Action Response
DEPLOYHQ_GET_TEMPLATES
Tool Name: Get Templates
Description
Action Parameters
Action Response
DEPLOYHQ_GET_TEMPLATES_ID_PUBLIC_ID
Tool Name: Get Public Template
Description
Action Parameters
Action Response
DEPLOYHQ_GET_TEMPLATES_PUBLIC_TEMPLATES
Tool Name: Get Public Templates
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_ID
Tool Name: Update Project
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_CACHE_FILES_ID
Tool Name: Update Build Cache File
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_COMMANDS_ID
Tool Name: Update Build Command
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_BUILD_LANGUAGES_ID
Tool Name: Update Language Version
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_COMMANDS_ID
Tool Name: Update Project Command
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_CONFIG_FILES_ID
Tool Name: Update Config File
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_EXCLUDED_FILES_ID
Tool Name: Update Excluded File
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_REPOSITORY
Tool Name: Update Project Repository
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_PROJECTS_PROJECT_ID_SERVER_GROUPS_ID
Tool Name: Update Server Group
Description
Action Parameters
Action Response
DEPLOYHQ_PATCH_TEMPLATES_ID
Tool Name: Update Template
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS
Tool Name: Create Project
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_ID_AI_DEPLOYMENT_OVERVIEW
Tool Name: Generate AI Deployment Overview
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_CACHE_FILES
Tool Name: Create Build Cache File
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_COMMANDS
Tool Name: Create Build Command
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_BUILD_KNOWN_HOSTS
Tool Name: Create Project Build Known Host
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_COMMANDS
Tool Name: Create SSH Command
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_CONFIG_FILES
Tool Name: Create Config File
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_DEPLOYMENTS
Tool Name: Create Config File Deployment
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_EXCLUDED_FILES
Tool Name: Create Excluded File
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_ID_DEPLOYMENTS_ID_ABORT
Tool Name: Abort Deployment
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_REPOSITORY
Tool Name: Add Project Repository
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_SERVER_GROUPS
Tool Name: Create Server Group
Description
Action Parameters
Action Response
DEPLOYHQ_POST_PROJECTS_PROJECT_SERVERS
Tool Name: Create Server
Description
Action Parameters
Action Response
DEPLOYHQ_POST_TEMPLATES
Tool Name: Create Template
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT
Tool Name: Update Project Settings
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT_BUILD_CACHE_FILES_IDENTIFIER
Tool Name: Edit Build Cache File
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT_BUILD_COMMANDS_IDENTIFIER
Tool Name: Edit Build Command
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT_COMMANDS_IDENTIFIER
Tool Name: Edit SSH Command
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT_CONFIG_FILES_IDENTIFIER
Tool Name: Edit Config File
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT_EXCLUDED_FILE_IDENTIFIER
Tool Name: Edit Excluded File
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT_ID_EXCLUDED_FILES_ID
Tool Name: Update Excluded File
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT_ID_REPOSITORY
Tool Name: Update Project Repository
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_PROJECTS_PROJECT_SERVER_GROUPS_IDENTIFIER
Tool Name: Update Server Group
Description
Action Parameters
Action Response
DEPLOYHQ_PUT_TEMPLATES_PERMALINK
Tool Name: Edit Template
Description
Action Parameters
Action Response