About Snapshot REST APIs

Snapshot REST endpoints enable you to manage your snapshots (BAR files) programmatically. For example, you might create a script to:

• Take regular backups (snapshots) of your Oracle Analytics Cloud instance.
• Create an Oracle Analytics Cloud instance using CreateAnalyticsInstance (this is an Oracle Cloud Infrastructure REST API), register a snapshot you've uploaded to cloud storage with your new Oracle Analytics Cloud instance using Create a Snapshot, and then restore the content of the registered snapshot in your Oracle Analytics Cloud instances using Restore a Snapshot.

You must have the BI Service Administrator application role to manage snapshots using the REST API.

Some snapshot operations are asynchronous. For example, when you call restoreSnapshot a work request ID is returned. You can use this ID as a parameter to the WorkRequests endpoint to check the status of your snapshot restore 'job'.

Your snapshots are stored in Oracle Cloud Infrastructure Object Storage. You must complete several prerequisite tasks in Oracle Cloud Infrastructure (OCI) so Oracle Analytics Cloud has access to a bucket for snapshot storage. See Snapshot REST API Prerequisites.