REST API # Automate Everything with Our Powerful API Full programmatic access to DeployHQ — 140+ endpoints covering projects, servers, deployments, team and account management, activity feeds, scheduled deploys, and more. Build whatever your CI/CD or internal tooling needs. [Start Free Trial](/signup?cta=Start+Free+Trial)[View API Docs](https://api.deployhq.com/docs) Full REST API access Ruby gem available Free plan available Last updated on 6th April 2026 API Request POST/api/v1/projects/42/deployments Content-Type: application/json Authorization: Basic [api\_key] 200 OK {"status": "running", "id": "deploy-42"} The DeployHQ API exposes full programmatic access to the platform — 140+ REST endpoints covering projects, servers, deployments, team management, account administration, activity feeds, scheduled deploys, language versions, zones, and more. Integrate DeployHQ into your CI/CD pipeline, automate user provisioning, build internal dashboards, or drive the whole workflow from your own code. ## The Problem with Manual Workflows When deployments require manual intervention, your team wastes time on repetitive tasks and risks human error. Manual LoginEvery timeClick DeployWait & watchCheck StatusManuallyNotify TeamBy hand👤⚠ Repetitive & Error-Prone 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. YOUR CI/CDPOST /deployAutomated TriggerAPIDEPLOYHQBuild & DeployFully AutomatedProduction✓ DeployedStaging✓ Deployed{"status": "success","identifier": "deploy-42"} ## How It Works Simple REST endpoints, JSON responses, and standard HTTP authentication. 1 ![Lock icon](/assets/icons/lock-48b3d7ebf5f212e8180911da69709706b0e40554862fbd4f7bd4da2edfabfacb.svg) ### Generate API Key Create an API key in your account settings for secure authentication. 2 ![Link icon](/assets/icons/link-8a603022ae63ac39632fb80b724b15efe10ee196c06ce0af7d627654a5147eaa.svg) ### Make API Requests Use standard HTTP methods (GET, POST, PUT, DELETE) with your API key. 3 ![Zap icon](/assets/icons/zap-17eaa1be55c76d539c8ab6b4c667d86fc6478529af6fc62d282cf996beda3fe0.svg) ### Automate Workflows Integrate with your CI/CD pipeline to trigger deployments automatically. 4 ![Check icon](/assets/icons/check-a44bf1dbe680e7b7d11c6ba4f27febd17fde07a1f0bab9f93608e0e1d9acee9b.svg) ### 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. ![Zap icon](/assets/icons/zap-17eaa1be55c76d539c8ab6b4c667d86fc6478529af6fc62d282cf996beda3fe0.svg) ### CI/CD Integration Trigger deployments automatically from Jenkins, GitHub Actions, GitLab CI, or any other CI system with a simple API call. ![Server icon](/assets/icons/server-3dea9382c13b5eb86283b34dac5391d37d7daab491d2ab3b3f48fb6c03df33de.svg) ### Custom Workflows Build deployment pipelines that match your exact requirements. Script project creation and configuration for consistent setup. ![Chart icon](/assets/icons/bar-chart3-3c03dc6174e68b0c8d6bc26ced1ef8e847ac432ceef315bb118c4ae2739b3e4b.svg) ### Monitoring & Dashboards Build custom dashboards and alerting systems around your deployments. Track status and history programmatically. ![Check icon](/assets/icons/check-a44bf1dbe680e7b7d11c6ba4f27febd17fde07a1f0bab9f93608e0e1d9acee9b.svg) ### Ruby Gem Available Use our official Ruby gem for even easier integration in Ruby projects. Simple, idiomatic access to every API endpoint. Getting Started ## Integrate with the API in minutes ![Check mark](/assets/icons/tick-01ba7f4740d492a18fbdf4424bf7446c87ddfccbc0157214ad536b11512e914d.svg) ### Generate an API Key Go to your account settings and create a new API key. ![Check mark](/assets/icons/tick-01ba7f4740d492a18fbdf4424bf7446c87ddfccbc0157214ad536b11512e914d.svg) ### Authenticate with HTTP Basic Auth Use your account subdomain and API key to authenticate requests. ![Check mark](/assets/icons/tick-01ba7f4740d492a18fbdf4424bf7446c87ddfccbc0157214ad536b11512e914d.svg) ### Start Automating Create projects, trigger deployments, and monitor status via JSON. [Read the API documentation →](https://api.deployhq.com/docs) API REQUEST EXAMPLEPOST /projects/{id}/deploymentsContent-Type: application/jsonAuthorization: Basic [api\_key]200 OK{"identifier": "deploy-42","status": "running","branch": "main"} ## Frequently Asked Questions ### What can I do with the DeployHQ API? The REST API opens 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. ### Which categories of endpoints does the API cover? Beyond projects and deployments, the API now covers team management (invite, role changes, removal), sign-up, account administration, activity feeds, test access, deployment retries, deployment zones, language versions, and scheduled deployments. The full reference lives at api.deployhq.com/docs. ## Ready to automate your deployments? Start building integrations with the DeployHQ API today. [Start Free Trial](/signup?cta=Start+Free+Trial)[View API Docs](https://api.deployhq.com/docs) 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. [ ### Zero Downtime Deployments →](/features/zero-downtime-deployments)[ ### One-Click Rollback →](/features/one-click-rollback)[ ### Turbo Deployments →](/features/turbo-deployments)[ ### Build Pipelines →](/features/build-pipelines)[ ### Build Cache →](/features/build-cache)[ ### Scheduled Deployments →](/features/scheduled-deployments)[ ### Deployment Availability →](/features/deployment-availability)[ ### Docker Builds →](/features/docker-builds)[ ### Deployment Checks →](/features/deployment-checks)[ ### Deployment Targets →](/features/deployment-targets)[ ### Automatic Deployment →](/features/automatic-deployments)[ ### Deployment Templates →](/features/deployment-templates)[ ### Deploy Behind Firewalls →](/features/deploy-behind-firewalls)[ ### SSH Deployment →](/features/ssh-deployment)[ ### Deployment Zones →](/features/deployment-zones)[ ### Team & Permissions →](/features/team-permissions)[ ### Single Sign-On →](/features/sso)[ ### Custom Actions →](/features/custom-actions)[ ### Server Management →](/features/server-management)[ ### CLI & Agents →](/agents)[ ### Powerful Integrations →](/features/integrations) ## Get started today for just $9/month That's unlimited deployments and 3 projects. [Start your free 10 day trial](/signup?cta=Start+your+free+10+day+trial)