DEVELOPER · DEVELOPER
Start, retry, and roll back deployments on that team’s own projects.
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.
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.
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.
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_idWRITEPermanently deletes a network agent from the account. DeployHQ DELETE /agents/{id}.
deployhq_delete_folders_by_idWRITEDeletes a folder. Projects assigned to it are not deleted; they become ungrouped. DeployHQ DELETE /folders/{id}.
deployhq_delete_global_build_commands_by_idWRITEDelete global build command. DeployHQ DELETE /global_build_commands/{id}.
deployhq_delete_global_config_files_by_idWRITEDelete global config file. DeployHQ DELETE /global_config_files/{id}.
deployhq_delete_global_environment_variables_by_idWRITEPermanently removes a global environment variable from the account. DeployHQ DELETE /global_environment_variables/{id}.
deployhq_delete_global_servers_by_idWRITEDelete a global server. DeployHQ DELETE /global_servers/{id}.
deployhq_delete_global_ssh_commands_by_idWRITEDelete global ssh command. DeployHQ DELETE /global_ssh_commands/{id}.
deployhq_delete_projects_by_idWRITEQueues the project for deletion. Fails if any deployments are currently running. DeployHQ DELETE /projects/{id}.
deployhq_delete_projects_by_project_id_build_cache_files_by_idWRITERemoves 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}.
deployhq_delete_projects_by_project_id_build_commands_by_idWRITERemoves a build command from the project's build pipeline. DeployHQ DELETE /projects/{project_id}/build_commands/{id}.
deployhq_delete_projects_by_project_id_build_commands_unlink_globalWRITERemoves a linked global build command from this project. DeployHQ DELETE /projects/{project_id}/build_commands/unlink_global.
deployhq_delete_projects_by_project_id_build_configurations_by_idWRITERemoves a non-default build environment configuration. The default configuration cannot be deleted. DeployHQ DELETE /projects/{project_id}/build_configurations/{id}.
deployhq_delete_projects_by_project_id_build_known_hosts_by_idWRITERemoves an SSH known host entry from the project's build environment. DeployHQ DELETE /projects/{project_id}/build_known_hosts/{id}.
deployhq_delete_projects_by_project_id_commands_by_idWRITERemoves an SSH command from the project. DeployHQ DELETE /projects/{project_id}/commands/{id}.
deployhq_delete_projects_by_project_id_commands_unlink_globalWRITERemoves a linked global SSH command from this project. DeployHQ DELETE /projects/{project_id}/commands/unlink_global.
deployhq_delete_projects_by_project_id_config_files_by_idWRITERemoves a configuration file from the project. The file will no longer be deployed to servers. DeployHQ DELETE /projects/{project_id}/config_files/{id}.
deployhq_delete_projects_by_project_id_deployment_checks_by_idWRITERemoves a deployment check from the project. DeployHQ DELETE /projects/{project_id}/deployment_checks/{id}.
deployhq_delete_projects_by_project_id_environment_variables_by_idWRITEPermanently removes an environment variable from the project. DeployHQ DELETE /projects/{project_id}/environment_variables/{id}.
deployhq_delete_projects_by_project_id_excluded_files_by_idWRITERemoves a file path from the project's exclusion list. DeployHQ DELETE /projects/{project_id}/excluded_files/{id}.
deployhq_delete_projects_by_project_id_integrations_by_idWRITEPermanently removes an integration from the project. DeployHQ DELETE /projects/{project_id}/integrations/{id}.
deployhq_delete_projects_by_project_id_scheduled_deployments_by_idWRITECancels and deletes a scheduled deployment that has not yet run. DeployHQ DELETE /projects/{project_id}/scheduled_deployments/{id}.
deployhq_delete_projects_by_project_id_server_groups_by_idWRITEPermanently removes a server group from the project. DeployHQ DELETE /projects/{project_id}/server_groups/{id}.
deployhq_delete_projects_by_project_id_servers_by_idWRITERemoves a server from the project. Fails if any deployments are currently running against this server. DeployHQ DELETE /projects/{project_id}/servers/{id}.
deployhq_delete_projects_by_project_id_ssh_commands_by_idWRITERemoves an SSH command from the project. DeployHQ DELETE /projects/{project_id}/ssh_commands/{id}.
deployhq_delete_security_api_keys_by_idWRITERevokes an API key by its identifier. DeployHQ DELETE /security/api_keys/{id}.
deployhq_delete_ssh_keys_by_idWRITEDelete an SSH key. DeployHQ DELETE /ssh_keys/{id}.
deployhq_delete_teams_by_idWRITEDeletes a team. DeployHQ DELETE /teams/{id}.
deployhq_delete_templates_by_idWRITEPermanently removes a template from the account. DeployHQ DELETE /templates/{id}.
deployhq_delete_users_by_idWRITERemoves a user from the account. Cannot remove the account administrator. DeployHQ DELETE /users/{id}.
deployhq_get_accountREADReturns the current account's settings including plan, status, and project usage. DeployHQ GET /account.
deployhq_get_account_billing_statusREADReturns billing and subscription status for the account. DeployHQ GET /account/billing_status.
deployhq_get_account_invoicesREADReturns 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.
deployhq_get_account_invoices_by_idREADDownloads 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}.
deployhq_get_agentsREADReturns all network agents registered to the current account. DeployHQ GET /agents.
deployhq_get_by_id_by_identifier_status_badge_svgREADReturns 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.
deployhq_get_by_id_status_badge_svgREADReturns 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.
deployhq_get_foldersREADReturns all folders in the account, ordered alphabetically by name. Each folder includes a count of projects assigned to it. DeployHQ GET /folders.
deployhq_get_global_build_commandsREADList global build commands. DeployHQ GET /global_build_commands.
deployhq_get_global_build_commands_by_idREADView global build command. DeployHQ GET /global_build_commands/{id}.
deployhq_get_global_config_filesREADList global config files. DeployHQ GET /global_config_files.
deployhq_get_global_config_files_by_idREADView global config file. DeployHQ GET /global_config_files/{id}.
deployhq_get_global_environment_variablesREADReturns all account-level environment variables available to every project. DeployHQ GET /global_environment_variables.
deployhq_get_global_environment_variables_by_idREADReturns the details of a single global environment variable. DeployHQ GET /global_environment_variables/{id}.
deployhq_get_global_serversREADList global servers. DeployHQ GET /global_servers.
deployhq_get_global_servers_by_idREADReturns 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}.
deployhq_get_global_ssh_commandsREADList global ssh commands. DeployHQ GET /global_ssh_commands.
deployhq_get_global_ssh_commands_by_idREADView global ssh command. DeployHQ GET /global_ssh_commands/{id}.
deployhq_get_hosted_resourcesREADReturns 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.
deployhq_get_hosted_resources_by_idREADReturns 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}.
deployhq_get_language_versionsREADReturns all available language/runtime versions from the build server. DeployHQ GET /language_versions.
deployhq_get_managed_hosting_regionsREADReturns available managed VPS regions grouped geographically. DeployHQ GET /managed_hosting/regions.
deployhq_get_managed_hosting_sizesREADList available sizes. DeployHQ GET /managed_hosting/sizes.
deployhq_get_profileREADReturns the authenticated user's profile including account details and capability flags. DeployHQ GET /profile.
deployhq_get_projectsREADReturns all projects accessible to the authenticated user, sorted alphabetically. Each project includes its starred status. DeployHQ GET /projects.
deployhq_get_projects_by_idREADReturns the full details of a single project including its repository info, zone, and starred status. DeployHQ GET /projects/{id}.
deployhq_get_projects_by_id_insightsREADReturns aggregated deployment statistics and per-server metrics for the specified time period. DeployHQ GET /projects/{id}/insights.
deployhq_get_projects_by_id_undeployed_changesREADReturns 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.
deployhq_get_projects_by_project_id_auto_deploymentsREADReturns the webhook URL and auto-deploy settings for each server and server group in the project. DeployHQ GET /projects/{project_id}/auto_deployments.
deployhq_get_projects_by_project_id_build_cache_filesREADReturns all build cache files configured for the project. DeployHQ GET /projects/{project_id}/build_cache_files.
deployhq_get_projects_by_project_id_build_commandsREADReturns 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.
deployhq_get_projects_by_project_id_build_configurationREADReturns details of a specific build environment configuration, including known hosts, cache files, and available packages. DeployHQ GET /projects/{project_id}/build_configuration.
deployhq_get_projects_by_project_id_build_configurationsREADReturns all build environment configurations for the project, including the default and any overrides. DeployHQ GET /projects/{project_id}/build_configurations.
deployhq_get_projects_by_project_id_build_configurations_by_idREADReturns details of a specific build environment configuration, including known hosts, cache files, and available packages. DeployHQ GET /projects/{project_id}/build_configurations/{id}.
deployhq_get_projects_by_project_id_build_known_hostsREADReturns all SSH known host entries configured for the project's build environment. DeployHQ GET /projects/{project_id}/build_known_hosts.
deployhq_get_projects_by_project_id_commandsREADReturns 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.
deployhq_get_projects_by_project_id_commands_by_idREADReturns details of a specific SSH command, including its timing, target servers, and error handling settings. DeployHQ GET /projects/{project_id}/commands/{id}.
deployhq_get_projects_by_project_id_config_filesREADReturns 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.
deployhq_get_projects_by_project_id_config_files_by_idREADReturns details of a specific configuration file, including its content body and server assignments. DeployHQ GET /projects/{project_id}/config_files/{id}.
deployhq_get_projects_by_project_id_deployment_checksREADReturns every deployment check configured for this project, ordered by position within each stage. DeployHQ GET /projects/{project_id}/deployment_checks.
deployhq_get_projects_by_project_id_deployment_checks_by_idREADReturns a single deployment check by its identifier. DeployHQ GET /projects/{project_id}/deployment_checks/{id}.
deployhq_get_projects_by_project_id_deploymentsREADReturns 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.
deployhq_get_projects_by_project_id_deployments_by_deployment_id_steps_by_step_id_logsREADReturns 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.
deployhq_get_projects_by_project_id_deployments_by_idREADReturns 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}.
deployhq_get_projects_by_project_id_environment_variablesREADReturns 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.
deployhq_get_projects_by_project_id_environment_variables_by_idREADReturns details of a specific environment variable. Locked variables will have their values masked. DeployHQ GET /projects/{project_id}/environment_variables/{id}.
deployhq_get_projects_by_project_id_excluded_filesREADReturns all files excluded from deployment for this project. DeployHQ GET /projects/{project_id}/excluded_files.
deployhq_get_projects_by_project_id_excluded_files_by_idREADReturns the details of a single excluded file by its identifier. DeployHQ GET /projects/{project_id}/excluded_files/{id}.
deployhq_get_projects_by_project_id_integrationsREADReturns all permanent integrations configured for this project. DeployHQ GET /projects/{project_id}/integrations.
deployhq_get_projects_by_project_id_integrations_by_idREADReturns the details of a single integration by its identifier. DeployHQ GET /projects/{project_id}/integrations/{id}.
deployhq_get_projects_by_project_id_language_versionsREADReturns the language versions configured for this project's default build environment. DeployHQ GET /projects/{project_id}/language_versions.
deployhq_get_projects_by_project_id_repositoryREADReturns the repository configuration for the specified project. DeployHQ GET /projects/{project_id}/repository.
deployhq_get_projects_by_project_id_repository_branchesREADReturns a map of branch names and their latest commit references for the project's repository. DeployHQ GET /projects/{project_id}/repository/branches.
deployhq_get_projects_by_project_id_repository_commit_infoREADReturns 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.
deployhq_get_projects_by_project_id_repository_latest_revisionREADReturns the latest remote commit reference for the specified branch. DeployHQ GET /projects/{project_id}/repository/latest_revision.
deployhq_get_projects_by_project_id_repository_recent_commitsREADReturns 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.
deployhq_get_projects_by_project_id_scheduled_deploymentsREADReturns all forthcoming scheduled deployments for the project, ordered ascending by scheduled time. DeployHQ GET /projects/{project_id}/scheduled_deployments.
deployhq_get_projects_by_project_id_scheduled_deployments_by_idREADReturns the details of a single scheduled deployment. DeployHQ GET /projects/{project_id}/scheduled_deployments/{id}.
deployhq_get_projects_by_project_id_server_groupsREADReturns all server groups for the project, ordered ascending. DeployHQ GET /projects/{project_id}/server_groups.
deployhq_get_projects_by_project_id_server_groups_by_idREADReturns the details of a single server group. DeployHQ GET /projects/{project_id}/server_groups/{id}.
deployhq_get_projects_by_project_id_serversREADReturns all servers belonging to the specified project, including their agent associations. DeployHQ GET /projects/{project_id}/servers.
deployhq_get_projects_by_project_id_servers_by_idREADReturns 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}.
deployhq_get_projects_by_project_id_servers_by_id_server_metricsREADReturns 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.
deployhq_get_projects_by_project_id_ssh_commandsREADReturns 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.
deployhq_get_projects_by_project_id_ssh_commands_by_idREADReturns details of a specific SSH command, including its timing, target servers, and error handling settings. DeployHQ GET /projects/{project_id}/ssh_commands/{id}.
deployhq_get_projects_by_project_id_test_access_by_idREADReturns the current status and results of a test access run. DeployHQ GET /projects/{project_id}/test_access/{id}.
deployhq_get_ssh_keysREADList all SSH keys. DeployHQ GET /ssh_keys.
deployhq_get_ssh_keys_by_id_download_private_keyREADDownload private key. DeployHQ GET /ssh_keys/{id}/download_private_key.
deployhq_get_teamsREADReturns all teams in the account. DeployHQ GET /teams.
deployhq_get_teams_by_idREADReturns details for a specific team. DeployHQ GET /teams/{id}.
deployhq_get_templatesREADReturns all private templates belonging to the current account. DeployHQ GET /templates.
deployhq_get_templates_by_id_public_by_idREADReturns the full details of a single public template by its permalink. DeployHQ GET /templates/{id}/public/{id}.
deployhq_get_templates_public_templatesREADReturns publicly available templates, optionally filtered by framework type. DeployHQ GET /templates/public_templates.
deployhq_get_usersREADReturns all users in the account. DeployHQ GET /users.
deployhq_get_users_by_idREADReturns details for a specific user. DeployHQ GET /users/{id}.
deployhq_get_zonesREADReturns all available deployment zones. Maintenance zones are only visible to admin users. DeployHQ GET /zones.
deployhq_patch_accountWRITEUpdates account settings. Only account administrators can perform this action. DeployHQ PATCH /account.
deployhq_patch_agents_by_idWRITEUpdates the name of an existing network agent. DeployHQ PATCH /agents/{id}.
deployhq_patch_folders_by_idWRITERenames a folder. DeployHQ PATCH /folders/{id}.
deployhq_patch_global_build_commands_by_idWRITEUpdate global build command. DeployHQ PATCH /global_build_commands/{id}.
deployhq_patch_global_config_files_by_idWRITEUpdate global config file. DeployHQ PATCH /global_config_files/{id}.
deployhq_patch_global_environment_variables_by_idWRITEUpdates an existing global environment variable's name, value, or locked status. DeployHQ PATCH /global_environment_variables/{id}.
deployhq_patch_global_servers_by_idWRITEUpdate a global server. DeployHQ PATCH /global_servers/{id}.
deployhq_patch_global_ssh_commands_by_idWRITEUpdate global ssh command. DeployHQ PATCH /global_ssh_commands/{id}.
deployhq_patch_profileWRITEUpdates the authenticated user's profile settings. DeployHQ PATCH /profile.
deployhq_patch_projects_by_idWRITEUpdates the project's settings such as name, notification preferences, zone, and permalink. DeployHQ PATCH /projects/{id}.
deployhq_patch_projects_by_id_regenerate_keyWRITERegenerates 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.
deployhq_patch_projects_by_id_upload_keyWRITEUploads a custom SSH private key for the project and returns the corresponding public key. DeployHQ PATCH /projects/{id}/upload_key.
deployhq_patch_projects_by_project_id_build_cache_files_by_idWRITEUpdates the path of an existing build cache file entry. DeployHQ PATCH /projects/{project_id}/build_cache_files/{id}.
deployhq_patch_projects_by_project_id_build_commands_by_idWRITEUpdates an existing build command's properties such as the command string, description, or error handling behavior. DeployHQ PATCH /projects/{project_id}/build_commands/{id}.
deployhq_patch_projects_by_project_id_build_configurations_by_idWRITEUpdates 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}.
deployhq_patch_projects_by_project_id_build_configurations_by_override_build_configuration_id_build_languages_by_idWRITESets 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}.
deployhq_patch_projects_by_project_id_build_languages_by_idWRITESets 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}.
deployhq_patch_projects_by_project_id_commands_by_idWRITEUpdates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided. DeployHQ PATCH /projects/{project_id}/commands/{id}.
deployhq_patch_projects_by_project_id_config_files_by_idWRITEUpdates an existing configuration file's path, content, server assignments, or other properties. DeployHQ PATCH /projects/{project_id}/config_files/{id}.
deployhq_patch_projects_by_project_id_deployment_checks_by_idWRITEUpdates 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}.
deployhq_patch_projects_by_project_id_environment_variables_by_idWRITEUpdates 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}.
deployhq_patch_projects_by_project_id_excluded_files_by_idWRITEUpdates the path of an existing excluded file entry. DeployHQ PATCH /projects/{project_id}/excluded_files/{id}.
deployhq_patch_projects_by_project_id_integrations_by_idWRITEUpdates an existing integration's settings. The hook_type cannot be changed via the API. DeployHQ PATCH /projects/{project_id}/integrations/{id}.
deployhq_patch_projects_by_project_id_repositoryWRITEUpdates the repository's branch, root path, or hosting service type without replacing the entire repository configuration. DeployHQ PATCH /projects/{project_id}/repository.
deployhq_patch_projects_by_project_id_scheduled_deployments_by_idWRITEUpdates an existing scheduled deployment. DeployHQ PATCH /projects/{project_id}/scheduled_deployments/{id}.
deployhq_patch_projects_by_project_id_server_groups_by_idWRITEUpdates an existing server group's settings such as name, branch, or transfer order. DeployHQ PATCH /projects/{project_id}/server_groups/{id}.
deployhq_patch_projects_by_project_id_servers_by_idWRITEUpdates 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}.
deployhq_patch_projects_by_project_id_ssh_commands_by_idWRITEUpdates 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}.
deployhq_patch_teams_by_idWRITEUpdates an existing team. DeployHQ PATCH /teams/{id}.
deployhq_patch_templates_by_idWRITEUpdates an existing template's name or description. DeployHQ PATCH /templates/{id}.
deployhq_patch_users_by_idWRITEUpdates an existing user's details and permissions. Only account administrators can change permission flags. DeployHQ PATCH /users/{id}.
deployhq_post_agentsWRITEClaims an unclaimed network agent using its claim code and registers it to the current account. DeployHQ POST /agents.
deployhq_post_agents_by_id_revokeWRITERevokes the agent's claim, releasing it from the account so it can be reclaimed. DeployHQ POST /agents/{id}/revoke.
deployhq_post_beta_enrollmentsWRITEEnroll the current account in the managed-resources beta. DeployHQ POST /beta/enrollments.
deployhq_post_detectionWRITEDetects the project's framework/stack from an uploaded filename listing plus the contents of key manifest files. DeployHQ POST /detection.
deployhq_post_foldersWRITECreates a new folder in the account. DeployHQ POST /folders.
deployhq_post_global_build_commandsWRITECreate new global build command. DeployHQ POST /global_build_commands.
deployhq_post_global_config_filesWRITECreate new global config file. DeployHQ POST /global_config_files.
deployhq_post_global_environment_variablesWRITECreates a new account-level environment variable. Locked variables cannot be read back after creation. DeployHQ POST /global_environment_variables.
deployhq_post_global_serversWRITECreate a global server. DeployHQ POST /global_servers.
deployhq_post_global_servers_by_id_copy_to_projectWRITECopy a global server to a project. DeployHQ POST /global_servers/{id}/copy_to_project.
deployhq_post_global_ssh_commandsWRITECreate new global ssh command. DeployHQ POST /global_ssh_commands.
deployhq_post_hosted_resources_by_id_retry_provisionWRITERetries 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.
deployhq_post_hosted_resources_by_id_syncWRITESync a hosted resource. DeployHQ POST /hosted_resources/{id}/sync.
deployhq_post_projectsWRITECreates a new project in the account. Optionally applies a template to pre-populate servers, config files, and other settings. DeployHQ POST /projects.
deployhq_post_projects_by_id_ai_deployment_overviewWRITEGenerates 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.
deployhq_post_projects_by_id_starWRITEToggles the starred status of a project for the current user. Starred projects appear prioritized in listings. DeployHQ POST /projects/{id}/star.
deployhq_post_projects_by_project_id_auto_deploymentsWRITEEnables 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.
deployhq_post_projects_by_project_id_build_cache_filesWRITECreates 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.
deployhq_post_projects_by_project_id_build_commandsWRITEAdds 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.
deployhq_post_projects_by_project_id_build_commands_link_globalWRITELinks 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.
deployhq_post_projects_by_project_id_build_configurationsWRITECreates 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.
deployhq_post_projects_by_project_id_build_known_hostsWRITEAdds 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.
deployhq_post_projects_by_project_id_commandsWRITECreates 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.
deployhq_post_projects_by_project_id_commands_link_globalWRITELinks an account-level global SSH command to this project so it runs during deployments. DeployHQ POST /projects/{project_id}/commands/link_global.
deployhq_post_projects_by_project_id_config_filesWRITECreates 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.
deployhq_post_projects_by_project_id_deployment_checksWRITECreates 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.
deployhq_post_projects_by_project_id_deploymentsWRITECreates 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.
deployhq_post_projects_by_project_id_deployments_by_id_abortWRITEImmediately aborts a deployment that is currently in progress. DeployHQ POST /projects/{project_id}/deployments/{id}/abort.
deployhq_post_projects_by_project_id_deployments_by_id_retryWRITERetries 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.
deployhq_post_projects_by_project_id_deployments_by_id_rollbackWRITECreates 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.
deployhq_post_projects_by_project_id_environment_variablesWRITECreates 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.
deployhq_post_projects_by_project_id_excluded_filesWRITEAdds a file path to the project's exclusion list so it is skipped during deployments. DeployHQ POST /projects/{project_id}/excluded_files.
deployhq_post_projects_by_project_id_integrationsWRITECreates a new integration for the project. Only certain hook types are allowed via the API. DeployHQ POST /projects/{project_id}/integrations.
deployhq_post_projects_by_project_id_repositoryWRITEReplaces 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.
deployhq_post_projects_by_project_id_scheduled_deploymentsWRITECreates a new scheduled deployment for the project. DeployHQ POST /projects/{project_id}/scheduled_deployments.
deployhq_post_projects_by_project_id_server_groupsWRITECreates a new server group for the project to organize servers and control deployment order. DeployHQ POST /projects/{project_id}/server_groups.
deployhq_post_projects_by_project_id_serversWRITECreates 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.
deployhq_post_projects_by_project_id_servers_by_id_reset_host_keyWRITEClears 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.
deployhq_post_projects_by_project_id_servers_by_server_id_test_accessWRITETriggers 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.
deployhq_post_projects_by_project_id_ssh_commandsWRITECreates 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.
deployhq_post_projects_by_project_id_test_accessWRITETriggers 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.
deployhq_post_resetWRITEInitiates a password reset for the given email address. No authentication required. DeployHQ POST /reset.
deployhq_post_security_api_keysWRITECreates a new API key for the authenticated user. The full key value is only returned once in this response. DeployHQ POST /security/api_keys.
deployhq_post_ssh_keysWRITECreate an SSH key. DeployHQ POST /ssh_keys.
deployhq_post_teamsWRITECreates a new team. DeployHQ POST /teams.
deployhq_post_templatesWRITECreates a new template, optionally copying configuration from an existing project. DeployHQ POST /templates.
deployhq_post_usersWRITEInvites a new user to the account. Sends an invitation email. DeployHQ POST /users.
deployhq_post_users_by_id_resend_invitationWRITEResends the invitation email for a user who has not yet activated their account. DeployHQ POST /users/{id}/resend_invitation.
deployhq_put_accountWRITEUpdates account settings. Only account administrators can perform this action. DeployHQ PUT /account.
deployhq_put_agents_by_idWRITEUpdates the name of an existing network agent. DeployHQ PUT /agents/{id}.
deployhq_put_folders_by_idWRITERenames a folder. DeployHQ PUT /folders/{id}.
deployhq_put_global_build_commands_by_idWRITEUpdate global build command. DeployHQ PUT /global_build_commands/{id}.
deployhq_put_global_config_files_by_idWRITEUpdate global config file. DeployHQ PUT /global_config_files/{id}.
deployhq_put_global_environment_variables_by_idWRITEUpdates an existing global environment variable's name, value, or locked status. DeployHQ PUT /global_environment_variables/{id}.
deployhq_put_global_servers_by_idWRITEUpdate a global server. DeployHQ PUT /global_servers/{id}.
deployhq_put_global_ssh_commands_by_idWRITEUpdate global ssh command. DeployHQ PUT /global_ssh_commands/{id}.
deployhq_put_profileWRITEUpdates the authenticated user's profile settings. DeployHQ PUT /profile.
deployhq_put_projects_by_idWRITEUpdates the project's settings such as name, notification preferences, zone, and permalink. DeployHQ PUT /projects/{id}.
deployhq_put_projects_by_project_id_build_cache_files_by_idWRITEUpdates the path of an existing build cache file entry. DeployHQ PUT /projects/{project_id}/build_cache_files/{id}.
deployhq_put_projects_by_project_id_build_commands_by_idWRITEUpdates an existing build command's properties such as the command string, description, or error handling behavior. DeployHQ PUT /projects/{project_id}/build_commands/{id}.
deployhq_put_projects_by_project_id_build_configurations_by_idWRITEUpdates 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}.
deployhq_put_projects_by_project_id_build_configurations_by_override_build_configuration_id_build_languages_by_idWRITESets 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}.
deployhq_put_projects_by_project_id_build_languages_by_idWRITESets 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}.
deployhq_put_projects_by_project_id_commands_by_idWRITEUpdates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided. DeployHQ PUT /projects/{project_id}/commands/{id}.
deployhq_put_projects_by_project_id_config_files_by_idWRITEUpdates an existing configuration file's path, content, server assignments, or other properties. DeployHQ PUT /projects/{project_id}/config_files/{id}.
deployhq_put_projects_by_project_id_deployment_checks_by_idWRITEUpdates 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}.
deployhq_put_projects_by_project_id_environment_variables_by_idWRITEUpdates 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}.
deployhq_put_projects_by_project_id_excluded_files_by_idWRITEUpdates the path of an existing excluded file entry. DeployHQ PUT /projects/{project_id}/excluded_files/{id}.
deployhq_put_projects_by_project_id_integrations_by_idWRITEUpdates an existing integration's settings. The hook_type cannot be changed via the API. DeployHQ PUT /projects/{project_id}/integrations/{id}.
deployhq_put_projects_by_project_id_repositoryWRITEUpdates the repository's branch, root path, or hosting service type without replacing the entire repository configuration. DeployHQ PUT /projects/{project_id}/repository.
deployhq_put_projects_by_project_id_scheduled_deployments_by_idWRITEUpdates an existing scheduled deployment. DeployHQ PUT /projects/{project_id}/scheduled_deployments/{id}.
deployhq_put_projects_by_project_id_server_groups_by_idWRITEUpdates an existing server group's settings such as name, branch, or transfer order. DeployHQ PUT /projects/{project_id}/server_groups/{id}.
deployhq_put_projects_by_project_id_servers_by_idWRITEUpdates 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}.
deployhq_put_projects_by_project_id_ssh_commands_by_idWRITEUpdates 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}.
deployhq_put_teams_by_idWRITEUpdates an existing team. DeployHQ PUT /teams/{id}.
deployhq_put_templates_by_idWRITEUpdates an existing template's name or description. DeployHQ PUT /templates/{id}.
deployhq_put_users_by_idWRITEUpdates an existing user's details and permissions. Only account administrators can change permission flags. DeployHQ PUT /users/{id}.
Put DeployHQ behind one governed endpoint.
Same permissions, same audit trail, whatever else you connect next.