About the Hosting API
View as MarkdownDeploy and operate apps on GoDaddy's hosting platform via a REST API. Preview and publish — no dashboard required. Supports Node.js apps.
Overview
The Hosting API is a REST API for deploying and operating apps on GoDaddy's hosted platform. It covers the full app lifecycle: create an app, attach to a hosting plan, upload source as a zip, publish to production, manage secrets per variant, and read logs. The API is async-first. Most write operations return immediately with a job or deployment record, and you poll a status endpoint until the operation completes.
The Hosting API supports Node.js apps. Other runtimes will be supported in future releases.
Go to Deploy your Node.js app for the initial deploy walkthrough. Go to Hosting concepts for the variant and deployment model.
What you can do
The following table lists each guide and what it covers:
| Guide | Description |
|---|---|
| Deploy your Node.js app | Deploy your app end to end. Create, attach to a hosting plan, upload, publish, and verify in one walkthrough. |
| Manage apps | List, update, and delete apps after the initial deploy. |
| Manage secrets | Add, update, and delete per-variant environment secrets. Values are write-only. |
| Read logs | Fetch application logs by environment, source stream, and time range. |
| Attach to a hosting plan | Attach a Node.js app to a web hosting subscription (required before going live). |
| Attach domain | Attach a custom domain to your app (optional). |
GitHub repository connections
Connecting a GitHub repository through the Hosting API is in development for Node.js apps. You can connect a repository in the web UI and deploy from it, or upload source as a zip.
Two variants per app
Every app has a preview variant for iteration and a publish variant for production. Uploads and secret changes land on preview first; publish promotes the current preview to the production variant.
Go to Hosting concepts for the full model.
Async by default
Long-running operations return immediately with a job or deployment record. Poll the matching status endpoint until the operation reaches a terminal state:
POST /apps→ pollGET /app-operations/{operationId}POST /apps/{appId}/imports→ pollGET /apps/{appId}/imports/{importId}POST /apps/{appId}/deployments→ pollGET /apps/{appId}/deployments/{deploymentId}andGET /apps/{appId}/status
Related
Last updated on
How is this guide?