Skip to main content
Use Task versioning when an integration changes a Task definition and you need a recovery path. Figranium can save snapshots before updates, list saved history, and roll a Task back to a previous version.

​
Create a snapshot before an update

When creating or overwriting a Task with POST /api/tasks, add version=true to the query string:
If the Task already exists, Figranium snapshots its current version before overwriting it.

​
Apply a partial update

Use PATCH /api/tasks/:id when you only need to change selected top-level fields. This endpoint snapshots the current Task before applying the update.
The id and versions fields are ignored if included in a patch body.

​
List and inspect saved versions

The response contains version IDs, timestamps, names, and execution modes. Use a version ID to retrieve a specific snapshot:

​
Roll back a Task

Restore a previous snapshot with POST /api/tasks/:id/rollback:
Verify the Task after a rollback by fetching it again or listing the Task summary.

​
Clear version history

When old snapshots are no longer needed, clear a Task’s version history with:
Treat this as a destructive maintenance operation. Keep a copy of any snapshot you may need before clearing the history.
  1. Create a dedicated API key for the deployment tool.
  2. Grant tasks:manage and restrict the key to the Tasks it deploys.
  3. Snapshot before an overwrite or use PATCH for smaller changes.
  4. Run or inspect the updated Task before promoting it.
  5. Roll back by version ID if the new behavior is not correct.
See API Scopes and the REST API Reference for permission and endpoint details.