DeployHQ integration: operations for AI agents
DeployHQ connects to Type.com as an integration. This page lists the 216 operations documented for Claude and Codex in Type.com: 78 read, 79 write, 59 destructive.
About DeployHQ
Deployment made simple. We make it super easy to automate deploying projects from Git, SVN and Mercurial repositories.
Categories: Developer Tools & IT
How to connect DeployHQ to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
216 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
216 operations listed.
Account
- Read
View account details
Returns the current account's settings including plan, status, and project usage.
- Read
Get billing status
Returns billing and subscription status for the account.
- Write
Update account settings
Updates account settings. Only account administrators can perform this action.
- Write
Reset password
Initiates a password reset for the given email address. No authentication required.
- Destructive
Update account settings
Updates account settings. Only account administrators can perform this action.
Invoices
- Read
List invoices
Returns all finalised invoices for the account, each with a per-invoice PDF download URL. paidat is null when the invoice is unpaid. A manually suspended account receives the 402 response instead, whose suspensionreason is null when no reason was recorded against the suspension.
- Read
Download an invoice PDF
Downloads a single invoice as a PDF. A manually suspended account receives the 402 response instead, whose suspensionreason is null when no reason was recorded against the suspension.
Network Agents
- Read
List network agents
Returns all network agents registered to the current account.
- Write
Claim a network agent
Claims an unclaimed network agent using its claim code and registers it to the current account.
- Write
Update a network agent
Updates the name of an existing network agent.
- Destructive
Update a network agent
Updates the name of an existing network agent.
- Destructive
Delete a network agent
Permanently deletes a network agent from the account.
- Destructive
Revoke a network agent
Revokes the agent's claim, releasing it from the account so it can be reclaimed.
Signup
- Write
Create a new DeployHQ account
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 RATELIMITS constant for thresholds.
Beta
- Write
Enroll in managed-resources beta
Enroll the current account in the managed-resources beta.
Detection
- Write
Detect framework from a file manifest
Detects the project's framework/stack from an uploaded filename listing plus the contents of key manifest files.
Folders
- Read
List all folders
Returns all folders in the account, ordered alphabetically by name. Each folder includes a count of projects assigned to it.
- Write
Create a folder
Creates a new folder in the account.
- Write
Update a folder
Renames a folder.
- Destructive
Update a folder
Renames a folder.
- Destructive
Delete a folder
Deletes a folder. Projects assigned to it are not deleted; they become ungrouped.
Global Build Commands
- Read
List global build commands
GET /global_build_commands
- Read
View global build command
GET /global_build_commands/{id}
- Write
Create new global build command
POST /global_build_commands
- Write
Update global build command
PATCH /global_build_commands/{id}
- Destructive
Update global build command
PUT /global_build_commands/{id}
- Destructive
Delete global build command
DELETE /global_build_commands/{id}
Global Config Files
- Read
List global config files
GET /global_config_files
- Read
View global config file
GET /global_config_files/{id}
- Write
Create new global config file
POST /global_config_files
- Write
Update global config file
PATCH /global_config_files/{id}
- Destructive
Update global config file
PUT /global_config_files/{id}
- Destructive
Delete global config file
DELETE /global_config_files/{id}
Global Environment Variables
- Read
List global environment variables
Returns all account-level environment variables available to every project.
- Read
Get a global environment variable
Returns the details of a single global environment variable.
- Write
Create a global environment variable
Creates a new account-level environment variable. Locked variables cannot be read back after creation.
- Write
Update a global environment variable
Updates an existing global environment variable's name, value, or locked status.
- Destructive
Update a global environment variable
Updates an existing global environment variable's name, value, or locked status.
- Destructive
Delete a global environment variable
Permanently removes a global environment variable from the account.
Global Servers
- Read
List global servers
GET /global_servers
- Read
View a global server
Returns the full details of a single global server. For managedvps servers the response includes a managedvps block (status, ipaddress, region, size, sshkey). The block is null when the underlying managed resource does not exist yet (e.g.
- Write
Create a global server
POST /global_servers
- Write
Update a global server
PATCH /global_servers/{id}
- Write
Copy a global server to a project
POST /global_servers/{id}/copy_to_project
- Destructive
Update a global server
PUT /global_servers/{id}
- Destructive
Delete a global server
DELETE /global_servers/{id}
Global Ssh Commands
- Read
List global ssh commands
GET /global_ssh_commands
- Read
View global ssh command
GET /global_ssh_commands/{id}
- Write
Create new global ssh command
POST /global_ssh_commands
- Write
Update global ssh command
PATCH /global_ssh_commands/{id}
- Destructive
Update global ssh command
PUT /global_ssh_commands/{id}
- Destructive
Delete global ssh command
DELETE /global_ssh_commands/{id}
Hosted Resources
- Read
List all hosted resources and hosted websites
Returns both managed VPS resources (hostedresource) and static hosting sites (hostedwebsite) for the authenticated account. The kind field discriminates; type-specific fields are populated accordingly.
- Read
Show a hosted resource or hosted website
Returns a hosted resource (managed VPS) or hosted website (static hosting) based on the identifier. The kind field discriminates the response shape.
- Write
Retry provisioning a hosted resource
Retries provisioning for a hosted resource that is in an error state. Resets the status to provisioning and enqueues a new provision job.
- Write
Sync a hosted resource
POST /hosted_resources/{id}/sync
Ip Ranges
- Read
List DeployHQ deployment IP ranges
Returns the IP ranges DeployHQ deploys from, for allowlisting on server firewalls. No authentication required.
Language Versions
- Read
List available language versions
Returns all available language/runtime versions from the build server.
- Read
Get project language versions
Returns the language versions configured for this project's default build environment.
- Write
Update language version
Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override.
- Write
Update language version
Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override.
- Destructive
Update language version
Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override.
- Destructive
Update language version
Sets the version of a specific language or runtime package for the project's build environment. Optionally targets a specific build configuration override.
Managed Hosting
- Read
List available regions
Returns available managed VPS regions grouped geographically.
- Read
List available sizes
GET /managed_hosting/sizes
Packages
- Read
List DeployHQ plans and prices
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.
Profile
- Read
View your profile
Returns the authenticated user's profile including account details and capability flags.
- Write
Update your profile
Updates the authenticated user's profile settings.
- Destructive
Update your profile
Updates the authenticated user's profile settings.
Projects
- Read
List all projects
Returns all projects accessible to the authenticated user, sorted alphabetically. Each project includes its starred status.
- Read
View a project
Returns the full details of a single project including its repository info, zone, and starred status.
- Read
Get project deployment insights
Returns aggregated deployment statistics and per-server metrics for the specified time period.
- Read
List undeployed commits for a project
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.
- Read
Get deployment status badge
Returns an SVG badge showing the last deployment status for the project or a specific server/group. No authentication required.
- Read
Get deployment status badge
Returns an SVG badge showing the last deployment status for the project or a specific server/group. No authentication required.
- Write
Create a project
Creates a new project in the account. Optionally applies a template to pre-populate servers, config files, and other settings.
- Write
Update a project
Updates the project's settings such as name, notification preferences, zone, and permalink.
- Write
AI Deployment Overview
Generates an AI-powered summary of changes between two revisions based on commit messages. Requires a configured and cloned repository.
- Write
Regenerate project SSH key
Regenerates the project SSH key and returns the new public key. keytype is optional and defaults to the existing project's algorithm; must be one of ED25519 or RSA when provided.
- Write
Toggle star/unstar on a project
Toggles the starred status of a project for the current user. Starred projects appear prioritized in listings.
- Write
Upload custom key
Uploads a custom SSH private key for the project and returns the corresponding public key.
- Destructive
Update a project
Updates the project's settings such as name, notification preferences, zone, and permalink.
- Destructive
Delete a project
Queues the project for deletion. Fails if any deployments are currently running.
Automatic Deployments
- Read
List automatic deployment configuration
Returns the webhook URL and auto-deploy settings for each server and server group in the project.
- Write
Update automatic deployment settings
Enables or disables automatic deployments for individual servers and server groups. Unrecognized identifiers are skipped and reported in the response.
Build Cache Files
- Read
List build cache files
Returns all build cache files configured for the project.
- Write
Create a build cache file
Creates a new build cache file entry for the project. Build cache files persist between builds to speed up subsequent build runs.
- Write
Update a build cache file
Updates the path of an existing build cache file entry.
- Destructive
Update a build cache file
Updates the path of an existing build cache file entry.
- Destructive
Delete a build cache file
Removes a build cache file entry from the project. The cached files will no longer persist between builds.
Build Commands
- Read
List build commands
Returns the project's build pipeline in execution order: the project's own build commands merged with any linked account-level (global) build commands.
- Write
Create a build command
Adds a new build command to the project's build pipeline. Commands execute in order during the build phase.
- Write
Link a global build command
Links an account-level global build command to this project so it runs during the build pipeline.
- Write
Update a build command
Updates an existing build command's properties such as the command string, description, or error handling behavior.
- Destructive
Unlink a global build command
Removes a linked global build command from this project.
- Destructive
Update a build command
Updates an existing build command's properties such as the command string, description, or error handling behavior.
- Destructive
Delete a build command
Removes a build command from the project's build pipeline.
Build Configurations
- Read
Get a build configuration
Returns details of a specific build environment configuration, including known hosts, cache files, and available packages.
- Read
List build configurations
Returns all build environment configurations for the project, including the default and any overrides.
- Read
Get a build configuration
Returns details of a specific build environment configuration, including known hosts, cache files, and available packages.
- Write
Create an empty build configuration override
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.
- Write
Update a build configuration override's target servers
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 serveridentifiers listing the servers the override applies to.
- Destructive
Update a build configuration override's target servers
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 serveridentifiers listing the servers the override applies to.
- Destructive
Delete a build configuration override
Removes a non-default build environment configuration. The default configuration cannot be deleted.
Build Known Hosts
- Read
List build known hosts
Returns all SSH known host entries configured for the project's build environment.
- Write
Create a build known host
Adds an SSH known host entry so the build server can connect to the specified hostname without host key verification prompts.
- Destructive
Delete a build known host
Removes an SSH known host entry from the project's build environment.
Ssh Commands
- Read
List SSH commands
Returns all SSH commands configured for the project, ordered ascending. SSH commands run on target servers before or after deployment.
- Read
Get an SSH command
Returns details of a specific SSH command, including its timing, target servers, and error handling settings.
- Read
List SSH commands
Returns all SSH commands configured for the project, ordered ascending. SSH commands run on target servers before or after deployment.
- Read
Get an SSH command
Returns details of a specific SSH command, including its timing, target servers, and error handling settings.
- Write
Create an SSH command
Creates a new SSH command for the project. Commands can be configured to run before or after deployment on specified servers.
- Write
Link a global SSH command
Links an account-level global SSH command to this project so it runs during deployments.
- Write
Update an SSH command
Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided.
- Write
Create an SSH command
Creates a new SSH command for the project. Commands can be configured to run before or after deployment on specified servers.
- Write
Update an SSH command
Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided.
- Destructive
Unlink a global SSH command
Removes a linked global SSH command from this project.
- Destructive
Update an SSH command
Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided.
- Destructive
Delete an SSH command
Removes an SSH command from the project.
- Destructive
Update an SSH command
Updates an existing SSH command's properties. Server assignments are only modified when server parameters are explicitly provided.
- Destructive
Delete an SSH command
Removes an SSH command from the project.
Config Files
- Read
List config files
Returns all configuration files for the project, ordered ascending. Config files are deployed to servers with their content during each deployment.
- Read
Get a config file
Returns details of a specific configuration file, including its content body and server assignments.
- Write
Create a config file
Creates a new configuration file for the project. The file will be deployed to the specified path on target servers during each deployment.
- Write
Update a config file
Updates an existing configuration file's path, content, server assignments, or other properties.
- Destructive
Update a config file
Updates an existing configuration file's path, content, server assignments, or other properties.
- Destructive
Delete a config file
Removes a configuration file from the project. The file will no longer be deployed to servers.
Deployment Checks
- Read
List deployment checks
Returns every deployment check configured for this project, ordered by position within each stage.
- Read
Show a deployment check
Returns a single deployment check by its identifier.
- Write
Create a deployment check
Creates a new deployment check on the project. A check has a stage (prebuild or postdeploy) and a checktype (ssh, http, or vulnerabilityscan).
- Write
Update a deployment check
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).
- Destructive
Update a deployment check
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).
- Destructive
Delete a deployment check
Removes a deployment check from the project.
Deployments
- Read
List deployments for a project
Returns a paginated list of deployments for the project, excluding previews. Can be filtered by target server/group or limited to currently running deployments.
- Read
List log entries for a deployment step
Returns log entries for a specific deployment step, with optional pagination and download support.
- Read
View a deployment
Returns the full details of a deployment including its steps and log entries. Archived and legacy deployments return simplified responses.
- Write
Queue, preview or schedule a 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.
- Write
Abort a running deployment
Immediately aborts a deployment that is currently in progress.
- Write
Retry a deployment
Retries a failed deployment by resetting it and re-queuing. Only deployments that have completed (successfully or with failure) can be retried.
- Write
Rollback a deployment
Creates a new deployment that reverts the project to the state of the specified deployment. Archived deployments cannot be rolled back.
Environment Variables
- Read
List environment variables
Returns all environment variables for the project, ordered by name. Variables can be scoped to the build pipeline or specific servers.
- Read
Get an environment variable
Returns details of a specific environment variable. Locked variables will have their values masked.
- Write
Create an environment variable
Creates a new environment variable for the project. Variables can be locked to prevent value visibility and scoped to the build pipeline.
- Write
Update an environment variable
Updates an existing environment variable's name, value, or settings. Server assignments are only modified when server parameters are explicitly provided.
- Destructive
Update an environment variable
Updates an existing environment variable's name, value, or settings. Server assignments are only modified when server parameters are explicitly provided.
- Destructive
Delete an environment variable
Permanently removes an environment variable from the project.
Excluded Files
- Read
List excluded files
Returns all files excluded from deployment for this project.
- Read
Get an excluded file
Returns the details of a single excluded file by its identifier.
- Write
Create an excluded file
Adds a file path to the project's exclusion list so it is skipped during deployments.
- Write
Update an excluded file
Updates the path of an existing excluded file entry.
- Destructive
Update an excluded file
Updates the path of an existing excluded file entry.
- Destructive
Delete an excluded file
Removes a file path from the project's exclusion list.
Integrations
- Read
List integrations
Returns all permanent integrations configured for this project.
- Read
Get an integration
Returns the details of a single integration by its identifier.
- Write
Create an integration
Creates a new integration for the project. Only certain hook types are allowed via the API.
- Write
Update an integration
Updates an existing integration's settings. The hooktype cannot be changed via the API.
- Destructive
Update an integration
Updates an existing integration's settings. The hooktype cannot be changed via the API.
- Destructive
Delete an integration
Permanently removes an integration from the project.
Repositories
- Read
View the repository
Returns the repository configuration for the specified project.
- Read
Branches
Returns a map of branch names and their latest commit references for the project's repository.
- Read
Commit Info
Returns detailed information about a specific commit including author, message, tags, and avatar URL. Queues a repository update if the commit is not found.
- Read
Latest Revision
Returns the latest remote commit reference for the specified branch.
- Read
Recent Commits
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
- Write
Create or replace the repository
Replaces the project's repository configuration. Any existing repository is destroyed and a new one is created with the provided settings.
- Write
Update the repository
Updates the repository's branch, root path, or hosting service type without replacing the entire repository configuration.
- Destructive
Update the repository
Updates the repository's branch, root path, or hosting service type without replacing the entire repository configuration.
Scheduled Deployments
- Read
List scheduled deployments
Returns all forthcoming scheduled deployments for the project, ordered ascending by scheduled time.
- Read
Get a scheduled deployment
Returns the details of a single scheduled deployment.
- Write
Create a scheduled deployment
Creates a new scheduled deployment for the project.
- Write
Update a scheduled deployment
Updates an existing scheduled deployment.
- Destructive
Update a scheduled deployment
Updates an existing scheduled deployment.
- Destructive
Cancel a scheduled deployment
Cancels and deletes a scheduled deployment that has not yet run.
Server Groups
- Read
List server groups
Returns all server groups for the project, ordered ascending.
- Read
Get a server group
Returns the details of a single server group.
- Write
Create a server group
Creates a new server group for the project to organize servers and control deployment order.
- Write
Update a server group
Updates an existing server group's settings such as name, branch, or transfer order.
- Destructive
Update a server group
Updates an existing server group's settings such as name, branch, or transfer order.
- Destructive
Delete a server group
Permanently removes a server group from the project.
Servers
- Read
List all servers
Returns all servers belonging to the specified project, including their agent associations.
- Read
View a server
Returns the full details of a single server including its connection configuration. Returns server details including provisioning state for managed protocols. For statichosting servers the response includes a statichosting block (status, url).
- Read
Get server metrics
Returns real-time server metrics (CPU, memory, disk, uptime) collected over SSH. Requires beta features and an SSH-capable server.
- Write
Create a server
Creates a new server in the project. The protocoltype determines which additional connection parameters are required: SSH needs hostname and username, FTP needs hostname, username, and password, S3 needs bucketname, accesskeyid, and secretaccesskey.
- Write
Update a server
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.
- Write
Reset Host Key
Clears the stored SSH host key for the server, allowing it to accept a new key on the next connection.
- Destructive
Update a server
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.
- Destructive
Delete a server
Removes a server from the project. Fails if any deployments are currently running against this server.
Test Access
- Read
Get test access results
Returns the current status and results of a test access run.
- Write
Run test access
Triggers a test access run for the project. Tests repository connectivity and all server connections. If a serverid is provided (via nested route), only that server is tested.
- Write
Run test access
Triggers a test access run for the project. Tests repository connectivity and all server connections. If a serverid is provided (via nested route), only that server is tested.
Security
- Write
Create an API key
Creates a new API key for the authenticated user. The full key value is only returned once in this response.
- Destructive
Revoke an API key
Revokes an API key by its identifier.
Ssh Keys
- Read
List all SSH keys
GET /ssh_keys
- Read
Download private key
GET /ssh_keys/{id}/download_private_key
- Write
Create an SSH key
POST /ssh_keys
- Destructive
Delete an SSH key
DELETE /ssh_keys/{id}
Teams
- Read
List teams
Returns all teams in the account.
- Read
View a team
Returns details for a specific team.
- Write
Create a team
Creates a new team.
- Write
Update a team
Updates an existing team.
- Destructive
Update a team
Updates an existing team.
- Destructive
Delete a team
Deletes a team.
Templates
- Read
List templates
Returns all private templates belonging to the current account.
- Read
List public templates
Returns publicly available templates, optionally filtered by framework type.
- Read
Get a public template
Returns the full details of a single public template by its permalink.
- Write
Create a template
Creates a new template, optionally copying configuration from an existing project.
- Write
Update a template
Updates an existing template's name or description.
- Destructive
Update a template
Updates an existing template's name or description.
- Destructive
Delete a template
Permanently removes a template from the account.
Users
- Read
List users
Returns all users in the account.
- Read
View a user
Returns details for a specific user.
- Write
Invite a user
Invites a new user to the account. Sends an invitation email.
- Write
Update a user
Updates an existing user's details and permissions. Only account administrators can change permission flags.
- Write
Resend invitation
Resends the invitation email for a user who has not yet activated their account.
- Destructive
Update a user
Updates an existing user's details and permissions. Only account administrators can change permission flags.
- Destructive
Remove a user
Removes a user from the account. Cannot remove the account administrator.
Zones
- Read
List available deployment zones
Returns all available deployment zones. Maintenance zones are only visible to admin users.
No operations match.
See How connections work for access and permissions, or browse all integrations.