POST /api/v3/snapshots/actions/takesnapshot

Take Snapshot of the given Environment.

Create a new Snapshot either into the current Environment’s Blueprint, or into another existing Blueprint, or into a new Blueprint.

Request Path

PUT /api/v3/snapshots/actions/takesnapshot

Request Payload

{
    "envId": "EN123ABC",
    "name": "My Snapshot",
    "description": "This Snapshot's description", 
    "newBlueprintName": null, 
    "otherBlueprintId": null, 
    "setAsDefault": null 
}

Parameters

envId The Environment to take Snapshot of
name The name of the new Snapshot, should not exceed 32 characters
description The description of the new Snapshot. Optional
newBlueprintName If taking a Snapshot to a new Blueprint, the name of the Blueprint to create. Optional
otherBlueprintId If taking a Snapshot to an existing Blueprint, the ID of the Blueprint to take a Snapshot in. Optional
setAsDefault Set the new Snapshot as default in the containing Blueprint. Optional, defaults to true.

Notes:

  1. If newBlueprintName and otherBlueprintId are null, then a new Snapshot is created on the current Environment’s Blueprint.
  2. If newBlueprintName is not null, then a new Snapshot is created on a new Blueprint with the given name.
  3. If otherBlueprintId is not null, then a new Snapshot is created on the specified Blueprint.
  4. It is an error if both newBlueprintName and otherBlueprintId are not null.
  5. It is an error if either newBlueprintName or otherBlueprintId are not null, and there isn’t at least one Snapshot on the current Environment’s Blueprint.

Response example

None.