Delete (Snapshots)

URL:
https://<root>/notebooks/snapshots/delete
Methods:
POST
Required Capability:
Access allowed with "Create and edit notebooks" privilege
Version Introduced:
11.4

Description

The delete operation allows the owner of a notebook to delete one or more snapshots associated with that notebook item.

Request parameters

ParameterDetails

itemId

(Required)

The item ID of the notebook to list snapshots from.

resourceKeys

(Required)

A comma-separated list of resource keys of snapshots to delete.

Example:

Use dark colors for code blocksCopy
1
resourceKeys=snapshot-resourcekey1,snapshot-resourcekey2,snapshot-resourcekey3

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the delete operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/notebooks/snapshots/delete HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

itemId=2ff206ba534541428409e327d03588d1&resourceKeys=snapshot-0f146a4ba1964327b396b9be5f1042ed.json&f=pjson&token=<token>

JSON Response example

Use dark colors for code blocksCopy
1
2
3
{
  "status": "success"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.