Sign in
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.

Changes

Changed in 4 of the 36 revisions of this API.125

  • d58cf9d6195b2See the full diff
    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

    • ○

      removed the ADMIRAL_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • 7464894ea58222See the full diff
    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new PAID_REQUIRED enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 403

      response-property-enum-value-removed

    • ○

      removed the PRO_REQUIRED enum value from the code response property for the response status 500

      response-property-enum-value-removed

  • a202861afa641See the full diff
    • ○

      endpoint added

      endpoint-added

  • 82927cbcc9f71See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation