DeployHQ

Immediately aborts a deployment that is currently in progress.

Generates an AI-powered summary of changes between two revisions based on commit messages. Requires a configured and cloned repository.

Returns billing and subscription status for the account.

Returns a map of branch names and their latest commit references for the project's repository.

Returns detailed information about a specific commit including author, message, tags, and avatar URL. Queues a repository update if the commit is not found.

Copy a global server to a project

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

Enroll the current account in the managed-resources beta.

Detects the project's framework/stack from an uploaded filename listing plus the contents of key manifest files. Returns the canonical stack, a suggested protocol (static_hosting or managed_vps), the static-hosting preset (output directory and SPA mode), and suggested build commands — the same detection pipeline the web onboarding wizard uses. Files not uploaded degrade detection precision gracefully; they never error. When AI features are enabled for the account and the rule-based result is ambiguous, AI services are consulted and their results merged into the response.

Creates a new folder in the account.

Create new global config file

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

Create a global server

Create new global ssh command

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

Enables or disables automatic deployments for individual servers and server groups. Unrecognized identifiers are skipped and reported in the response.

Creates a new build cache file entry for the project. Build cache files persist between builds to speed up subsequent build runs.

Adds a new build command to the project's build pipeline. Commands execute in order during the build phase.

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.

Adds an SSH known host entry so the build server can connect to the specified hostname without host key verification prompts.

Creates a new SSH command for the project. Commands can be configured to run before or after deployment on specified servers.

Creates a new configuration file for the project. The file will be deployed to the specified path on target servers during each deployment.

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. The deployment status field can be: pending, running, completed, failed, preview_pending, preview_ready, or preview_failed.

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). SSH checks run on selected servers; HTTP checks run from the deployment worker against the configured URL; vulnerability_scan checks run a scanner (Trivy, TruffleHog, or a custom CLI emitting SARIF) on the build server against the checked-out source, and are pre-build only.

Creates a new environment variable for the project. Variables can be locked to prevent value visibility and scoped to the build pipeline.

Adds a file path to the project's exclusion list so it is skipped during deployments.

Creates a new integration for the project. Only certain hook types are allowed via the API.

Replaces the project's repository configuration. Any existing repository is destroyed and a new one is created with the provided settings.

Creates a new scheduled deployment for the project.

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. For managed_vps, pass region, size, and os_image at the top level. For static_hosting, pass hosted_website_attributes at the top level.

Creates a new server group for the project to organize servers and control deployment order.

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.

Creates a new SSH command for the project. Commands can be configured to run before or after deployment on specified servers.

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.

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

Registers a new DeployHQ account. No authentication required. Returns API credentials and SSH public key for immediate use. Rate-limited per IP, per email address, and globally; see the RATE_LIMITS constant for thresholds.

Create an SSH key

Creates a new team.

Creates a new template, optionally copying configuration from an existing project.

Invites a new user to the account. Sends an invitation email.

Permanently deletes a network agent from the account.

Deletes a folder. Projects assigned to it are not deleted; they become ungrouped.

Delete global config file

Permanently removes a global environment variable from the account.

Delete a global server

Delete global ssh command

Queues the project for deletion. Fails if any deployments are currently running.

Removes a build cache file entry from the project. The cached files will no longer persist between builds.

Removes a build command from the project's build pipeline.

Removes a non-default build environment configuration. The default configuration cannot be deleted.

Removes an SSH known host entry from the project's build environment.

Removes an SSH command from the project.

Removes a configuration file from the project. The file will no longer be deployed to servers.

Removes a deployment check from the project.

Permanently removes an environment variable from the project.

Removes a file path from the project's exclusion list.

Permanently removes an integration from the project.

Cancels and deletes a scheduled deployment that has not yet run.

Removes a server from the project. Fails if any deployments are currently running against this server.

Permanently removes a server group from the project.

Removes an SSH command from the project.

Revokes an API key by its identifier.

Delete an SSH key

Deletes a team.

Permanently removes a template from the account.

Removes a user from the account. Cannot remove the account administrator.

Download private key

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

Downloads a single invoice as a PDF.

View global config file

Returns the details of a single global environment variable.

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). Poll this endpoint to track provisioning.

View global ssh command

Returns a hosted resource (managed VPS) or hosted website (static hosting) based on the identifier. The `kind` field discriminates the response shape.

Returns the authenticated user's profile including account details and capability flags. The capability fields (beta_features, static_hosting_eligible, managed_vps_eligible) allow any authenticated account member to detect managed-resource eligibility without requiring admin access (GET /account is admin-only and cannot serve this purpose).

Returns the full details of a single project including its repository info, zone, and starred status.

Returns details of a specific build environment configuration, including known hosts, cache files, and available packages.

Returns details of a specific build environment configuration, including known hosts, cache files, and available packages.

Returns details of a specific SSH command, including its timing, target servers, and error handling settings.

Returns details of a specific configuration file, including its content body and server assignments.

Returns the full details of a deployment including its steps and log entries. Archived and legacy deployments return simplified responses.

Returns a single deployment check by its identifier.

Returns details of a specific environment variable. Locked variables will have their values masked.

Returns the details of a single excluded file by its identifier.

Returns the details of a single integration by its identifier.

Returns the repository configuration for the specified project.

Returns the details of a single scheduled deployment.

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). For managed_vps servers the response includes a `managed_vps` block (status, ip_address, region, size, ssh_key). Either block is `null` when the underlying managed resource does not exist yet (e.g. provisioning failed before it was created). Poll this endpoint to track provisioning.

Returns the details of a single server group.

