- URL:
- https://<root>/notebooks/snapshots/create
- Methods:
POST- Version Introduced:
- 11.4
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The create operation allows you to create a point-in-time, full snapshot of a notebook. Notebook snapshots are full copies of the notebook JSON preserved as a resource associated with the notebook item. By default, a notebook can have up to five snapshots. Once the maximum limit of snapshots is reached, additional snapshots cannot be created until one or more existing snapshots is deleted. Snapshots can only be created by the owner of a notebook item. Snapshots cannot be created for shared notebook items. If you have administrative privileges, you can modify the default limit of snapshots by configuring the max property using the Update operation.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The item ID of the notebook for which a snapshot is created. If no value is provided for the |
(Required) | A unique name for the snapshot. |
| A description of the snapshot. |
| By default, a snapshot will be created from the item currently saved as the |
| A Boolean property. When set to Values: |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the create operation:
POST /<context>/admin/notebooks/snapshots/create HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
itemId=2ff206ba534541428409e327d03588d1&name=Snapshot_1&description=This+is+Snapshot+1¬ebookJSON=&privateAccess=false&f=pjson&token=<token>JSON Response example
{
"snapshotResourceKey": "snapshot-eaafdf1d95c248e6bbf49543b6300975.json",
"status": "success"
}