OpenAPI Specification

The OpenAPI Specification is the complete and always up-to-date reference for the Entropy Data REST API. It documents every endpoint, parameter, schema, and response, and you can try out requests directly in Swagger UI.

Using the specification

The specification at https://api.entropy-data.com/openapi.yaml is a standard OpenAPI 3 document. Beyond browsing it in Swagger UI, you can use it to generate API clients with tools like openapi-generator, import it into API clients such as Postman or Bruno, or provide it to an AI coding agent as context when building an integration.

All endpoints are authenticated with an API key in the x-api-key header, see Authentication. For self-hosted installations, replace the host with your own instance URL.

Endpoint groups

Group	What it covers
Data Products	Manage data products (ODPS), starring, Git import and Git connections.
Data Contracts	Manage data contracts (ODCS), run tests, generate code, Git import and Git connections.
Access	Manage access agreements, approve or reject requests, report provisioning results.
Teams	Manage domains and teams.
Notification Channels	Manage a team's notification channels.
Source Systems	Manage source systems.
Definitions	Manage business definitions.
Assets	Manage assets and their assigned tags.
Integrations	Inspect ingestion integrations, trigger and cancel runs.
Test Results	Publish and query data contract test results.
Example Data	Attach sample datasets to data products.
Events	The HTTP feed of CloudEvents, see Events.
Tags	Manage tags.
Policies	Manage global policies.
Certifications	Manage data product certifications.
Classifications	Manage classification schemes.
Costs	Report costs of data products.
Lineage	Ingest OpenLineage events and query lineage.
Connectors	Register connectors and store connector state.
Organization	Organization settings, members, and features.
Team Roles	Manage custom team roles.
Organization Git Credentials	Manage organization-wide Git credentials.
Team Git Credentials	Manage a team's Git credentials.
Usage	Send and query OpenTelemetry usage traces for data products, see Usage Tracking.
Search Results	Search across the resources of the organization.
API Keys	Manage API keys programmatically.
Schemas	JSON Schemas for ODCS and ODPS payloads, including custom extensions.
SCIM	SCIM 2.0 user and group provisioning, see SCIM.
Semantics	Experimental endpoints for ontologies, concepts, and relationships.

For common workflows with ready-to-run examples, see Usage Examples.