REST API

The HostStack REST API

Every button in the dashboard is a single HTTP call. Authenticate with a Bearer token, hit the endpoints below in any language, or use the typed TypeScript SDK when you prefer autocompletion over curl.

Authentication

Authenticate API requests with a Bearer token. Generate keys in Settings > API Keys.

Authorization: Bearer hs_live_your_api_key

Base URL & Errors

All endpoints use JSON. Errors return { "error": "message" } with the appropriate HTTP status code.

https://hoststack.dev/api

Rate Limit

Sensitive endpoints (auth, deploy triggers, credential rotations, deploy hooks) are individually rate-limited. Limited responses return HTTP 429 with X-RateLimit-Limit, X-RateLimit-Remaining, and Retry-After headers.

Endpoints

Auth

Public

POST

/api/auth/registerCreate a new account

POST

/api/auth/loginSign in with email/password

POST

/api/auth/logoutEnd current session

POST

/api/auth/forgot-passwordRequest password reset

POST

/api/auth/reset-passwordReset password with token

Projects

Bearer

GET

/api/projects/:teamIdList all projects

GET

/api/projects/:teamId/:projectIdGet project details

POST

/api/projects/:teamIdCreate a project

PATCH

/api/projects/:teamId/:projectIdUpdate a project

DELETE

/api/projects/:teamId/:projectIdDelete a project

Services

Bearer

GET

/api/services/:teamIdList all services

GET

/api/services/:teamId/:serviceIdGet service details

POST

/api/services/:teamIdCreate a service

PATCH

/api/services/:teamId/:serviceIdUpdate a service

DELETE

/api/services/:teamId/:serviceIdDelete a service

POST

/api/services/:teamId/:serviceId/suspendSuspend a service

POST

/api/services/:teamId/:serviceId/resumeResume a service

Deploys

Bearer

GET

/api/services/:teamId/:serviceId/deploysList deploys

POST

/api/services/:teamId/:serviceId/deploysTrigger a deploy

GET

/api/services/:teamId/:serviceId/deploys/:deployIdGet deploy details

GET

/api/services/:teamId/:serviceId/deploys/:deployId/logsGet build logs

POST

/api/services/:teamId/:serviceId/deploys/:deployId/cancelCancel a deploy

POST

/api/services/:teamId/:serviceId/deploys/:deployId/rollbackRollback to a deploy

POST

/api/services/:teamId/:serviceId/deploys/:deployId/promotePromote to another environment

Databases

Bearer

GET

/api/databases/:teamIdList all databases

GET

/api/databases/:teamId/:databaseIdGet database details

POST

/api/databases/:teamIdCreate a database

PATCH

/api/databases/:teamId/:databaseIdUpdate database settings

DELETE

/api/databases/:teamId/:databaseIdDelete a database

GET

/api/databases/:teamId/:databaseId/credentialsGet connection credentials

POST

/api/databases/:teamId/:databaseId/reset-passwordRotate database password

Domains

Bearer

GET

/api/domains/:teamIdList all domains

POST

/api/domains/:teamIdAdd a domain

PATCH

/api/domains/:teamId/:domainIdUpdate domain settings

DELETE

/api/domains/:teamId/:domainIdRemove a domain

POST

/api/domains/:teamId/:domainId/verifyVerify DNS configuration

Env Vars

Bearer

GET

/api/services/:teamId/:serviceId/envList env vars (secrets masked)

POST

/api/services/:teamId/:serviceId/envCreate an env var

PATCH

/api/services/:teamId/:serviceId/env/:envVarIdUpdate an env var

DELETE

/api/services/:teamId/:serviceId/env/:envVarIdDelete an env var

PUT

/api/services/:teamId/:serviceId/env/bulkBulk replace env vars

Volumes

Bearer

GET

/api/services/:teamId/:serviceId/volumesList volumes attached to a service

POST

/api/services/:teamId/:serviceId/volumesAttach a volume

PATCH

/api/services/:teamId/:serviceId/volumes/:volumeIdResize / remount a volume

