All integrations

DeployHQ

DEVELOPER · DEVELOPER

Start, retry, and roll back deployments on that team’s own projects.

Acts as the person, not as itself

Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.

Credentials never touch the agent

Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.

Every call on the record

Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.

What an agent can do

Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.

deployhq_delete_agents_by_idWRITE

Permanently deletes a network agent from the account. DeployHQ DELETE /agents/{id}.

api
deployhq_delete_folders_by_idWRITE

Deletes a folder. Projects assigned to it are not deleted; they become ungrouped. DeployHQ DELETE /folders/{id}.

api
deployhq_delete_global_build_commands_by_idWRITE

Delete global build command. DeployHQ DELETE /global_build_commands/{id}.

api
deployhq_delete_global_config_files_by_idWRITE

Delete global config file. DeployHQ DELETE /global_config_files/{id}.

api
deployhq_delete_global_environment_variables_by_idWRITE

Permanently removes a global environment variable from the account. DeployHQ DELETE /global_environment_variables/{id}.

api
deployhq_delete_global_servers_by_idWRITE

Delete a global server. DeployHQ DELETE /global_servers/{id}.

api
deployhq_delete_global_ssh_commands_by_idWRITE

Delete global ssh command. DeployHQ DELETE /global_ssh_commands/{id}.

api
deployhq_delete_projects_by_idWRITE

Queues the project for deletion. Fails if any deployments are currently running. DeployHQ DELETE /projects/{id}.

api
deployhq_delete_projects_by_project_id_build_cache_files_by_idWRITE

Removes a build cache file entry from the project. The cached files will no longer persist between builds. DeployHQ DELETE /projects/{project_id}/build_cache_files/{id}.

api
deployhq_delete_projects_by_project_id_build_commands_by_idWRITE

Removes a build command from the project's build pipeline. DeployHQ DELETE /projects/{project_id}/build_commands/{id}.

api
deployhq_delete_projects_by_project_id_build_commands_unlink_globalWRITE

Removes a linked global build command from this project. DeployHQ DELETE /projects/{project_id}/build_commands/unlink_global.

api
deployhq_delete_projects_by_project_id_build_configurations_by_idWRITE

Removes a non-default build environment configuration. The default configuration cannot be deleted. DeployHQ DELETE /projects/{project_id}/build_configurations/{id}.

api
deployhq_delete_projects_by_project_id_build_known_hosts_by_idWRITE

Removes an SSH known host entry from the project's build environment. DeployHQ DELETE /projects/{project_id}/build_known_hosts/{id}.

api
deployhq_delete_projects_by_project_id_commands_by_idWRITE

Removes an SSH command from the project. DeployHQ DELETE /projects/{project_id}/commands/{id}.

api
deployhq_delete_projects_by_project_id_commands_unlink_globalWRITE

Removes a linked global SSH command from this project. DeployHQ DELETE /projects/{project_id}/commands/unlink_global.

api
deployhq_delete_projects_by_project_id_config_files_by_idWRITE

Removes a configuration file from the project. The file will no longer be deployed to servers. DeployHQ DELETE /projects/{project_id}/config_files/{id}.

api
deployhq_delete_projects_by_project_id_deployment_checks_by_idWRITE

Removes a deployment check from the project. DeployHQ DELETE /projects/{project_id}/deployment_checks/{id}.

api
deployhq_delete_projects_by_project_id_environment_variables_by_idWRITE

Permanently removes an environment variable from the project. DeployHQ DELETE /projects/{project_id}/environment_variables/{id}.

api
deployhq_delete_projects_by_project_id_excluded_files_by_idWRITE

Removes a file path from the project's exclusion list. DeployHQ DELETE /projects/{project_id}/excluded_files/{id}.

api
deployhq_delete_projects_by_project_id_integrations_by_idWRITE

Permanently removes an integration from the project. DeployHQ DELETE /projects/{project_id}/integrations/{id}.

api
deployhq_delete_projects_by_project_id_scheduled_deployments_by_idWRITE

Cancels and deletes a scheduled deployment that has not yet run. DeployHQ DELETE /projects/{project_id}/scheduled_deployments/{id}.

api
deployhq_delete_projects_by_project_id_server_groups_by_idWRITE

Permanently removes a server group from the project. DeployHQ DELETE /projects/{project_id}/server_groups/{id}.

api
deployhq_delete_projects_by_project_id_servers_by_idWRITE

Removes a server from the project. Fails if any deployments are currently running against this server. DeployHQ DELETE /projects/{project_id}/servers/{id}.

api
deployhq_delete_projects_by_project_id_ssh_commands_by_idWRITE

Removes an SSH command from the project. DeployHQ DELETE /projects/{project_id}/ssh_commands/{id}.

api
deployhq_delete_security_api_keys_by_idWRITE

Revokes an API key by its identifier. DeployHQ DELETE /security/api_keys/{id}.

api
deployhq_delete_ssh_keys_by_idWRITE

Delete an SSH key. DeployHQ DELETE /ssh_keys/{id}.

