LogoLogo
Release notesAPI docsDocs homeEphemeral CloudTonic.ai
  • Tonic Ephemeral guide
  • About Tonic Ephemeral
  • Getting started with the Ephemeral free trial
  • Managing your Ephemeral account
  • Managing Databases
    • Viewing the list of databases
    • Starting a database
    • Changing the database configuration
    • Database configuration settings
      • Setting the required resources for a database
      • Setting the database expiration
      • Providing a custom configuration file
    • Connecting to a database
    • Resetting a database
    • Deactivating and reactivating databases
    • Managing auto snapshots
    • Tracking database activity
    • Deleting a database
  • Managing user snapshots
    • About user snapshots
    • Viewing the user snapshot list
    • Creating a user snapshot from an Ephemeral database
    • Creating a user snapshot from imported data
    • Editing a user snapshot
    • Creating a database from a user snapshot
    • Deleting a user snapshot
  • Installing and configuring Ephemeral
    • Ephemeral architecture
    • Configuring an allowlist for Ephemeral Cloud database connections
    • Installing a self-hosted instance of Ephemeral
      • System requirements
      • Deploying Ephemeral with Helm
    • Configuring database access on a self-hosted instance
    • Configuring tolerations and node selectors
    • Managing access to Ephemeral
      • Managing Ephemeral users
      • Enabling SSO on a self-hosted instance
        • Google
        • Okta
    • Setting the registry location for data volumes
    • Managing custom images
      • Creating, editing, and deleting custom images
      • Oracle image configuration
    • Configuring automatic deletion of snapshots
  • Monitoring and data collection
    • Monitoring your Ephemeral billed usage
    • Monitoring your disk storage
    • Data that Tonic.ai collects
  • Using the Ephemeral API
    • About the Ephemeral API
    • Configuring Ephemeral
    • Getting information about Ephemeral databases
    • Starting a database
    • Managing databases
    • Managing snapshots
Powered by GitBook
On this page
  • Getting the list of snapshots
  • Creating a user snapshot
  • Updating a user snapshot
  • Deleting snapshots

Was this helpful?

Export as PDF
  1. Using the Ephemeral API

Managing snapshots

Getting the list of snapshots

To get the current list of snapshots for your Tonic Ephemeral databases, use:

GET /api/database/volume-snapshots

The response contains the list of snapshots, with detailed information about each snapshot.

Creating a user snapshot

You can create a user snapshot to preserve a milestone that you might want to use later or be able to return to.

To create a user snapshot of a database, use:

POST /api/database/{databaseId}/volume-snapshots

The request includes the snapshot name and description.

Updating a user snapshot

You can change the name and description of a user snapshot.

To update a user snapshot, use:

PUT /api/database/volume-snapshots/{volumeSnapshotId}

The request includes the updated name and description.

Deleting snapshots

To delete a snapshot, use:

DELETE /api/database/volume-snapshots/{volumeSnapshotId}

PreviousManaging databases

Last updated 1 year ago

Was this helpful?