Returns details of a specific SSH command, including its timing, target servers, and error handling settings.

Returns the current status and results of a test access run.

Returns details for a specific team.

Returns details for a specific user.

Returns the latest remote commit reference for the specified branch.

Links an account-level global SSH command to this project so it runs during deployments.

Returns all finalised invoices for the account, each with a per-invoice PDF download URL. `paid_at` is null when the invoice is unpaid.

Returns all network agents registered to the current account.

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

List global config files

Returns all account-level environment variables available to every project.

List global servers

List global ssh commands

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.

Returns the IP ranges DeployHQ deploys from, for allowlisting on server firewalls. No authentication required.

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

Returns available managed VPS regions grouped geographically.

List available sizes

Lists DeployHQ's current plans with prices, localised to the caller's region (GB, EU, or USD detected from the caller's IP). No authentication required.

Returns the webhook URL and auto-deploy settings for each server and server group in the project.

Returns all build cache files configured for the project.

Returns all build commands configured for this project, ordered ascending. Build commands run during the build pipeline before deployment.

Returns all build environment configurations for the project, including the default and any overrides.

Returns all SSH known host entries configured for the project's build environment.

Returns all SSH commands configured for the project, ordered ascending. SSH commands run on target servers before or after deployment.

Returns all configuration files for the project, ordered ascending. Config files are deployed to servers with their content during each deployment.

Returns every deployment check configured for this project, ordered by position within each stage.

Returns log entries for a specific deployment step, with optional pagination and download support.

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

Returns all environment variables for the project, ordered by name. Variables can be scoped to the build pipeline or specific servers.

Returns all files excluded from deployment for this project.

Returns aggregated deployment statistics and per-server metrics for the specified time period.

Returns all permanent integrations configured for this project.

Returns the language versions configured for this project's default build environment.

Returns all forthcoming scheduled deployments for the project, ordered ascending by scheduled time.

Returns all server groups for the project, ordered ascending.

Returns all servers belonging to the specified project, including their agent associations.

Returns all SSH commands configured for the project, ordered ascending. SSH commands run on target servers before or after deployment.

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

List all SSH keys

Returns all teams in the account.

Returns all private templates belonging to the current account.

Returns all users in the account.

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

Returns publicly available templates, optionally filtered by framework type.

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

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.

Updates account settings. Only account administrators can perform this action.

Updates the name of an existing network agent.

Renames a folder.

Update global config file

Updates an existing global environment variable's name, value, or locked status.

Update a global server

Update global ssh command

Updates the authenticated user's profile settings.

Updates the project's settings such as name, notification preferences, zone, and permalink.

Updates the path of an existing build cache file entry.

Updates an existing build command's properties such as the command string, description, or error handling behavior.

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.

Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override.

Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override.

Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided.

Updates an existing configuration file's path, content, server assignments, or other properties.

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

Updates an existing environment variable's name, value, or settings. Server assignments are only modified when server parameters are explicitly provided.

Updates the path of an existing excluded file entry.

Updates an existing integration's settings. The hook_type cannot be changed via the API.

Updates the repository's branch, root path, or hosting service type without replacing the entire repository configuration.

Updates an existing scheduled deployment.

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.

Updates an existing server group's settings such as name, branch, or transfer order.

Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided.

Updates an existing team.

Updates an existing template's name or description.

Updates an existing user's details and permissions. Only account administrators can change permission flags.

Resends the invitation email for a user who has not yet activated their account.

Clears the stored SSH host key for the server, allowing it to accept a new key on the next connection.

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

Retries a failed deployment by resetting it and re-queuing. Only deployments that have completed (successfully or with failure) can be retried.

Retries provisioning for a hosted resource that is in an error state. Resets the status to provisioning and enqueues a new provision job.

Revokes the agent's claim, releasing it from the account so it can be reclaimed.

Creates a new deployment that reverts the project to the state of the specified deployment. Archived deployments cannot be rolled back.

Returns real-time server metrics (CPU, memory, disk, uptime) collected over SSH. Requires beta features and an SSH-capable server.

Returns the full details of a single public template by its permalink.

Toggles the starred status of a project for the current user. Starred projects appear prioritized in listings.

Returns an SVG badge showing the last deployment status for the project or a specific server/group. No authentication required.

Returns an SVG badge showing the last deployment status for the project or a specific server/group. No authentication required.

Sync a hosted resource

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.

Removes a linked global SSH command from this project.

Updates account settings. Only account administrators can perform this action.

Updates the name of an existing network agent.

Renames a folder.

Update global config file

Updates an existing global environment variable's name, value, or locked status.

Update a global server

Update global ssh command

Updates the authenticated user's profile settings.

Updates the project's settings such as name, notification preferences, zone, and permalink.

Updates the path of an existing build cache file entry.

Updates an existing build command's properties such as the command string, description, or error handling behavior.

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.

Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override.

Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override.

Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided.

Updates an existing configuration file's path, content, server assignments, or other properties.

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

Updates an existing environment variable's name, value, or settings. Server assignments are only modified when server parameters are explicitly provided.

Updates the path of an existing excluded file entry.

Updates an existing integration's settings. The hook_type cannot be changed via the API.

Updates the repository's branch, root path, or hosting service type without replacing the entire repository configuration.

Updates an existing scheduled deployment.

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.

Updates an existing server group's settings such as name, branch, or transfer order.

Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided.

Updates an existing team.

Updates an existing template's name or description.

Updates an existing user's details and permissions. Only account administrators can change permission flags.

Uploads a custom SSH private key for the project and returns the corresponding public key.