api
deployhq_delete_teams_by_idWRITE

Deletes a team. DeployHQ DELETE /teams/{id}.

api
deployhq_delete_templates_by_idWRITE

Permanently removes a template from the account. DeployHQ DELETE /templates/{id}.

api
deployhq_delete_users_by_idWRITE

Removes a user from the account. Cannot remove the account administrator. DeployHQ DELETE /users/{id}.

api
deployhq_get_accountREAD

Returns the current account's settings including plan, status, and project usage. DeployHQ GET /account.

api
deployhq_get_account_billing_statusREAD

Returns billing and subscription status for the account. DeployHQ GET /account/billing_status.

api
deployhq_get_account_invoicesREAD

Returns all finalised invoices for the account, each with a per-invoice PDF download URL. `paid_at` is null when the invoice is unpaid. A manually suspended account receives the 402 response instead, whose `suspension_reason` is null when no reason was recorded against the suspension. DeployHQ GET /account/invoices.

api
deployhq_get_account_invoices_by_idREAD

Downloads a single invoice as a PDF. A manually suspended account receives the 402 response instead, whose `suspension_reason` is null when no reason was recorded against the suspension. DeployHQ GET /account/invoices/{id}.

api
deployhq_get_agentsREAD

Returns all network agents registered to the current account. DeployHQ GET /agents.

api
deployhq_get_by_id_by_identifier_status_badge_svgREAD

Returns an SVG badge showing the last deployment status for the project or a specific server/group. No authentication required. DeployHQ GET /{id}/{identifier}/status_badge.svg.

api
deployhq_get_by_id_status_badge_svgREAD

Returns an SVG badge showing the last deployment status for the project or a specific server/group. No authentication required. DeployHQ GET /{id}/status_badge.svg.

api
deployhq_get_foldersREAD

Returns all folders in the account, ordered alphabetically by name. Each folder includes a count of projects assigned to it. DeployHQ GET /folders.

api
deployhq_get_global_build_commandsREAD

List global build commands. DeployHQ GET /global_build_commands.

api
deployhq_get_global_build_commands_by_idREAD

View global build command. DeployHQ GET /global_build_commands/{id}.

api
deployhq_get_global_config_filesREAD

List global config files. DeployHQ GET /global_config_files.

api
deployhq_get_global_config_files_by_idREAD

View global config file. DeployHQ GET /global_config_files/{id}.

api
deployhq_get_global_environment_variablesREAD

Returns all account-level environment variables available to every project. DeployHQ GET /global_environment_variables.

api
deployhq_get_global_environment_variables_by_idREAD

Returns the details of a single global environment variable. DeployHQ GET /global_environment_variables/{id}.

api
deployhq_get_global_serversREAD

List global servers. DeployHQ GET /global_servers.

api
deployhq_get_global_servers_by_idREAD

Returns the full details of a single global server. For managed_vps servers the response includes a `managed_vps` block (status, ip_address, region, size, ssh_key). The block is `null` when the underlying managed resource does not exist yet (e.g. provisioning failed before it was created). DeployHQ GET /global_servers/{id}.

api
deployhq_get_global_ssh_commandsREAD

List global ssh commands. DeployHQ GET /global_ssh_commands.

api
deployhq_get_global_ssh_commands_by_idREAD

View global ssh command. DeployHQ GET /global_ssh_commands/{id}.

api
deployhq_get_hosted_resourcesREAD

Returns both managed VPS resources (hosted_resource) and static hosting sites (hosted_website) for the authenticated account. The `kind` field discriminates; type-specific fields are populated accordingly. DeployHQ GET /hosted_resources.

api
deployhq_get_hosted_resources_by_idREAD

Returns a hosted resource (managed VPS) or hosted website (static hosting) based on the identifier. The `kind` field discriminates the response shape. DeployHQ GET /hosted_resources/{id}.

api
deployhq_get_language_versionsREAD

Returns all available language/runtime versions from the build server. DeployHQ GET /language_versions.

api
deployhq_get_managed_hosting_regionsREAD

Returns available managed VPS regions grouped geographically. DeployHQ GET /managed_hosting/regions.

api
deployhq_get_managed_hosting_sizesREAD

List available sizes. DeployHQ GET /managed_hosting/sizes.

api
deployhq_get_profileREAD

Returns the authenticated user's profile including account details and capability flags. DeployHQ GET /profile.

api
deployhq_get_projectsREAD

Returns all projects accessible to the authenticated user, sorted alphabetically. Each project includes its starred status. DeployHQ GET /projects.

api
deployhq_get_projects_by_idREAD

Returns the full details of a single project including its repository info, zone, and starred status. DeployHQ GET /projects/{id}.

api
deployhq_get_projects_by_id_insightsREAD

Returns aggregated deployment statistics and per-server metrics for the specified time period. DeployHQ GET /projects/{id}/insights.

api
deployhq_get_projects_by_id_undeployed_changesREAD

Returns the undeployed commits between the last completed deployment in the default branch and the current HEAD. Commit list is capped at 100; when capped, `truncated` is true. DeployHQ GET /projects/{id}/undeployed_changes.

api
deployhq_get_projects_by_project_id_auto_deploymentsREAD

Returns the webhook URL and auto-deploy settings for each server and server group in the project. DeployHQ GET /projects/{project_id}/auto_deployments.

api
deployhq_get_projects_by_project_id_build_cache_filesREAD

Returns all build cache files configured for the project. DeployHQ GET /projects/{project_id}/build_cache_files.

api
deployhq_get_projects_by_project_id_build_commandsREAD

Returns the project's build pipeline in execution order: the project's own build commands merged with any linked account-level (global) build commands. Each row carries a `source` of `project` or `global`; only `project` rows are actionable on the build-command member routes (show/update/destroy). DeployHQ GET /projects/{project_id}/build_commands.

api
deployhq_get_projects_by_project_id_build_configurationREAD

Returns details of a specific build environment configuration, including known hosts, cache files, and available packages. DeployHQ GET /projects/{project_id}/build_configuration.

api
deployhq_get_projects_by_project_id_build_configurationsREAD

Returns all build environment configurations for the project, including the default and any overrides. DeployHQ GET /projects/{project_id}/build_configurations.

api
deployhq_get_projects_by_project_id_build_configurations_by_idREAD

Returns details of a specific build environment configuration, including known hosts, cache files, and available packages. DeployHQ GET /projects/{project_id}/build_configurations/{id}.

api
deployhq_get_projects_by_project_id_build_known_hostsREAD

Returns all SSH known host entries configured for the project's build environment. DeployHQ GET /projects/{project_id}/build_known_hosts.

api
deployhq_get_projects_by_project_id_commandsREAD

Returns all SSH commands configured for the project, ordered ascending. SSH commands run on target servers before or after deployment. DeployHQ GET /projects/{project_id}/commands.

api
deployhq_get_projects_by_project_id_commands_by_idREAD

Returns details of a specific SSH command, including its timing, target servers, and error handling settings. DeployHQ GET /projects/{project_id}/commands/{id}.

api
deployhq_get_projects_by_project_id_config_filesREAD

Returns all configuration files for the project, ordered ascending. Config files are deployed to servers with their content during each deployment. DeployHQ GET /projects/{project_id}/config_files.

api
deployhq_get_projects_by_project_id_config_files_by_idREAD

Returns details of a specific configuration file, including its content body and server assignments. DeployHQ GET /projects/{project_id}/config_files/{id}.

api
deployhq_get_projects_by_project_id_deployment_checksREAD

Returns every deployment check configured for this project, ordered by position within each stage. DeployHQ GET /projects/{project_id}/deployment_checks.

api
deployhq_get_projects_by_project_id_deployment_checks_by_idREAD

Returns a single deployment check by its identifier. DeployHQ GET /projects/{project_id}/deployment_checks/{id}.

api
deployhq_get_projects_by_project_id_deploymentsREAD

Returns a paginated list of deployments for the project, excluding previews. Can be filtered by target server/group or limited to currently running deployments. DeployHQ GET /projects/{project_id}/deployments.

api
deployhq_get_projects_by_project_id_deployments_by_deployment_id_steps_by_step_id_logsREAD

Returns log entries for a specific deployment step, with optional pagination and download support. DeployHQ GET /projects/{project_id}/deployments/{deployment_id}/steps/{step_id}/logs.

api
deployhq_get_projects_by_project_id_deployments_by_idREAD

Returns the full details of a deployment including its steps and log entries. Archived and legacy deployments return simplified responses. DeployHQ GET /projects/{project_id}/deployments/{id}.

api
deployhq_get_projects_by_project_id_environment_variablesREAD

Returns all environment variables for the project, ordered by name. Variables can be scoped to the build pipeline or specific servers. DeployHQ GET /projects/{project_id}/environment_variables.

api
deployhq_get_projects_by_project_id_environment_variables_by_idREAD

Returns details of a specific environment variable. Locked variables will have their values masked. DeployHQ GET /projects/{project_id}/environment_variables/{id}.

api
deployhq_get_projects_by_project_id_excluded_filesREAD

Returns all files excluded from deployment for this project. DeployHQ GET /projects/{project_id}/excluded_files.

api
deployhq_get_projects_by_project_id_excluded_files_by_idREAD

Returns the details of a single excluded file by its identifier. DeployHQ GET /projects/{project_id}/excluded_files/{id}.

api
deployhq_get_projects_by_project_id_integrationsREAD

Returns all permanent integrations configured for this project. DeployHQ GET /projects/{project_id}/integrations.

api
deployhq_get_projects_by_project_id_integrations_by_idREAD

Returns the details of a single integration by its identifier. DeployHQ GET /projects/{project_id}/integrations/{id}.

api
deployhq_get_projects_by_project_id_language_versionsREAD

Returns the language versions configured for this project's default build environment. DeployHQ GET /projects/{project_id}/language_versions.

api
deployhq_get_projects_by_project_id_repositoryREAD

Returns the repository configuration for the specified project. DeployHQ GET /projects/{project_id}/repository.

api
deployhq_get_projects_by_project_id_repository_branchesREAD

Returns a map of branch names and their latest commit references for the project's repository. DeployHQ GET /projects/{project_id}/repository/branches.

api
deployhq_get_projects_by_project_id_repository_commit_infoREAD

Returns detailed information about a specific commit including author, message, tags, and avatar URL. Queues a repository update if the commit is not found. DeployHQ GET /projects/{project_id}/repository/commit_info.

api
deployhq_get_projects_by_project_id_repository_latest_revisionREAD

Returns the latest remote commit reference for the specified branch. DeployHQ GET /projects/{project_id}/repository/latest_revision.

api
deployhq_get_projects_by_project_id_repository_recent_commitsREAD

Returns recent commits and tags for the specified branch. Set update to '1' to fetch the latest data from the remote before returning results. Renders the data for the commit selector popup. DeployHQ GET /projects/{project_id}/repository/recent_commits.

api
deployhq_get_projects_by_project_id_scheduled_deploymentsREAD

Returns all forthcoming scheduled deployments for the project, ordered ascending by scheduled time. DeployHQ GET /projects/{project_id}/scheduled_deployments.

api
deployhq_get_projects_by_project_id_scheduled_deployments_by_idREAD

Returns the details of a single scheduled deployment. DeployHQ GET /projects/{project_id}/scheduled_deployments/{id}.

api
deployhq_get_projects_by_project_id_server_groupsREAD

Returns all server groups for the project, ordered ascending. DeployHQ GET /projects/{project_id}/server_groups.

api
deployhq_get_projects_by_project_id_server_groups_by_idREAD

Returns the details of a single server group. DeployHQ GET /projects/{project_id}/server_groups/{id}.

api
deployhq_get_projects_by_project_id_serversREAD

Returns all servers belonging to the specified project, including their agent associations. DeployHQ GET /projects/{project_id}/servers.

api
deployhq_get_projects_by_project_id_servers_by_idREAD

Returns the full details of a single server including its connection configuration. Returns server details including provisioning state for managed protocols. For static_hosting servers the response includes a `static_hosting` block (status, url). DeployHQ GET /projects/{project_id}/servers/{id}.

api
deployhq_get_projects_by_project_id_servers_by_id_server_metricsREAD

Returns real-time server metrics (CPU, memory, disk, uptime) collected over SSH. Requires beta features and an SSH-capable server. DeployHQ GET /projects/{project_id}/servers/{id}/server_metrics.

api
deployhq_get_projects_by_project_id_ssh_commandsREAD

Returns all SSH commands configured for the project, ordered ascending. SSH commands run on target servers before or after deployment. DeployHQ GET /projects/{project_id}/ssh_commands.

api
deployhq_get_projects_by_project_id_ssh_commands_by_idREAD

Returns details of a specific SSH command, including its timing, target servers, and error handling settings. DeployHQ GET /projects/{project_id}/ssh_commands/{id}.

api
deployhq_get_projects_by_project_id_test_access_by_idREAD

Returns the current status and results of a test access run. DeployHQ GET /projects/{project_id}/test_access/{id}.

api
deployhq_get_ssh_keysREAD

List all SSH keys. DeployHQ GET /ssh_keys.

api
deployhq_get_ssh_keys_by_id_download_private_keyREAD

Download private key. DeployHQ GET /ssh_keys/{id}/download_private_key.

api
deployhq_get_teamsREAD

Returns all teams in the account. DeployHQ GET /teams.

api
deployhq_get_teams_by_idREAD

Returns details for a specific team. DeployHQ GET /teams/{id}.

api
deployhq_get_templatesREAD

Returns all private templates belonging to the current account. DeployHQ GET /templates.

api
deployhq_get_templates_by_id_public_by_idREAD

Returns the full details of a single public template by its permalink. DeployHQ GET /templates/{id}/public/{id}.

api
deployhq_get_templates_public_templatesREAD

Returns publicly available templates, optionally filtered by framework type. DeployHQ GET /templates/public_templates.

api
deployhq_get_usersREAD

Returns all users in the account. DeployHQ GET /users.

api
deployhq_get_users_by_idREAD

Returns details for a specific user. DeployHQ GET /users/{id}.

api
deployhq_get_zonesREAD

Returns all available deployment zones. Maintenance zones are only visible to admin users. DeployHQ GET /zones.

api
deployhq_patch_accountWRITE

Updates account settings. Only account administrators can perform this action. DeployHQ PATCH /account.

api
deployhq_patch_agents_by_idWRITE

Updates the name of an existing network agent. DeployHQ PATCH /agents/{id}.

api
deployhq_patch_folders_by_idWRITE

Renames a folder. DeployHQ PATCH /folders/{id}.

api
deployhq_patch_global_build_commands_by_idWRITE

Update global build command. DeployHQ PATCH /global_build_commands/{id}.

api
deployhq_patch_global_config_files_by_idWRITE

Update global config file. DeployHQ PATCH /global_config_files/{id}.

