Skip to main content
GET
GET /v1/databases/{id}

Retrieve a Database

Get a single database by its unique ID or fully qualified name.

Get by ID

string
required
UUID of the database to retrieve.
string
Comma-separated list of fields to include. Valid fields: owners, databaseSchemas, usageSummary, location, tags, certification, extension, domains, sourceHash, followers.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/databases/name/{fqn} to retrieve by fully qualified name.
string
required
Fully qualified name of the database, for example mysql_sample.default.
string
Comma-separated list of fields to include. Valid fields: owners, databaseSchemas, usageSummary, location, tags, certification, extension, domains, sourceHash, followers.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/databases/{id}

Returns

Returns a database object with all requested fields populated.

Response

string
Unique identifier for the database (UUID format).
string
Database name.
string
Fully qualified name in format service.database.
string
Human-readable display name.
string
Description of the database in Markdown format.
object
Reference to the parent database service.
string
Type of database service, for example Snowflake, BigQuery, PostgreSQL.
number
Version number for the entity.
array
List of owners. Only included when fields contains owners.
array
Classification tags. Only included when fields contains tags.
array
Domain assignment. Only included when fields contains domains.

Error Handling