Skip to main content

Deployments & App Management

DollarDeploy API

The DollarDeploy API provides programmatic access to manage your infrastructure, deploy applications, and orchestrate your deployment workflow. This RESTful API enables you to automate everything from server provisioning to application deployment and monitoring.

Getting Started

Authentication

All API requests require authentication using your API key. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

You can generate API keys from your DollarDeploy settings page.

Base URL

https://dollardeploy.com

Interactive API Documentation

Explore the full API reference with interactive examples at
https://dollardeploy.com/apidocs

Resources

Apps

Manage your application deployments with full lifecycle control.

Hosts

Provision and manage your virtual private servers.

Tasks

Track long-running operations like builds, deployments, and provisioning.

Journal & Logs

Access detailed logs and events across your infrastructure.

Provider Integration

Connect and provision servers from cloud providers.

Templates

Find all available templates and launch the app from the template.

Example workflows

Deploying a New Application

// 1. Create an app
POST /api/app/create
{
  "type": "next",
  "name": "my-app",
  "repositoryUrl": "https://github.com/user/repo",
  "hostId": "host-123",
  "hostname": "app.example.com",
  "env": {
    "NODE_ENV": "production"
  }
}

// 2. Build the app
POST /api/app/:id/build => { task: { id: "task1" } }

// 3. Wait for the app to be built
GET /api/task/:id => { status: "complete" }

// 4. Deploy the app
POST /api/app/:id/deploy

// 5. Wait for the app to be deployed
GET /api/task/:id => { status: "complete" }

Provision a New Host

// 1. Create host entry
POST /api/host/create
{
  "name": "production-01"
}

// 2. Configure provisioning
PATCH /api/host/:id/provision
{
  "provider": "hetzner",
  "providerRegion": "fsn1",
  "providerType": "cx21",
  "image": "ubuntu-24.04"
}

// 3. Provision the server
POST /api/host/:id/provision

// 4. Prepare the host for deployments
POST /api/host/:id/prepare

Support

Next Steps

  1. Generate your API key from the DollarDeploy settings page.
  2. Explore the interactive API documentation
  3. Check out our example apps
  4. Join our Discord community for support