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 a list of databases
  • Getting information about a specific database

Was this helpful?

Export as PDF
  1. Using the Ephemeral API

Getting information about Ephemeral databases

Getting a list of databases

To retrieve a list of Ephemeral databases, use:

GET /api/database

You can optionally provide query parameters to filter the list based on the database name, database type, and database status.

The response contains the list of databases. For each database, the response includes:

  • Database identifier

  • Database status

  • Database configuration

  • Connection information

  • List of snapshots

Getting information about a specific database

To get detailed information about an Ephemeral database, use:

GET /api/database/{id}

The response provides details about the specified database, including:

  • Database identifier

  • Database status

  • Database configuration

  • Connection information

  • List of snapshots

PreviousConfiguring EphemeralNextStarting a database

Last updated 1 year ago

Was this helpful?