POST /api/v3/snapshots/actions/takesnapshot

Takes a snapshot of an environment

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 ID of the environment of which to take the snapshot
name A name for the new snapshot. Should not exceed 32 characters.
description Optional. A description for the new snapshot.
newBlueprintName Optional. A name to assign to a new blueprint. If specified, the snapshot is created in a new blueprint with the specified name, rather than in the default environment blueprint.

  • Must be null if there is not yet at least one snapshot in the default environment blueprint.
  • If specified, otherBlueprintId must be null.
  • If both newBlueprintName and otherBlueprintId are null, the snapshot is created in the default environment blueprint.
otherBlueprintId Optional. The ID of an existing blueprint. If specified, the snapshot is created in the specified blueprint rather than in the default environment blueprint.

  • Must be null if there is not yet at least one snapshot in the default environment blueprint.
  • If specified, newBlueprintName must be null.
  • If both newBlueprintName and otherBlueprintId are null, the snapshot is created in the default environment blueprint.
setAsDefault Optional. Boolean. Defaults to true. If true, the new snapshot is marked as the default snapshot in the containing blueprint.

Response

None