APIs

🤖 Darkseal APIs

Darkseal supports REST APIs for getting data in and out of the metadata system.

APIs are built using general best practices of REST API design. We take a schema-first approach by defining Types and Entities in JSON Schema.

APIs Organization

Data Asset APIs

These API endpoints support operations related to data asset entities.

• /api/v1/databases

• /api/v1/tables

• /api/v1/metrics

• /api/v1/dashboards

• /api/v1/reports

• /api/v1/pipelines

• /api/v1/topics

Service APIs

These API endpoints support operations related to services from which metadata is collected:

• /api/v1/services

• /api/v1/services/databaseService

• /api/v1/services/dashboardService

• /api/v1/services/messagingService

Teams & Users APIs

• /api/v1/teams

• /api/v1/users

Search & Suggest APIs

These API endpoints support search and suggest APIs:

• /api/v1/search

• /api/v1/search/query

• /api/v1/search/suggst

Other APIs

• /api/v1/tags

• /api/v1/feeds

• /api/v1/usage

• /api/v1/comments