Databases

List databases

Get a list of databases, optionally filtered by service it belongs to. Use fields parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using limit and before or after query params.

get/v1/databases

Request

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

Query parameters

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

Fields requested in the returned resource

servicestring
Example:snowflakeWestCoast

Filter databases by service name

databaseRegexstring
Example:financeDB.*

Filter databases by regex pattern. By default, the pattern is applied to the database name field (for example, 'financeDB.'). To filter by fullyQualifiedName instead, set 'regexFilterByFqn=true' and use an FQN-style pattern (for example, 'snowflakeWestCoast.financeDB.'). For better performance, use in combination with the 'service' query filter.

limitinteger

Limit the number tables returned. (1 to 1000000, default = 10)

beforestring

Returns list of tables before this cursor

afterstring

Returns list of tables after this cursor

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

Include all, deleted, or non-deleted entities.

regexFilterByFqnboolean

When true, regex filters match against fullyQualifiedName instead of name. Default is false.

regexMode'include' | 'exclude'

Controls how regex filters are applied. 'include' returns matching entities, 'exclude' returns non-matching entities. Default is 'include'.

Response

List of databases

warningsCountinteger

Changes

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