Skip to main content
GET
/
v1
/
databases
/
{id}
GET /v1/databases/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Databases

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
database = Databases.retrieve("550e8400-e29b-41d4-a716-446655440000")
print(f"{database.fullyQualifiedName}: {database.description}")

# Get by ID with fields
database = Databases.retrieve(
    "550e8400-e29b-41d4-a716-446655440000",
    fields=["owners", "tags", "usageSummary"]
)

# Get by fully qualified name
database = Databases.retrieve_by_name("snowflake_prod.analytics")

# Get by name with fields
database = Databases.retrieve_by_name(
    "snowflake_prod.analytics",
    fields=["owners", "tags", "domain"]
)

{
  "id": "1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
  "name": "default",
  "fullyQualifiedName": "mysql_sample.default",
  "tags": [],
  "version": 0.1,
  "updatedAt": 1769982658682,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/databases/1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
  "owners": [],
  "service": {
    "id": "4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
    "type": "databaseService",
    "name": "mysql_sample",
    "fullyQualifiedName": "mysql_sample",
    "displayName": "mysql_sample",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/services/databaseServices/4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3"
  },
  "serviceType": "Mysql",
  "databaseSchemas": [
    {
      "id": "ea2cfeb5-8daa-434d-ae22-1f56c688aa86",
      "type": "databaseSchema",
      "name": "posts_db",
      "fullyQualifiedName": "mysql_sample.default.posts_db",
      "displayName": "posts_db",
      "deleted": false,
      "href": "http://localhost:8585/api/v1/databaseSchemas/ea2cfeb5-8daa-434d-ae22-1f56c688aa86"
    }
  ],
  "default": false,
  "deleted": false,
  "sourceUrl": "https://localhost:3306/posts_db",
  "domains": [],
  "entityStatus": "Unprocessed"
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Retrieve a Database

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

​
Get by ID

​
id
string
required
UUID of the database to retrieve.
​
fields
string
Comma-separated list of fields to include. Valid fields: owners, databaseSchemas, usageSummary, location, tags, certification, extension, domains, sourceHash, followers.
​
include
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.
​
fqn
string
required
Fully qualified name of the database (e.g., mysql_sample.default).
​
fields
string
Comma-separated list of fields to include. Valid fields: owners, databaseSchemas, usageSummary, location, tags, certification, extension, domains, sourceHash, followers.
​
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/databases/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Databases

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Get by ID
database = Databases.retrieve("550e8400-e29b-41d4-a716-446655440000")
print(f"{database.fullyQualifiedName}: {database.description}")

# Get by ID with fields
database = Databases.retrieve(
    "550e8400-e29b-41d4-a716-446655440000",
    fields=["owners", "tags", "usageSummary"]
)

# Get by fully qualified name
database = Databases.retrieve_by_name("snowflake_prod.analytics")

# Get by name with fields
database = Databases.retrieve_by_name(
    "snowflake_prod.analytics",
    fields=["owners", "tags", "domain"]
)

{
  "id": "1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
  "name": "default",
  "fullyQualifiedName": "mysql_sample.default",
  "tags": [],
  "version": 0.1,
  "updatedAt": 1769982658682,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/databases/1d08c2c6-cea7-4adf-9043-0f6a6aaf9721",
  "owners": [],
  "service": {
    "id": "4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3",
    "type": "databaseService",
    "name": "mysql_sample",
    "fullyQualifiedName": "mysql_sample",
    "displayName": "mysql_sample",
    "deleted": false,
    "href": "http://localhost:8585/api/v1/services/databaseServices/4724c3cb-d4b8-4ac0-aa55-e8bb66f01ac3"
  },
  "serviceType": "Mysql",
  "databaseSchemas": [
    {
      "id": "ea2cfeb5-8daa-434d-ae22-1f56c688aa86",
      "type": "databaseSchema",
      "name": "posts_db",
      "fullyQualifiedName": "mysql_sample.default.posts_db",
      "displayName": "posts_db",
      "deleted": false,
      "href": "http://localhost:8585/api/v1/databaseSchemas/ea2cfeb5-8daa-434d-ae22-1f56c688aa86"
    }
  ],
  "default": false,
  "deleted": false,
  "sourceUrl": "https://localhost:3306/posts_db",
  "domains": [],
  "entityStatus": "Unprocessed"
}

​
Returns

Returns a database object with all requested fields populated.

​
Response

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

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to view this database
404NOT_FOUNDDatabase with given ID or FQN does not exist