api
deployhq_patch_global_environment_variables_by_idWRITE

Updates an existing global environment variable's name, value, or locked status. DeployHQ PATCH /global_environment_variables/{id}.

api
deployhq_patch_global_servers_by_idWRITE

Update a global server. DeployHQ PATCH /global_servers/{id}.

api
deployhq_patch_global_ssh_commands_by_idWRITE

Update global ssh command. DeployHQ PATCH /global_ssh_commands/{id}.

api
deployhq_patch_profileWRITE

Updates the authenticated user's profile settings. DeployHQ PATCH /profile.

api
deployhq_patch_projects_by_idWRITE

Updates the project's settings such as name, notification preferences, zone, and permalink. DeployHQ PATCH /projects/{id}.

api
deployhq_patch_projects_by_id_regenerate_keyWRITE

Regenerates the project SSH key and returns the new public key. key_type is optional and defaults to the existing project's algorithm; must be one of ED25519 or RSA when provided. DeployHQ PATCH /projects/{id}/regenerate_key.

api
deployhq_patch_projects_by_id_upload_keyWRITE

Uploads a custom SSH private key for the project and returns the corresponding public key. DeployHQ PATCH /projects/{id}/upload_key.

api
deployhq_patch_projects_by_project_id_build_cache_files_by_idWRITE

Updates the path of an existing build cache file entry. DeployHQ PATCH /projects/{project_id}/build_cache_files/{id}.

api
deployhq_patch_projects_by_project_id_build_commands_by_idWRITE

Updates an existing build command's properties such as the command string, description, or error handling behavior. DeployHQ PATCH /projects/{project_id}/build_commands/{id}.

api
deployhq_patch_projects_by_project_id_build_configurations_by_idWRITE

Updates which servers a build configuration override targets. Only the target server assignment can be changed here; language versions are set with the Language Versions endpoint. Send server_identifiers listing the servers the override applies to. An override with no target servers does not apply to any server. DeployHQ PATCH /projects/{project_id}/build_configurations/{id}.

api
deployhq_patch_projects_by_project_id_build_configurations_by_override_build_configuration_id_build_languages_by_idWRITE

Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override. DeployHQ PATCH /projects/{project_id}/build_configurations/{override_build_configuration_id}/build_languages/{id}.

api
deployhq_patch_projects_by_project_id_build_languages_by_idWRITE

Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override. DeployHQ PATCH /projects/{project_id}/build_languages/{id}.

api
deployhq_patch_projects_by_project_id_commands_by_idWRITE

Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided. DeployHQ PATCH /projects/{project_id}/commands/{id}.

api
deployhq_patch_projects_by_project_id_config_files_by_idWRITE

Updates an existing configuration file's path, content, server assignments, or other properties. DeployHQ PATCH /projects/{project_id}/config_files/{id}.

api
deployhq_patch_projects_by_project_id_deployment_checks_by_idWRITE

Updates an existing deployment check. Same payload shape as create — any field can be sent on its own (PATCH semantics: missing keys leave existing values untouched). DeployHQ PATCH /projects/{project_id}/deployment_checks/{id}.

api
deployhq_patch_projects_by_project_id_environment_variables_by_idWRITE

Updates an existing environment variable's name, value, or settings. Server assignments are only modified when server parameters are explicitly provided. DeployHQ PATCH /projects/{project_id}/environment_variables/{id}.

api
deployhq_patch_projects_by_project_id_excluded_files_by_idWRITE

Updates the path of an existing excluded file entry. DeployHQ PATCH /projects/{project_id}/excluded_files/{id}.

api
deployhq_patch_projects_by_project_id_integrations_by_idWRITE

Updates an existing integration's settings. The hook_type cannot be changed via the API. DeployHQ PATCH /projects/{project_id}/integrations/{id}.

api
deployhq_patch_projects_by_project_id_repositoryWRITE

Updates the repository's branch, root path, or hosting service type without replacing the entire repository configuration. DeployHQ PATCH /projects/{project_id}/repository.

api
deployhq_patch_projects_by_project_id_scheduled_deployments_by_idWRITE

Updates an existing scheduled deployment. DeployHQ PATCH /projects/{project_id}/scheduled_deployments/{id}.

api
deployhq_patch_projects_by_project_id_server_groups_by_idWRITE

Updates an existing server group's settings such as name, branch, or transfer order. DeployHQ PATCH /projects/{project_id}/server_groups/{id}.

api
deployhq_patch_projects_by_project_id_servers_by_idWRITE

Updates an existing server's configuration. If the server uses external authentication and is not yet authenticated, a redirect to the OAuth URL is returned. DeployHQ PATCH /projects/{project_id}/servers/{id}.

api
deployhq_patch_projects_by_project_id_ssh_commands_by_idWRITE

Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided. DeployHQ PATCH /projects/{project_id}/ssh_commands/{id}.

api
deployhq_patch_teams_by_idWRITE

Updates an existing team. DeployHQ PATCH /teams/{id}.

api
deployhq_patch_templates_by_idWRITE

