API

Powerful REST API

Full programmatic access to DeployHQ. Automate project creation, trigger deployments, and integrate seamlessly with your existing CI/CD pipeline.

What is the DeployHQ API?

Build custom integrations and automate your deployment workflows.

The DeployHQ API provides complete programmatic access to all platform features. Whether you want to trigger deployments from your CI/CD pipeline, create projects automatically, or build custom dashboards, our REST API makes it possible.

The API uses standard HTTP methods and returns JSON responses. Authentication is handled via HTTP Basic Auth using your account subdomain and API key, making integration straightforward with any programming language or tool.

API Capabilities

Everything you can do in the UI, you can do via the API.

  • Projects: Create, update, and manage deployment projects programmatically
  • Servers: Configure deployment targets and server groups
  • Deployments: Trigger deployments, check status, and view deployment history
  • Repositories: Connect and manage your Git repositories
  • Build Pipelines: Configure build commands and deployment pipelines
  • Webhooks: Set up automatic deployments via webhook triggers

Getting Started

Simple authentication and intuitive endpoints.

  1. Generate an API key in your account settings

  2. Use HTTP Basic Auth with your subdomain and API key

  3. Make requests to https://[account].deployhq.com/

  4. Receive JSON responses with all the data you need

Why Use the API?

  • CI/CD Integration: Trigger deployments automatically from Jenkins, GitHub Actions, GitLab CI, or any other CI system
  • Custom Workflows: Build deployment pipelines that match your exact requirements
  • Automation: Script project creation and configuration for consistent setup
  • Monitoring: Build custom dashboards and alerting systems around your deployments
  • Ruby Gem: Use our official Ruby gem for even easier integration in Ruby projects

Interactive Documentation

Our API documentation includes an interactive OpenAPI specification that lets you explore endpoints and test requests directly in your browser. The specification covers all available endpoints, request parameters, and response formats.

Explore the API Documentation to get started with the DeployHQ API.