STstudio-saelix
Fleet

Create fleet snapshot

Changed on

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

post/api/fleet/snapshots

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/fleet/snapshots
  • Auth
    HTTP bearer

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

  • d58cf9d6195bRevision changes
    • info

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

    • info

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

  • 7464894ea582Revision changes
    • warning

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

    • warning

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

    • info

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

    • info

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