Updates an existing template's name or description. DeployHQ PATCH /templates/{id}.

api
deployhq_patch_users_by_idWRITE

Updates an existing user's details and permissions. Only account administrators can change permission flags. DeployHQ PATCH /users/{id}.

api
deployhq_post_agentsWRITE

Claims an unclaimed network agent using its claim code and registers it to the current account. DeployHQ POST /agents.

api
deployhq_post_agents_by_id_revokeWRITE

Revokes the agent's claim, releasing it from the account so it can be reclaimed. DeployHQ POST /agents/{id}/revoke.

api
deployhq_post_beta_enrollmentsWRITE

Enroll the current account in the managed-resources beta. DeployHQ POST /beta/enrollments.

api
deployhq_post_detectionWRITE

Detects the project's framework/stack from an uploaded filename listing plus the contents of key manifest files. DeployHQ POST /detection.

api
deployhq_post_foldersWRITE

Creates a new folder in the account. DeployHQ POST /folders.

api
deployhq_post_global_build_commandsWRITE

Create new global build command. DeployHQ POST /global_build_commands.

api
deployhq_post_global_config_filesWRITE

Create new global config file. DeployHQ POST /global_config_files.

api
deployhq_post_global_environment_variablesWRITE

Creates a new account-level environment variable. Locked variables cannot be read back after creation. DeployHQ POST /global_environment_variables.

api
deployhq_post_global_serversWRITE

Create a global server. DeployHQ POST /global_servers.

api
deployhq_post_global_servers_by_id_copy_to_projectWRITE

Copy a global server to a project. DeployHQ POST /global_servers/{id}/copy_to_project.

api
deployhq_post_global_ssh_commandsWRITE

Create new global ssh command. DeployHQ POST /global_ssh_commands.

api
deployhq_post_hosted_resources_by_id_retry_provisionWRITE

Retries provisioning for a hosted resource that is in an error state. Resets the status to provisioning and enqueues a new provision job. DeployHQ POST /hosted_resources/{id}/retry_provision.

api
deployhq_post_hosted_resources_by_id_syncWRITE

Sync a hosted resource. DeployHQ POST /hosted_resources/{id}/sync.

api
deployhq_post_projectsWRITE

Creates a new project in the account. Optionally applies a template to pre-populate servers, config files, and other settings. DeployHQ POST /projects.

api
deployhq_post_projects_by_id_ai_deployment_overviewWRITE

Generates an AI-powered summary of changes between two revisions based on commit messages. Requires a configured and cloned repository. DeployHQ POST /projects/{id}/ai_deployment_overview.

api
deployhq_post_projects_by_id_starWRITE

Toggles the starred status of a project for the current user. Starred projects appear prioritized in listings. DeployHQ POST /projects/{id}/star.

api
deployhq_post_projects_by_project_id_auto_deploymentsWRITE

Enables or disables automatic deployments for individual servers and server groups. Unrecognized identifiers are skipped and reported in the response. DeployHQ POST /projects/{project_id}/auto_deployments.

api
deployhq_post_projects_by_project_id_build_cache_filesWRITE

Creates a new build cache file entry for the project. Build cache files persist between builds to speed up subsequent build runs. DeployHQ POST /projects/{project_id}/build_cache_files.

api
deployhq_post_projects_by_project_id_build_commandsWRITE

Adds a new build command to the project's build pipeline. Commands execute in order during the build phase. DeployHQ POST /projects/{project_id}/build_commands.

api
deployhq_post_projects_by_project_id_build_commands_link_globalWRITE

Links an account-level global build command to this project so it runs during the build pipeline. DeployHQ POST /projects/{project_id}/build_commands/link_global.

api
deployhq_post_projects_by_project_id_build_configurationsWRITE

Creates a new, empty non-default build environment override. No attributes are read from the request body; the override is returned with no target servers and no language versions set. Assign target servers with the update endpoint, and set language versions with the Language Versions endpoint. DeployHQ POST /projects/{project_id}/build_configurations.

api
deployhq_post_projects_by_project_id_build_known_hostsWRITE

Adds an SSH known host entry so the build server can connect to the specified hostname without host key verification prompts. DeployHQ POST /projects/{project_id}/build_known_hosts.

api
deployhq_post_projects_by_project_id_commandsWRITE

Creates a new SSH command for the project. Commands can be configured to run before or after deployment on specified servers. DeployHQ POST /projects/{project_id}/commands.

api
deployhq_post_projects_by_project_id_commands_link_globalWRITE

Links an account-level global SSH command to this project so it runs during deployments. DeployHQ POST /projects/{project_id}/commands/link_global.

api
deployhq_post_projects_by_project_id_config_filesWRITE

Creates a new configuration file for the project. The file will be deployed to the specified path on target servers during each deployment. DeployHQ POST /projects/{project_id}/config_files.

api
deployhq_post_projects_by_project_id_deployment_checksWRITE

Creates a new deployment check on the project. A check has a stage (pre_build or post_deploy) and a check_type (ssh, http, or vulnerability_scan). DeployHQ POST /projects/{project_id}/deployment_checks.

api
deployhq_post_projects_by_project_id_deploymentsWRITE

Creates a new deployment for the project. Set mode to 'queue' to execute immediately or 'preview' to generate a preview of changes without deploying. If a schedule block is provided, the deployment is scheduled for future or recurring execution. Use parent_identifier to target a specific server or server group. DeployHQ POST /projects/{project_id}/deployments.

api
deployhq_post_projects_by_project_id_deployments_by_id_abortWRITE

Immediately aborts a deployment that is currently in progress. DeployHQ POST /projects/{project_id}/deployments/{id}/abort.

api
deployhq_post_projects_by_project_id_deployments_by_id_retryWRITE

Retries a failed deployment by resetting it and re-queuing. Only deployments that have completed (successfully or with failure) can be retried. DeployHQ POST /projects/{project_id}/deployments/{id}/retry.

api
deployhq_post_projects_by_project_id_deployments_by_id_rollbackWRITE

Creates a new deployment that reverts the project to the state of the specified deployment. Archived deployments cannot be rolled back. DeployHQ POST /projects/{project_id}/deployments/{id}/rollback.

api
deployhq_post_projects_by_project_id_environment_variablesWRITE

Creates a new environment variable for the project. Variables can be locked to prevent value visibility and scoped to the build pipeline. DeployHQ POST /projects/{project_id}/environment_variables.

api
deployhq_post_projects_by_project_id_excluded_filesWRITE

Adds a file path to the project's exclusion list so it is skipped during deployments. DeployHQ POST /projects/{project_id}/excluded_files.

api
deployhq_post_projects_by_project_id_integrationsWRITE

Creates a new integration for the project. Only certain hook types are allowed via the API. DeployHQ POST /projects/{project_id}/integrations.

api
deployhq_post_projects_by_project_id_repositoryWRITE

Replaces the project's repository configuration. Any existing repository is destroyed and a new one is created with the provided settings. DeployHQ POST /projects/{project_id}/repository.

api
deployhq_post_projects_by_project_id_scheduled_deploymentsWRITE

Creates a new scheduled deployment for the project. DeployHQ POST /projects/{project_id}/scheduled_deployments.

api
deployhq_post_projects_by_project_id_server_groupsWRITE

Creates a new server group for the project to organize servers and control deployment order. DeployHQ POST /projects/{project_id}/server_groups.

api
deployhq_post_projects_by_project_id_serversWRITE

Creates a new server in the project. The protocol_type determines which additional connection parameters are required: SSH needs hostname and username, FTP needs hostname, username, and password, S3 needs bucket_name, access_key_id, and secret_access_key. DeployHQ POST /projects/{project_id}/servers.

api
deployhq_post_projects_by_project_id_servers_by_id_reset_host_keyWRITE

Clears the stored SSH host key for the server, allowing it to accept a new key on the next connection. DeployHQ POST /projects/{project_id}/servers/{id}/reset_host_key.

api
deployhq_post_projects_by_project_id_servers_by_server_id_test_accessWRITE

Triggers a test access run for the project. Tests repository connectivity and all server connections. If a server_id is provided (via nested route), only that server is tested. DeployHQ POST /projects/{project_id}/servers/{server_id}/test_access.

api
deployhq_post_projects_by_project_id_ssh_commandsWRITE

Creates a new SSH command for the project. Commands can be configured to run before or after deployment on specified servers. DeployHQ POST /projects/{project_id}/ssh_commands.

api
deployhq_post_projects_by_project_id_test_accessWRITE

Triggers a test access run for the project. Tests repository connectivity and all server connections. If a server_id is provided (via nested route), only that server is tested. DeployHQ POST /projects/{project_id}/test_access.

api
deployhq_post_resetWRITE

Initiates a password reset for the given email address. No authentication required. DeployHQ POST /reset.

api
deployhq_post_security_api_keysWRITE

Creates a new API key for the authenticated user. The full key value is only returned once in this response. DeployHQ POST /security/api_keys.

api
deployhq_post_ssh_keysWRITE

Create an SSH key. DeployHQ POST /ssh_keys.

api
deployhq_post_teamsWRITE

Creates a new team. DeployHQ POST /teams.

api
deployhq_post_templatesWRITE

Creates a new template, optionally copying configuration from an existing project. DeployHQ POST /templates.

api
deployhq_post_usersWRITE

Invites a new user to the account. Sends an invitation email. DeployHQ POST /users.

api
deployhq_post_users_by_id_resend_invitationWRITE

Resends the invitation email for a user who has not yet activated their account. DeployHQ POST /users/{id}/resend_invitation.

api
deployhq_put_accountWRITE

Updates account settings. Only account administrators can perform this action. DeployHQ PUT /account.

api
deployhq_put_agents_by_idWRITE

Updates the name of an existing network agent. DeployHQ PUT /agents/{id}.

api
deployhq_put_folders_by_idWRITE

Renames a folder. DeployHQ PUT /folders/{id}.

