Databases

Get a database by fully qualified name

Get a database by fullyQualifiedName.

get/v1/databases/name/{fqn}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/databases/name/{fqn}
  • Auth: HTTP bearer

Path parameters

fqnstring required

Fully qualified name of the database

Query parameters

fieldsstring
Example:owners,databaseSchemas,usageSummary,location,tags,certification,extension,domains,sourceHash,followers

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

Response

The database

idstring uuid required
namestring required
fullyQualifiedNamestring
displayNamestring
descriptionstring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
hrefstring uri
serviceType'BigQuery' | 'BigTable' | 'Mysql' | 'Redshift' | 'Snowflake' | 'Postgres' | 'Timescale' | 'Mssql' | 'MicrosoftAccess' | 'Oracle' | 'Athena' | 'Hive' | 'Impala' | 'Presto' | 'Trino' | 'Vertica' | 'Glue' | 'MariaDB' | 'Druid' | 'Db2' | 'Clickhouse' | 'Databricks' | 'AzureSQL' | 'DynamoDB' | 'SingleStore' | 'SQLite' | 'DeltaLake' | 'Salesforce' | 'PinotDB' | 'Datalake' | 'DomoDatabase' | 'QueryLog' | 'CustomDatabase' | 'Dbt' | 'SapHana' | 'SapSuccessFactors' | 'MongoDB' | 'Cassandra' | 'Couchbase' | 'Greenplum' | 'Doris' | 'StarRocks' | 'UnityCatalog' | 'SAS' | 'Teradata' | 'SapErp' | 'Synapse' | 'Exasol' | 'Cockroach' | 'SSAS' | 'Epic' | 'ServiceNow' | 'Dremio' | 'MicrosoftFabric' | 'BurstIQ' | 'Informix' | 'Iomete' | 'QuestDB' | 'SapBw4Hana'
defaultboolean
deletedboolean
retentionPeriodstring
extensionobject
sourceUrlstring
sourceHashstring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'

Changes

No recorded changes to this operation across all 1 revision of this API.