DELETE

/api/services/:teamId/:serviceId/volumes/:volumeIdDetach a volume

Environments

Bearer

GET

/api/projects/:teamId/:projectId/environmentsList environments in a project

POST

/api/projects/:teamId/:projectId/environmentsCreate an environment

PATCH

/api/environments/:teamId/:environmentIdUpdate an environment

DELETE

/api/environments/:teamId/:environmentIdDelete an environment

Cron

Bearer

GET

/api/services/:teamId/:serviceId/cron-executionsList recent cron executions

GET

/api/services/:teamId/:serviceId/cron-executions/:executionIdGet a cron execution

POST

/api/services/:teamId/:serviceId/cron-executions/triggerTrigger an ad-hoc cron run

Workflows

Bearer

GET

/api/projects/:teamId/:projectId/workflowsList workflows in a project

POST

/api/projects/:teamId/:projectId/workflowsCreate a workflow (image + command + cron schedule)

GET

/api/teams/:teamId/workflows/:workflowIdGet a workflow

PATCH

/api/teams/:teamId/workflows/:workflowIdUpdate a workflow

DELETE

/api/teams/:teamId/workflows/:workflowIdDelete a workflow

POST

/api/teams/:teamId/workflows/:workflowId/triggerTrigger an ad-hoc workflow run

GET

/api/teams/:teamId/workflows/:workflowId/runsList workflow runs

GET

/api/teams/:teamId/workflows/runs/:runIdGet a workflow run

GET

/api/teams/:teamId/workflows/runs/:runId/logsStream a workflow run’s logs

POST

/api/teams/:teamId/workflows/runs/:runId/cancelCancel an in-flight run

POST

/api/teams/:teamId/workflows/runs/:runId/retryRetry a failed run

Notifications

Bearer

GET

/api/notifications/:teamId/channelsList notification channels (Slack / Discord / email)

POST

/api/notifications/:teamId/channelsCreate a notification channel

PATCH

/api/notifications/:teamId/channels/:channelIdUpdate a channel (event filter, recipients)

DELETE

/api/notifications/:teamId/channels/:channelIdDelete a channel

POST

/api/notifications/:teamId/channels/:channelId/testSend a test event to a channel

Alerts

Bearer

GET

/api/alerts/:teamIdList recent alert-shaped activity (?aggregate=1 to collapse flapping rows)

DNS

Bearer

GET

/api/dns-zones/:teamIdList DNS zones managed on ns1+ns2.hoststack.dev

POST

/api/dns-zones/:teamIdCreate a DNS zone

GET

/api/dns-zones/:teamId/:publicIdGet a DNS zone

DELETE

/api/dns-zones/:teamId/:publicIdDelete a DNS zone

GET

/api/dns-zones/:teamId/:publicId/recordsList records in a zone

POST

/api/dns-zones/:teamId/:publicId/recordsCreate a record

PATCH

/api/dns-zones/:teamId/:publicId/records/:recordPublicIdUpdate a record

DELETE

/api/dns-zones/:teamId/:publicId/records/:recordPublicIdDelete a record

Activity Log

Bearer

GET

/api/activity-log/:teamIdList team audit-trail entries

Billing

Session

GET

/api/billing/:teamId/subscriptionGet current subscription

GET

/api/billing/:teamId/usageGet usage metrics

POST

/api/billing/:teamId/checkoutCreate Stripe checkout session

POST

/api/billing/:teamId/portalCreate Stripe billing portal

Example request

bash

curl -X POST https://hoststack.dev/api/services/:teamId/:serviceId/deploys \
  -H "Authorization: Bearer hs_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"branch": "main"}'

Response (201 Created)

{
  "deploy": {
    "id": 42,
    "publicId": "dpl_abc123",
    "status": "building",
    "trigger": "api",
    "createdAt": "2026-04-07T12:00:00.000Z"
  }
}

Prefer a typed client? Use the TypeScript SDK for full autocompletion and error handling.