# Collate Domains API

**Canonical:** https://apis.io/apis/collate/collate-domains-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Domains API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Domains. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

A `Data Product` or `Data as a Product` is a logical unit that contains all components to process and store domain data for analytical or data-intensive use cases made available to data consumers.

## Operations (60 of 72)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/dataProducts/{id}/followers` | Add a follower |
| PUT | `/v1/dataProducts/{name}/assets/add` | Bulk Add Assets |
| PUT | `/v1/dataProducts/{name}/inputPorts/add` | Bulk Add Input Ports |
| PUT | `/v1/dataProducts/name/{fqn}/inputPorts/add` | Bulk Add Input Ports by Name |
| PUT | `/v1/dataProducts/{name}/outputPorts/add` | Bulk Add Output Ports |
| PUT | `/v1/dataProducts/name/{fqn}/outputPorts/add` | Bulk Add Output Ports by Name |
| PUT | `/v1/dataProducts/{name}/assets/remove` | Bulk Remove Assets |
| PUT | `/v1/dataProducts/{name}/inputPorts/remove` | Bulk Remove Input Ports |
| PUT | `/v1/dataProducts/name/{fqn}/inputPorts/remove` | Bulk Remove Input Ports by Name |
| PUT | `/v1/dataProducts/{name}/outputPorts/remove` | Bulk Remove Output Ports |
| PUT | `/v1/dataProducts/name/{fqn}/outputPorts/remove` | Bulk Remove Output Ports by Name |
| GET | `/v1/dataProducts` | List dataProducts |
| PUT | `/v1/dataProducts` | Create or update a dataProduct |
| POST | `/v1/dataProducts` | Create a dataProduct |
| PUT | `/v1/dataProducts/odps` | Create or smart-merge a data product from ODPS v4.1 JSON |
| POST | `/v1/dataProducts/odps` | Import data product from ODPS v4.1 JSON |
| PUT | `/v1/dataProducts/odps/yaml` | Create or smart-merge a data product from ODPS v4.1 YAML |
| POST | `/v1/dataProducts/odps/yaml` | Import data product from ODPS v4.1 YAML |
| GET | `/v1/dataProducts/name/{name}` | Get a dataProduct by name |
| DELETE | `/v1/dataProducts/name/{name}` | Delete a dataProduct by name |
| GET | `/v1/dataProducts/{id}` | Get a dataProduct by Id |
| DELETE | `/v1/dataProducts/{id}` | Delete a dataProduct by Id |
| PATCH | `/v1/dataProducts/{id}` | Update a dataProduct |
| DELETE | `/v1/dataProducts/async/{id}` | Asynchronously delete a dataProduct by Id |
| DELETE | `/v1/dataProducts/{id}/followers/{userId}` | Remove a follower |
| GET | `/v1/dataProducts/{id}/odps` | Export data product to ODPS v4.1 format |
| GET | `/v1/dataProducts/name/{fqn}/odps` | Export data product to ODPS v4.1 format by FQN |
| GET | `/v1/dataProducts/{id}/odps/yaml` | Export data product to ODPS v4.1 YAML format |
| GET | `/v1/dataProducts/name/{fqn}/odps/yaml` | Export data product to ODPS v4.1 YAML format by FQN |
| GET | `/v1/dataProducts/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/dataProducts/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/dataProducts/assets/counts` | Get all data products with their asset counts |
| GET | `/v1/dataProducts/{id}/assets` | Get assets for a data product |
| GET | `/v1/dataProducts/name/{fqn}/assets` | Get assets for a data product by name |
| GET | `/v1/dataProducts/{id}/dataContract` | Get data contract for a data product |
| GET | `/v1/dataProducts/{id}/inputPorts` | Get input ports for a data product |
| GET | `/v1/dataProducts/name/{fqn}/inputPorts` | Get input ports for a data product by name |
| GET | `/v1/dataProducts/{id}/outputPorts` | Get output ports for a data product |
| GET | `/v1/dataProducts/name/{fqn}/outputPorts` | Get output ports for a data product by name |
| GET | `/v1/dataProducts/{id}/portsView` | Get combined input/output ports view for a data product |
| GET | `/v1/dataProducts/name/{fqn}/portsView` | Get combined input/output ports view for a data product by name |
| GET | `/v1/dataProducts/{id}/versions/{version}` | Get a version of the dataProduct |
| GET | `/v1/dataProducts/history` | List all entity versions within a time range |
| GET | `/v1/dataProducts/{id}/versions` | List dataProduct versions |
| PATCH | `/v1/dataProducts/name/{fqn}` | Update a dataProduct by name |
| PUT | `/v1/dataProducts/{id}/vote` | Update Vote for an Entity |
| POST | `/v1/dataProducts/odps/validate/yaml` | Validate an ODPS v4.1 YAML document without importing |
| PUT | `/v1/domains/{id}/followers` | Add a follower |
| PUT | `/v1/domains/{name}/assets/add` | Bulk Add Assets |
| PUT | `/v1/domains/{name}/assets/remove` | Bulk Remove Assets |
| GET | `/v1/domains` | List domains |
| PUT | `/v1/domains` | Create or update a domain |
| POST | `/v1/domains` | Create a domain |
| GET | `/v1/domains/name/{name}` | Get a domain by name |
| DELETE | `/v1/domains/name/{name}` | Delete a domain by name |
| GET | `/v1/domains/{id}` | Get a domain by Id |
| DELETE | `/v1/domains/{id}` | Delete a domain by Id |
| PATCH | `/v1/domains/{id}` | Update a domain |
| DELETE | `/v1/domains/async/{id}` | Asynchronously delete a domain by Id |
| DELETE | `/v1/domains/{id}/followers/{userId}` | Remove a follower |

…and 12 more operations. They are listed in full on the page.

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-domains-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Domains

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-domains-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.