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 available base images
  • Getting the available compute resource options (resource groups)
  • Starting a new database
  • Cloning a database from a snapshot of an existing database

Was this helpful?

Export as PDF
  1. Using the Ephemeral API

Starting a database

Getting the list of available base images

Every Tonic Ephemeral database requires an associated base image, used to run and load the data. Ephemeral provides empty base images for PostgreSQL and MySQL.

When you start a new database, you must provide the identifier of the base image. To get the list of available base images, use:

GET /api/database/images

The response includes the image identifier and the associated database type.

Getting the available compute resource options (resource groups)

When you start a new database, including when you copy an existing database, you specify the required compute resources. The compute resource includes the number of vCPUs and the amount of RAM.

To specify the compute resources, you provide the identifier of the resource group. To get the list of available resource groups, use:

GET /api/database/resource-groups

For each available resource group, the response includes the identifier, name, number of vCPUs, and the amount of RAM.

Starting a new database

To start a completely new database, use:

POST /api/database

The request includes:

  • Database name and description

  • The base image, volume, or user snapshot

  • Expiration configuration

  • Storage size

  • Resource group identifier

The response contains the database identifier.

Cloning a database from a snapshot of an existing database

You can also start a database by cloning an existing database. Specifically, you clone the new database from a snapshot of the original database.

To clone a database, use:

POST /api/database/clone/{volumeSnapshotId}

The request includes:

  • The required disk storage allocation for the new database

  • The resource group identifier

  • The expiration configuration for the new database

The response provides detailed information about the new database.

PreviousGetting information about Ephemeral databasesNextManaging databases

Last updated 1 year ago

Was this helpful?