v34

latestOpenAPI 3.1.0AGPL-3.0-onlyraw.githubusercontent.com2026-08-018932140.9 KB
Fleet

Create fleet snapshot

Creates a point-in-time backup of all compose files across all nodes. Requires admin role.

post/api/fleet/snapshots

Request body

descriptionstring

Optional description for the snapshot.

Example request

{
  "description": "Pre-migration backup"
}

Response

Snapshot created.

idinteger required
descriptionstring required
created_bystring required
created_atinteger required

Unix timestamp (seconds).

node_countinteger required
stack_countinteger required
skipped_nodesstring

JSON-stringified array of skipped node names.