---
title: "Take an on-demand backup now (503 when no verified dump was written)"
method: POST
path: "/projects/{projectId}/wordpress/backups"
tags: ["WordPress"]
---

# Take an on-demand backup now (503 when no verified dump was written)

`POST /projects/{projectId}/wordpress/backups`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/projects/{projectId}/wordpress/backups`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `projectId` string, uuid, required

## Response `201`

Backup finished

- object
  - `id` string, required
  - `kind` 'manual' | 'scheduled', required
  - `status` 'running' | 'success' | 'failed' | 'timeout', required
  - `filename` string, nullable, required
  - `sizeBytes` integer, nullable, required
  - `durationMs` integer, nullable, required
  - `message` string, required
  - `createdAt` string, nullable, required: ISO-8601 timestamp
  - `usable` boolean, required: true only for a dump the backup tool wrote and verified: it can be restored and downloaded. false for failed runs and for every backup made by the old export command (before the backup tool), which contains no database

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `503`: Hosting engine unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)
