# Hostingsurge Projects API

**Canonical:** https://apis.io/apis/hostingsurge-com/hostingsurge-com-projects-api/  
**Provider:** Hostingsurge — https://apis.io/providers/hostingsurge-com/  
**Base URL:** https://hostingsurge.com/api/v1  
**Documentation:** https://hostingsurge.com/developers

Hostingsurge Projects API is one of 37 APIs that [Hostingsurge](https://apis.io/providers/hostingsurge-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Projects API from Hostingsurge — 14 operation(s) for projects.

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/projects` | List projects |
| POST | `/projects` | Create a project (Git, template, upload, Docker image or WordPress) and… |
| GET | `/projects/site-address` | Whether a site address . |
| GET | `/projects/{projectId}` | Get a project |
| PATCH | `/projects/{projectId}` | Update name, site address (until first live), build settings, branch… |
| DELETE | `/projects/{projectId}` | Delete a project (confirm with its exact name); its previews go with it and one… |
| GET | `/projects/{projectId}/deletion-impact` | What deleting the project does: its previews, attached databases, data on the… |
| POST | `/projects/{projectId}/actions/{action}` | Start, stop or restart |
| POST | `/projects/{projectId}/upload` | Upload a ZIP (max 100 MB) to the project repository and deploy it |
| POST | `/detect` | Detect framework and build settings of a repository |
| POST | `/detect/files` | Detect framework and build settings of an upload from its file list (contents… |
| GET | `/projects/{projectId}/screenshot/info` | Screenshot of the project's live site: state, version and failure reason (the… |
| GET | `/screenshots` | Screenshot state of up to 50 projects at once (project lists); projects the… |
| POST | `/projects/{projectId}/screenshot/refresh` | Capture a new screenshot of the project's live site now (at most once a minute… |
| GET | `/projects/{projectId}/screenshot` | The screenshot image (1280x800, or 640x400 with size=thumb), WebP or JPEG. |
| GET | `/projects/{projectId}/sleep` | Idle sleep: whether the project sleeps when nobody visits it (and after how… |
| PUT | `/projects/{projectId}/sleep` | Keep the project always on (paid plans), let it sleep when idle, or follow the… |
| POST | `/projects/{projectId}/wake` | Start a sleeping project now (a visit to its site does the same); answers at… |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/hostingsurge-com/openapi/hostingsurge-com-projects-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-builder-visual-op-schema.json
- **JSONSchema** — https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-policy-templates-input-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-pending-changes-input-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-confirm-prices-input-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-collection-input-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/hostingsurge-com/json-schema/hostingsurge-com-create-shop-input-body-schema.json

## Other Hostingsurge APIs (12)

- [Hostingsurge Accelerator API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-accelerator-api/)
- [Hostingsurge Agents API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-agents-api/)
- [Hostingsurge Alerts API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-alerts-api/)
- [Hostingsurge Analytics API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-analytics-api/)
- [Hostingsurge Assistant API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-assistant-api/)
- [Hostingsurge Automation API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-automation-api/)
- [Hostingsurge Backups API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-backups-api/)
- [Hostingsurge Billing API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-billing-api/)
- [Hostingsurge Builder API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-builder-api/)
- [Hostingsurge Business API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-business-api/)
- [Hostingsurge Certificates API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-certificates-api/)
- [Hostingsurge Databases API](https://apis.io/apis/hostingsurge-com/hostingsurge-com-databases-api/)

## Tags

Project

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hostingsurge-com/hostingsurge-com-projects-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hostingsurge-com/.