Automate Everything with
Our Powerful API
Full programmatic access to DeployHQ. Create projects, trigger deployments, and integrate seamlessly with your existing CI/CD pipeline.
Last updated on 22nd February 2026
The DeployHQ API provides full programmatic access to manage projects, servers, deployments, and configuration via REST endpoints. Integrate DeployHQ into your CI/CD pipeline, trigger deployments from scripts, and automate your entire deployment workflow with authenticated API calls.
The Problem with Manual Workflows
When deployments require manual intervention, your team wastes time on repetitive tasks and risks human error.
Manual deployments require context-switching, repetitive clicks, and constant monitoring — time better spent writing code.
The DeployHQ REST API — The Solution
Automate your entire deployment workflow with simple HTTP requests. One API call replaces dozens of manual steps.
How It Works
Simple REST endpoints, JSON responses, and standard HTTP authentication.
Generate API Key
Create an API key in your account settings for secure authentication.
Make API Requests
Use standard HTTP methods (GET, POST, PUT, DELETE) with your API key.
Automate Workflows
Integrate with your CI/CD pipeline to trigger deployments automatically.
Monitor Results
Get JSON responses with deployment status and details in real time.
Why Use the API?
Everything you can do in the UI, you can do programmatically.
CI/CD Integration
Trigger deployments automatically from Jenkins, GitHub Actions, GitLab CI, or any other CI system with a simple API call.
Custom Workflows
Build deployment pipelines that match your exact requirements. Script project creation and configuration for consistent setup.
Monitoring & Dashboards
Build custom dashboards and alerting systems around your deployments. Track status and history programmatically.
Ruby Gem Available
Use our official Ruby gem for even easier integration in Ruby projects. Simple, idiomatic access to every API endpoint.
Integrate with the API in minutes
Generate an API Key
Go to your account settings and create a new API key.
Authenticate with HTTP Basic Auth
Use your account subdomain and API key to authenticate requests.
Start Automating
Create projects, trigger deployments, and monitor status via JSON.
Frequently Asked Questions
What can I do with the DeployHQ API?
The REST API gives you full programmatic access to DeployHQ. You can create and manage projects, trigger deployments, check deployment status, view logs, and integrate DeployHQ into your CI/CD pipeline or custom tooling.
Is the API available on all plans?
Yes. The DeployHQ REST API is available on all plans, including the free trial. There are no additional charges for API access.
How do I authenticate with the API?
You authenticate using your DeployHQ API key, which is available in your account settings. The API uses HTTP basic authentication with your email address and API key over HTTPS.
Ready to automate your deployments?
Start building integrations with the DeployHQ API today.
10-day free trial • No setup fees • Cancel anytime
Explore More Features
Discover all the tools that make DeployHQ the easiest way to deploy your code.
Get started today for just $9/month
That's unlimited deployments and 3 projects.