DeployHQ API Documentation

This is the complete API documentation for connecting to the DeployHQ API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet DeployHQ: DeployHQ automates deployments from Git repositories to servers, with API access for managing projects, deployments, servers, repositories, templates, and deployment configuration. Keep reading to get started.

Quickstart

Before you run your first DeployHQ request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one DeployHQ connection — create or choose one in Connections. Note its connectionId.

Every DeployHQ action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/deployHQ/latest/actions/{actionSlug}

You need a MindCloud API Key and a DeployHQ connection. Then call an action such as List Projects:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/deployHQ/latest/actions/list-projects" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your DeployHQ account. See DeployHQ API Authentication for the full flow and how to get your connection credentials.

DeployHQ actions

All 24 published actions for this DeployHQ version. Each page documents the endpoint, arguments, and response controls.

• PUTAbort Deployment
• PUTCreate Or Replace Repository
• POSTCreate Project
• POSTCreate Server
• DELETEDelete Project
• DELETEDelete Server
• GETGet Deployment
• GETGet Latest Revision
• GETGet Project
• GETGet Repository
• GETGet Server
• GETList Deployments
• GETList Integrations
• GETList Projects
• GETList Recent Commits
• GETList Repository Branches
• GETList Servers
• POSTQueue Deployment
• PUTRetry Deployment
• PUTRollback Deployment
• POSTRun Server Test Access
• PUTUpdate Project
• PUTUpdate Repository
• PUTUpdate Server

Related apps

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

GitHubNetlifyMySQLPostgreSQLFirebasePagerDutyGoogle Workspace AdminAdalo