api
deployhq_put_global_build_commands_by_idWRITE

Update global build command. DeployHQ PUT /global_build_commands/{id}.

api
deployhq_put_global_config_files_by_idWRITE

Update global config file. DeployHQ PUT /global_config_files/{id}.

api
deployhq_put_global_environment_variables_by_idWRITE

Updates an existing global environment variable's name, value, or locked status. DeployHQ PUT /global_environment_variables/{id}.

api
deployhq_put_global_servers_by_idWRITE

Update a global server. DeployHQ PUT /global_servers/{id}.

api
deployhq_put_global_ssh_commands_by_idWRITE

Update global ssh command. DeployHQ PUT /global_ssh_commands/{id}.

api
deployhq_put_profileWRITE

Updates the authenticated user's profile settings. DeployHQ PUT /profile.

api
deployhq_put_projects_by_idWRITE

Updates the project's settings such as name, notification preferences, zone, and permalink. DeployHQ PUT /projects/{id}.

api
deployhq_put_projects_by_project_id_build_cache_files_by_idWRITE

Updates the path of an existing build cache file entry. DeployHQ PUT /projects/{project_id}/build_cache_files/{id}.

api
deployhq_put_projects_by_project_id_build_commands_by_idWRITE

Updates an existing build command's properties such as the command string, description, or error handling behavior. DeployHQ PUT /projects/{project_id}/build_commands/{id}.

api
deployhq_put_projects_by_project_id_build_configurations_by_idWRITE

Updates which servers a build configuration override targets. Only the target server assignment can be changed here; language versions are set with the Language Versions endpoint. Send server_identifiers listing the servers the override applies to. An override with no target servers does not apply to any server. DeployHQ PUT /projects/{project_id}/build_configurations/{id}.

api
deployhq_put_projects_by_project_id_build_configurations_by_override_build_configuration_id_build_languages_by_idWRITE

Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override. DeployHQ PUT /projects/{project_id}/build_configurations/{override_build_configuration_id}/build_languages/{id}.

api
deployhq_put_projects_by_project_id_build_languages_by_idWRITE

Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override. DeployHQ PUT /projects/{project_id}/build_languages/{id}.

api
deployhq_put_projects_by_project_id_commands_by_idWRITE

Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided. DeployHQ PUT /projects/{project_id}/commands/{id}.

api
deployhq_put_projects_by_project_id_config_files_by_idWRITE

Updates an existing configuration file's path, content, server assignments, or other properties. DeployHQ PUT /projects/{project_id}/config_files/{id}.

api
deployhq_put_projects_by_project_id_deployment_checks_by_idWRITE

Updates an existing deployment check. Same payload shape as create — any field can be sent on its own (PATCH semantics: missing keys leave existing values untouched). DeployHQ PUT /projects/{project_id}/deployment_checks/{id}.

api
deployhq_put_projects_by_project_id_environment_variables_by_idWRITE

Updates an existing environment variable's name, value, or settings. Server assignments are only modified when server parameters are explicitly provided. DeployHQ PUT /projects/{project_id}/environment_variables/{id}.

api
deployhq_put_projects_by_project_id_excluded_files_by_idWRITE

Updates the path of an existing excluded file entry. DeployHQ PUT /projects/{project_id}/excluded_files/{id}.

api
deployhq_put_projects_by_project_id_integrations_by_idWRITE

Updates an existing integration's settings. The hook_type cannot be changed via the API. DeployHQ PUT /projects/{project_id}/integrations/{id}.

api
deployhq_put_projects_by_project_id_repositoryWRITE

Updates the repository's branch, root path, or hosting service type without replacing the entire repository configuration. DeployHQ PUT /projects/{project_id}/repository.

api
deployhq_put_projects_by_project_id_scheduled_deployments_by_idWRITE

Updates an existing scheduled deployment. DeployHQ PUT /projects/{project_id}/scheduled_deployments/{id}.

api
deployhq_put_projects_by_project_id_server_groups_by_idWRITE

Updates an existing server group's settings such as name, branch, or transfer order. DeployHQ PUT /projects/{project_id}/server_groups/{id}.

api
deployhq_put_projects_by_project_id_servers_by_idWRITE

Updates an existing server's configuration. If the server uses external authentication and is not yet authenticated, a redirect to the OAuth URL is returned. DeployHQ PUT /projects/{project_id}/servers/{id}.

api
deployhq_put_projects_by_project_id_ssh_commands_by_idWRITE

Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided. DeployHQ PUT /projects/{project_id}/ssh_commands/{id}.

api
deployhq_put_teams_by_idWRITE

Updates an existing team. DeployHQ PUT /teams/{id}.

api
deployhq_put_templates_by_idWRITE

Updates an existing template's name or description. DeployHQ PUT /templates/{id}.

api
deployhq_put_users_by_idWRITE

Updates an existing user's details and permissions. Only account administrators can change permission flags. DeployHQ PUT /users/{id}.

api

Put DeployHQ behind one governed endpoint.

Same permissions, same audit trail, whatever else you connect next.