Account
billingStatusAccountBillingStatus
account.billingStatusAccountBillingStatus
Get billing status
Risk: read
scheduled_change full type
scheduled_change full type
getAccount
account.getAccount
View account details
Risk: read
replaceAccount
account.replaceAccount
Update account settings
Risk: write
body full type
body full type
resetPasswordSubmitReset
account.resetPasswordSubmitReset
Reset password
Risk: destructive
body full type
body full type
updateAccount
account.updateAccount
Update account settings
Risk: write
body full type
body full type
Automatic Deployments
createProjectAutoDeployment
automaticDeployments.createProjectAutoDeployment
Update automatic deployment settings
Risk: write
body full type
body full type
deployables full type
deployables full type
listProjectAutoDeployments
automaticDeployments.listProjectAutoDeployments
List automatic deployment configuration
Risk: read
deployables full type
deployables full type
Beta
createBetumEnrollment
beta.createBetumEnrollment
Enroll in managed-resources beta
Risk: write
body full type
body full type
Build Cache Files
createProjectBuildCacheFile
buildCacheFiles.createProjectBuildCacheFile
Create a build cache file
Risk: write
body full type
body full type
deleteProjectBuildCacheFile
buildCacheFiles.deleteProjectBuildCacheFile
Delete a build cache file
Risk: destructive
listProjectBuildCacheFiles
buildCacheFiles.listProjectBuildCacheFiles
List build cache files
Risk: read
object[]
Output full type
Output full type
replaceProjectBuildCacheFile
buildCacheFiles.replaceProjectBuildCacheFile
Update a build cache file
Risk: write
body full type
body full type
updateProjectBuildCacheFile
buildCacheFiles.updateProjectBuildCacheFile
Update a build cache file
Risk: write
body full type
body full type
Build Commands
createProjectBuildCommand
buildCommands.createProjectBuildCommand
Create a build command
Risk: write
body full type
body full type
deleteProjectBuildCommand
buildCommands.deleteProjectBuildCommand
Delete a build command
Risk: destructive
linkGlobalProjectBuildCommandLinkGlobal
buildCommands.linkGlobalProjectBuildCommandLinkGlobal
Link a global build command
Risk: write
listProjectBuildCommands
buildCommands.listProjectBuildCommands
List build commands
Risk: read
object[]
Output full type
Output full type
replaceProjectBuildCommand
buildCommands.replaceProjectBuildCommand
Update a build command
Risk: write
body full type
body full type
unlinkGlobalProjectBuildCommandUnlinkGlobal
buildCommands.unlinkGlobalProjectBuildCommandUnlinkGlobal
Unlink a global build command
Risk: destructive
updateProjectBuildCommand
buildCommands.updateProjectBuildCommand
Update a build command
Risk: write
body full type
body full type
Build Configurations
createProjectBuildConfiguration
buildConfigurations.createProjectBuildConfiguration
Create an empty build configuration override
Risk: write
packages full type
packages full type
deleteProjectBuildConfiguration
buildConfigurations.deleteProjectBuildConfiguration
Delete a build configuration override
Risk: destructive
getProjectBuildConfiguration
buildConfigurations.getProjectBuildConfiguration
Get a build configuration
Risk: read
/projects/{project_id}/build_configuration contains only the {project_id} path token, but its parameter list also declares an id path parameter. The extra parameter is omitted because it is not present in the URL template; confirm with DeployHQ.
Output
packages full type
packages full type
getProjectBuildConfigurationById
buildConfigurations.getProjectBuildConfigurationById
Get a build configuration
Risk: read
packages full type
packages full type
listProjectBuildConfigurations
buildConfigurations.listProjectBuildConfigurations
List build configurations
Risk: read
object[]
Output full type
Output full type
replaceProjectBuildConfiguration
buildConfigurations.replaceProjectBuildConfiguration
Update a build configuration override’s target servers
Risk: write
body full type
body full type
packages full type
packages full type
updateProjectBuildConfiguration
buildConfigurations.updateProjectBuildConfiguration
Update a build configuration override’s target servers
Risk: write
body full type
body full type
packages full type
packages full type
Build Known Hosts
createProjectBuildKnownHost
buildKnownHosts.createProjectBuildKnownHost
Create a build known host
Risk: write
body full type
body full type
deleteProjectBuildKnownHost
buildKnownHosts.deleteProjectBuildKnownHost
Delete a build known host
Risk: destructive
listProjectBuildKnownHosts
buildKnownHosts.listProjectBuildKnownHosts
List build known hosts
Risk: read
object[]
Output full type
Output full type
Config Files
createProjectConfigFile
configFiles.createProjectConfigFile
Create a config file
Risk: write
body full type
body full type
servers full type
servers full type
deleteProjectConfigFile
configFiles.deleteProjectConfigFile
Delete a config file
Risk: destructive
getProjectConfigFileById
configFiles.getProjectConfigFileById
Get a config file
Risk: read
servers full type
servers full type
listProjectConfigFiles
configFiles.listProjectConfigFiles
List config files
Risk: read
object[]
Output full type
Output full type
replaceProjectConfigFile
configFiles.replaceProjectConfigFile
Update a config file
Risk: write
body full type
body full type
servers full type
servers full type
updateProjectConfigFile
configFiles.updateProjectConfigFile
Update a config file
Risk: write
body full type
body full type
servers full type
servers full type
Deployment Checks
createProjectDeploymentCheck
deploymentChecks.createProjectDeploymentCheck
Create a deployment check
Risk: write
body full type
body full type
deleteProjectDeploymentCheck
deploymentChecks.deleteProjectDeploymentCheck
Delete a deployment check
Risk: destructive
getProjectDeploymentCheckById
deploymentChecks.getProjectDeploymentCheckById
Show a deployment check
Risk: read
listProjectDeploymentChecks
deploymentChecks.listProjectDeploymentChecks
List deployment checks
Risk: read
object[]
Output full type
Output full type
replaceProjectDeploymentCheck
deploymentChecks.replaceProjectDeploymentCheck
Update a deployment check
Risk: write
body full type
body full type
updateProjectDeploymentCheck
deploymentChecks.updateProjectDeploymentCheck
Update a deployment check
Risk: write
body full type
body full type
Deployments
abortProjectDeployment
deployments.abortProjectDeployment
Abort a running deployment
Risk: destructive
createProjectDeployment
deployments.createProjectDeployment
Queue, preview or schedule a deployment
Risk: write
body full type
body full type
servers full type
servers full type
project full type
project full type
start_revision full type
start_revision full type
end_revision full type
end_revision full type
timestamps full type
timestamps full type
files full type
files full type
configuration full type
configuration full type
metadata full type
metadata full type
steps full type
steps full type
getProjectDeploymentById
deployments.getProjectDeploymentById
View a deployment
Risk: read
servers full type
servers full type
project full type
project full type
start_revision full type
start_revision full type
end_revision full type
end_revision full type
timestamps full type
timestamps full type
files full type
files full type
configuration full type
configuration full type
metadata full type
metadata full type
steps full type
steps full type
listProjectDeployments
deployments.listProjectDeployments
List deployments for a project
Risk: read
pagination full type
pagination full type
records full type
records full type
listProjectDeploymentStepLogs
deployments.listProjectDeploymentStepLogs
List log entries for a deployment step
Risk: read
object[]
Output full type
Output full type
retryProjectDeploymentRetry
deployments.retryProjectDeploymentRetry
Retry a deployment
Risk: write
servers full type
servers full type
project full type
project full type
start_revision full type
start_revision full type
end_revision full type
end_revision full type
timestamps full type
timestamps full type
files full type
files full type
configuration full type
configuration full type
metadata full type
metadata full type
steps full type
steps full type
rollbackProjectDeployment
deployments.rollbackProjectDeployment
Rollback a deployment
Risk: destructive
servers full type
servers full type
project full type
project full type
start_revision full type
start_revision full type
end_revision full type
end_revision full type
timestamps full type
timestamps full type
files full type
files full type
configuration full type
configuration full type
metadata full type
metadata full type
steps full type
steps full type
Detection
createDetection
detection.createDetection
Detect framework from a file manifest
Risk: write
body full type
body full type
static_hosting full type
static_hosting full type
build_commands full type
build_commands full type
excluded_files full type
excluded_files full type
build_cache_files full type
build_cache_files full type
Environment Variables
createProjectEnvironmentVariable
environmentVariables.createProjectEnvironmentVariable
Create an environment variable
Risk: write
body full type
body full type
deleteProjectEnvironmentVariable
environmentVariables.deleteProjectEnvironmentVariable
Delete an environment variable
Risk: destructive
string
getProjectEnvironmentVariableById
environmentVariables.getProjectEnvironmentVariableById
Get an environment variable
Risk: read
listProjectEnvironmentVariables
environmentVariables.listProjectEnvironmentVariables
List environment variables
Risk: read
object[]
Output full type
Output full type
replaceProjectEnvironmentVariable
environmentVariables.replaceProjectEnvironmentVariable
Update an environment variable
Risk: write
body full type
body full type
updateProjectEnvironmentVariable
environmentVariables.updateProjectEnvironmentVariable
Update an environment variable
Risk: write
body full type
body full type
Excluded Files
createProjectExcludedFile
excludedFiles.createProjectExcludedFile
Create an excluded file
Risk: write
body full type
body full type
servers full type
servers full type
deleteProjectExcludedFile
excludedFiles.deleteProjectExcludedFile
Delete an excluded file
Risk: destructive
getProjectExcludedFileById
excludedFiles.getProjectExcludedFileById
Get an excluded file
Risk: read
servers full type
servers full type
listProjectExcludedFiles
excludedFiles.listProjectExcludedFiles
List excluded files
Risk: read
object[]
Output full type
Output full type
replaceProjectExcludedFile
excludedFiles.replaceProjectExcludedFile
Update an excluded file
Risk: write
body full type
body full type
servers full type
servers full type
updateProjectExcludedFile
excludedFiles.updateProjectExcludedFile
Update an excluded file
Risk: write
body full type
body full type
servers full type
servers full type
Folders
createFolder
folders.createFolder
Create a folder
Risk: write
body full type
body full type
deleteFolder
folders.deleteFolder
Delete a folder
Risk: destructive
listFolders
folders.listFolders
List all folders
Risk: read
object[]
Output full type
Output full type
replaceFolder
folders.replaceFolder
Update a folder
Risk: write
body full type
body full type
updateFolder
folders.updateFolder
Update a folder
Risk: write
body full type
body full type
Global Build Commands
createGlobalBuildCommand
globalBuildCommands.createGlobalBuildCommand
Create new global build command
Risk: write
body full type
body full type
deleteGlobalBuildCommand
globalBuildCommands.deleteGlobalBuildCommand
Delete global build command
Risk: destructive
getGlobalBuildCommand
globalBuildCommands.getGlobalBuildCommand
View global build command
Risk: read
listGlobalBuildCommands
globalBuildCommands.listGlobalBuildCommands
List global build commands
Risk: read
object[]
Output full type
Output full type
replaceGlobalBuildCommand
globalBuildCommands.replaceGlobalBuildCommand
Update global build command
Risk: write
body full type
body full type
updateGlobalBuildCommand
globalBuildCommands.updateGlobalBuildCommand
Update global build command
Risk: write
body full type
body full type
Global Config Files
createGlobalConfigFile
globalConfigFiles.createGlobalConfigFile
Create new global config file
Risk: write
body full type
body full type
servers full type
servers full type
deleteGlobalConfigFile
globalConfigFiles.deleteGlobalConfigFile
Delete global config file
Risk: destructive
getGlobalConfigFile
globalConfigFiles.getGlobalConfigFile
View global config file
Risk: read
servers full type
servers full type
listGlobalConfigFiles
globalConfigFiles.listGlobalConfigFiles
List global config files
Risk: read
object[]
Output full type
Output full type
replaceGlobalConfigFile
globalConfigFiles.replaceGlobalConfigFile
Update global config file
Risk: write
body full type
body full type
servers full type
servers full type
updateGlobalConfigFile
globalConfigFiles.updateGlobalConfigFile
Update global config file
Risk: write
body full type
body full type
servers full type
servers full type
Global Environment Variables
createGlobalEnvironmentVariable
globalEnvironmentVariables.createGlobalEnvironmentVariable
Create a global environment variable
Risk: write
body full type
body full type
deleteGlobalEnvironmentVariable
globalEnvironmentVariables.deleteGlobalEnvironmentVariable
Delete a global environment variable
Risk: destructive
getGlobalEnvironmentVariable
globalEnvironmentVariables.getGlobalEnvironmentVariable
Get a global environment variable
Risk: read
listGlobalEnvironmentVariables
globalEnvironmentVariables.listGlobalEnvironmentVariables
List global environment variables
Risk: read
object[]
Output full type
Output full type
replaceGlobalEnvironmentVariable
globalEnvironmentVariables.replaceGlobalEnvironmentVariable
Update a global environment variable
Risk: write
body full type
body full type
updateGlobalEnvironmentVariable
globalEnvironmentVariables.updateGlobalEnvironmentVariable
Update a global environment variable
Risk: write
body full type
body full type
Global Servers
copyToProjectGlobalServer
globalServers.copyToProjectGlobalServer
Copy a global server to a project
Risk: write
identifier (a UUID) as project_id. The project permalink returns 404 on this route (checked 11-13).
Output
createGlobalServer
globalServers.createGlobalServer
Create a global server
Risk: write
body full type
body full type
deleteGlobalServer
globalServers.deleteGlobalServer
Delete a global server
Risk: destructive
getGlobalServer
globalServers.getGlobalServer
View a global server
Risk: read
managed_vps full type
managed_vps full type
listGlobalServers
globalServers.listGlobalServers
List global servers
Risk: read
object[]
Output full type
Output full type
replaceGlobalServer
globalServers.replaceGlobalServer
Update a global server
Risk: write
body full type
body full type
updateGlobalServer
globalServers.updateGlobalServer
Update a global server
Risk: write
body full type
body full type
Global Ssh Commands
createGlobalSshCommand
globalSshCommands.createGlobalSshCommand
Create new global ssh command
Risk: write
body full type
body full type
servers full type
servers full type
deleteGlobalSshCommand
globalSshCommands.deleteGlobalSshCommand
Delete global ssh command
Risk: destructive
getGlobalSshCommand
globalSshCommands.getGlobalSshCommand
View global ssh command
Risk: read
servers full type
servers full type
listGlobalSshCommands
globalSshCommands.listGlobalSshCommands
List global ssh commands
Risk: read
object[]
Output full type
Output full type
replaceGlobalSshCommand
globalSshCommands.replaceGlobalSshCommand
Update global ssh command
Risk: write
body full type
body full type
servers full type
servers full type
updateGlobalSshCommand
globalSshCommands.updateGlobalSshCommand
Update global ssh command
Risk: write
body full type
body full type
servers full type
servers full type
Hosted Resources
getHostedResource
hostedResources.getHostedResource
Show a hosted resource or hosted website
Risk: read
ssh_key full type
ssh_key full type
listHostedResources
hostedResources.listHostedResources
List all hosted resources and hosted websites
Risk: read
object[]
Output full type
Output full type
retryProvisionHostedResourceRetryProvision
hostedResources.retryProvisionHostedResourceRetryProvision
Retry provisioning a hosted resource
Risk: write
syncHostedResourceSync
hostedResources.syncHostedResourceSync
Sync a hosted resource
Risk: write
Integrations
createProjectIntegration
integrations.createProjectIntegration
Create an integration
Risk: write
body full type
body full type
deleteProjectIntegration
integrations.deleteProjectIntegration
Delete an integration
Risk: destructive
getProjectIntegrationById
integrations.getProjectIntegrationById
Get an integration
Risk: read
listProjectIntegrations
integrations.listProjectIntegrations
List integrations
Risk: read
object[]
Output full type
Output full type
replaceProjectIntegration
integrations.replaceProjectIntegration
Update an integration
Risk: write
body full type
body full type
updateProjectIntegration
integrations.updateProjectIntegration
Update an integration
Risk: write
body full type
body full type
Invoices
getAccountInvoice
invoices.getAccountInvoice
Download an invoice PDF
Risk: read
kind: 'binary' base64 envelope. The kind discriminator is the string literal 'binary'. Binary responses are capped at 10 MiB by this plugin as a local memory-safety limit, not as a DeployHQ limit.
Output: string \| object
Output full type
Output full type
listAccountInvoices
invoices.listAccountInvoices
List invoices
Risk: read
object[]
Output full type
Output full type
Ip Ranges
listIpRanges
ipRanges.listIpRanges
List DeployHQ deployment IP ranges
Risk: read
zones full type
zones full type
network_agent full type
network_agent full type
ports full type
ports full type
Language Versions
listLanguageVersions
languageVersions.listLanguageVersions
List available language versions
Risk: read
listProjectLanguageVersions
languageVersions.listProjectLanguageVersions
Get project language versions
Risk: read
replaceProjectBuildConfigurationBuildLanguage
languageVersions.replaceProjectBuildConfigurationBuildLanguage
Update language version
Risk: write
body full type
body full type
packages full type
packages full type
replaceProjectBuildLanguage
languageVersions.replaceProjectBuildLanguage
Update language version
Risk: write
body full type
body full type
packages full type
packages full type
updateProjectBuildConfigurationBuildLanguage
languageVersions.updateProjectBuildConfigurationBuildLanguage
Update language version
Risk: write
body full type
body full type
packages full type
packages full type
updateProjectBuildLanguage
languageVersions.updateProjectBuildLanguage
Update language version
Risk: write
body full type
body full type
packages full type
packages full type
Managed Hosting
listManagedHostingRegions
managedHosting.listManagedHostingRegions
List available regions
Risk: read
listManagedHostingSizes
managedHosting.listManagedHostingSizes
List available sizes
Risk: read
sizes full type
sizes full type
Network Agents
createAgent
networkAgents.createAgent
Claim a network agent
Risk: write
body full type
body full type
deleteAgent
networkAgents.deleteAgent
Delete a network agent
Risk: destructive
listAgents
networkAgents.listAgents
List network agents
Risk: read
object[]
Output full type
Output full type
replaceAgent
networkAgents.replaceAgent
Update a network agent
Risk: write
body full type
body full type
revokeAgent
networkAgents.revokeAgent
Revoke a network agent
Risk: destructive
updateAgent
networkAgents.updateAgent
Update a network agent
Risk: write
body full type
body full type
Packages
listPackages
packages.listPackages
List DeployHQ plans and prices
Risk: read
object[]
Output full type
Output full type
Profile
getProfile
profile.getProfile
View your profile
Risk: read
account full type
account full type
replaceProfile
profile.replaceProfile
Update your profile
Risk: write
body full type
body full type
updateProfile
profile.updateProfile
Update your profile
Risk: write
body full type
body full type
Projects
aiDeploymentOverviewProject
projects.aiDeploymentOverviewProject
AI Deployment Overview
Risk: write
body full type
body full type
createProject
projects.createProject
Create a project
Risk: write
body full type
body full type
repository full type
repository full type
deleteProject
projects.deleteProject
Delete a project
Risk: destructive
getProject
projects.getProject
View a project
Risk: read
folder full type
folder full type
capabilities full type
capabilities full type
listProjectInsights
projects.listProjectInsights
Get project deployment insights
Risk: read
/projects/{id}/insights contains the path token {id}, while its parameter list includes both project_id and id. This implementation follows the URL template and uses its id field; confirm the intended identifier with DeployHQ.
Output
servers full type
servers full type
summary full type
summary full type
listProjects
projects.listProjects
List all projects
Risk: read
object[]
Output full type
Output full type
regenerateKeyProjectRegenerateKey
projects.regenerateKeyProjectRegenerateKey
Regenerate project SSH key
Risk: destructive
body full type
body full type
replaceProject
projects.replaceProject
Update a project
Risk: write
body full type
body full type
repository full type
repository full type
starProject
projects.starProject
Toggle star/unstar on a project
Risk: write
statusBadgeStatusBadge
projects.statusBadgeStatusBadge
Get deployment status badge
Risk: read
string
statusBadgeStatusBadgeByIdentifier
projects.statusBadgeStatusBadgeByIdentifier
Get deployment status badge
Risk: read
string
undeployedChangesProjectUndeployedChange
projects.undeployedChangesProjectUndeployedChange
List undeployed commits for a project
Risk: read
commits full type
commits full type
updateProject
projects.updateProject
Update a project
Risk: write
body full type
body full type
repository full type
repository full type
uploadKeyProject
projects.uploadKeyProject
Upload custom key
Risk: write
body full type
body full type
Repositories
branchesProjectRepository
repositories.branchesProjectRepository
Branches
Risk: read
Record<string, JsonValue>
commitInfoProjectRepository
repositories.commitInfoProjectRepository
Commit Info
Risk: read
createProjectRepository
repositories.createProjectRepository
Create or replace the repository
Risk: write
body full type
body full type
hosting_service full type
hosting_service full type
getProjectRepository
repositories.getProjectRepository
View the repository
Risk: read
hosting_service full type
hosting_service full type
latestRevisionProjectRepository
repositories.latestRevisionProjectRepository
Latest Revision
Risk: read
recentCommitsProjectRepository
repositories.recentCommitsProjectRepository
Recent Commits
Risk: read
commits full type
commits full type
releases full type
releases full type
replaceProjectRepository
repositories.replaceProjectRepository
Update the repository
Risk: write
body full type
body full type
hosting_service full type
hosting_service full type
updateProjectRepository
repositories.updateProjectRepository
Update the repository
Risk: write
body full type
body full type
hosting_service full type
hosting_service full type
Scheduled Deployments
createProjectScheduledDeployment
scheduledDeployments.createProjectScheduledDeployment
Create a scheduled deployment
Risk: write
body full type
body full type
server full type
server full type
at full type
at full type
deleteProjectScheduledDeployment
scheduledDeployments.deleteProjectScheduledDeployment
Cancel a scheduled deployment
Risk: destructive
getProjectScheduledDeploymentById
scheduledDeployments.getProjectScheduledDeploymentById
Get a scheduled deployment
Risk: read
server full type
server full type
at full type
at full type
listProjectScheduledDeployments
scheduledDeployments.listProjectScheduledDeployments
List scheduled deployments
Risk: read
object[]
Output full type
Output full type
replaceProjectScheduledDeployment
scheduledDeployments.replaceProjectScheduledDeployment
Update a scheduled deployment
Risk: write
body full type
body full type
server full type
server full type
at full type
at full type
updateProjectScheduledDeployment
scheduledDeployments.updateProjectScheduledDeployment
Update a scheduled deployment
Risk: write
body full type
body full type
server full type
server full type
at full type
at full type
Security
createSecurityApiKey
security.createSecurityApiKey
Create an API key
Risk: write
body full type
body full type
deleteSecurityApiKey
security.deleteSecurityApiKey
Revoke an API key
Risk: destructive
/security/api_keys/{id} contains the {id} path token, but its parameter list declares both identifier and id as path parameters. This implementation uses the URL’s id field; confirm the intended identifier with DeployHQ.
Output
Server Groups
createProjectServerGroup
serverGroups.createProjectServerGroup
Create a server group
Risk: write
body full type
body full type
servers full type
servers full type
deleteProjectServerGroup
serverGroups.deleteProjectServerGroup
Delete a server group
Risk: destructive
getProjectServerGroupById
serverGroups.getProjectServerGroupById
Get a server group
Risk: read
servers full type
servers full type
listProjectServerGroups
serverGroups.listProjectServerGroups
List server groups
Risk: read
object[]
Output full type
Output full type
replaceProjectServerGroup
serverGroups.replaceProjectServerGroup
Update a server group
Risk: write
body full type
body full type
servers full type
servers full type
updateProjectServerGroup
serverGroups.updateProjectServerGroup
Update a server group
Risk: write
body full type
body full type
servers full type
servers full type
Servers
createProjectServer
servers.createProjectServer
Create a server
Risk: write
server (for SSH: hostname, username, port, use_ssh_keys or password), as listed in DeployHQ’s create a server guide. DeployHQ checks that the host is reachable and answers 422 when it is not.
body full type
body full type
deleteProjectServer
servers.deleteProjectServer
Delete a server
Risk: destructive
getProjectServerById
servers.getProjectServerById
View a server
Risk: read
static_hosting full type
static_hosting full type
managed_vps full type
managed_vps full type
listProjectServers
servers.listProjectServers
List all servers
Risk: read
object[]
Output full type
Output full type
replaceProjectServer
servers.replaceProjectServer
Update a server
Risk: write
body full type
body full type
resetHostKeyProjectServer
servers.resetHostKeyProjectServer
Reset Host Key
Risk: destructive
serverMetricsProjectServerServerMetric
servers.serverMetricsProjectServerServerMetric
Get server metrics
Risk: read
updateProjectServer
servers.updateProjectServer
Update a server
Risk: write
body full type
body full type
Signup
createSignup
signup.createSignup
Create a new DeployHQ account
Risk: destructive
https://api.deployhq.com/api/v1/signup, not an account subdomain. The signup guide shows https://deployhq.com, which redirects to a 404. The API key works only after the new account’s email address is verified.
body full type
body full type
Ssh Commands
createProjectCommand
sshCommands.createProjectCommand
Create an SSH command
Risk: write
body full type
body full type
servers full type
servers full type
createProjectSshCommand
sshCommands.createProjectSshCommand
Create an SSH command
Risk: write
body full type
body full type
servers full type
servers full type
deleteProjectCommand
sshCommands.deleteProjectCommand
Delete an SSH command
Risk: destructive
deleteProjectSshCommand
sshCommands.deleteProjectSshCommand
Delete an SSH command
Risk: destructive
getProjectCommandById
sshCommands.getProjectCommandById
Get an SSH command
Risk: read
servers full type
servers full type
getProjectSshCommandById
sshCommands.getProjectSshCommandById
Get an SSH command
Risk: read
servers full type
servers full type
linkGlobalProjectCommandLinkGlobal
sshCommands.linkGlobalProjectCommandLinkGlobal
Link a global SSH command
Risk: write
servers full type
servers full type
listProjectCommands
sshCommands.listProjectCommands
List SSH commands
Risk: read
object[]
Output full type
Output full type
listProjectSshCommands
sshCommands.listProjectSshCommands
List SSH commands
Risk: read
object[]
Output full type
Output full type
replaceProjectCommand
sshCommands.replaceProjectCommand
Update an SSH command
Risk: write
body full type
body full type
servers full type
servers full type
replaceProjectSshCommand
sshCommands.replaceProjectSshCommand
Update an SSH command
Risk: write
body full type
body full type
servers full type
servers full type
unlinkGlobalProjectCommandUnlinkGlobal
sshCommands.unlinkGlobalProjectCommandUnlinkGlobal
Unlink a global SSH command
Risk: destructive
updateProjectCommand
sshCommands.updateProjectCommand
Update an SSH command
Risk: write
body full type
body full type
servers full type
servers full type
updateProjectSshCommand
sshCommands.updateProjectSshCommand
Update an SSH command
Risk: write
body full type
body full type
servers full type
servers full type
Ssh Keys
createSshKey
sshKeys.createSshKey
Create an SSH key
Risk: write
body full type
body full type
deleteSshKey
sshKeys.deleteSshKey
Delete an SSH key
Risk: destructive
downloadPrivateKeySshKeyDownloadPrivateKey
sshKeys.downloadPrivateKeySshKeyDownloadPrivateKey
Download private key
Risk: read
string
listSshKeys
sshKeys.listSshKeys
List all SSH keys
Risk: read
object[]
Output full type
Output full type
Teams
createTeam
teams.createTeam
Create a team
Risk: write
body full type
body full type
members full type
members full type
project_assignments full type
project_assignments full type
deleteTeam
teams.deleteTeam
Delete a team
Risk: destructive
getTeam
teams.getTeam
View a team
Risk: read
members full type
members full type
project_assignments full type
project_assignments full type
listTeams
teams.listTeams
List teams
Risk: read
object[]
Output full type
Output full type
replaceTeam
teams.replaceTeam
Update a team
Risk: write
body full type
body full type
members full type
members full type
project_assignments full type
project_assignments full type
updateTeam
teams.updateTeam
Update a team
Risk: write
body full type
body full type
members full type
members full type
project_assignments full type
project_assignments full type
Templates
createTemplate
templates.createTemplate
Create a template
Risk: write
identifier (a UUID) as template.project_id. Without a project_id DeployHQ answers 500 (checked 11-13).
body full type
body full type
deleteTemplate
templates.deleteTemplate
Delete a template
Risk: destructive
listTemplates
templates.listTemplates
List templates
Risk: read
object[]
Output full type
Output full type
publicTemplatesTemplate
templates.publicTemplatesTemplate
List public templates
Risk: read
object[]
Output full type
Output full type
replaceTemplate
templates.replaceTemplate
Update a template
Risk: write
body full type
body full type
showPublicTemplateTemplatePublic
templates.showPublicTemplateTemplatePublic
Get a public template
Risk: read
/templates/{id}/public/{id} repeats the {id} path token but defines a single id parameter. The same value is used for both URL occurrences; confirm with DeployHQ whether distinct identifiers are intended.
Output
build_commands full type
build_commands full type
ssh_commands full type
ssh_commands full type
config_files full type
config_files full type
updateTemplate
templates.updateTemplate
Update a template
Risk: write
body full type
body full type
Test Access
createProjectServerTestAccess
testAccess.createProjectServerTestAccess
Run test access
Risk: write
createProjectTestAccess
testAccess.createProjectTestAccess
Run test access
Risk: write
getProjectTestAccess
testAccess.getProjectTestAccess
Get test access results
Risk: read
results full type
results full type
Users
createUser
users.createUser
Invite a user
Risk: destructive
body full type
body full type
deleteUser
users.deleteUser
Remove a user
Risk: destructive
getUser
users.getUser
View a user
Risk: read
listUsers
users.listUsers
List users
Risk: read
object[]
Output full type
Output full type
replaceUser
users.replaceUser
Update a user
Risk: write
body full type
body full type
resendInvitationUserResendInvitation
users.resendInvitationUserResendInvitation
Resend invitation
Risk: destructive
updateUser
users.updateUser
Update a user
Risk: write
body full type
body full type
Zones
listZones
zones.listZones
List available deployment zones
Risk: read
object[]
Output full type
Output full type