Skip to main content
GET
Get a database by FQN

Authorizations

Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.

Query Parameters

fqn
string
required

Fully qualified name of the database (e.g., PostgreSQL.dvdrental)

Minimum string length: 1

Response

Successful Response

Database domain model for API responses and requests.

Clean DTO (Data Transfer Object) representing a database without ORM metadata. Used in API layer for requests and responses. Does not expose infrastructure concerns like client_id, timestamps, or soft delete flags.

Note: ID is returned as string (UUID) after creation for referencing in subsequent operations (e.g., creating schemas).

name
string
required

Database name

fqn
string
required

Fully qualified name

id
string | null

Unique database identifier (UUID)

description
string | null

Database description

summary_text
string | null

Summary text for semantic search embedding

owners
string[] | null

List of owner names

tags
Tags · object[] | null

List of tag dicts with tagFQN, name, justification, etc.

version
number | null

Entity version number

schemas
Schema · object[] | null

Nested schemas (populated on request)