# Collate Metadata Services API

**Canonical:** https://apis.io/apis/collate/collate-metadata-services-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 Metadata Services 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 Metadata Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

APIs related to creating and managing other Metadata Services that OpenMetadata integrates with such as `Apache Atlas`, `Amundsen`, etc.

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/services/metadataServices/{id}/followers` | Add a follower |
| PUT | `/v1/services/metadataServices/{id}/testConnectionResult` | Add test connection result |
| GET | `/v1/services/metadataServices` | List metadata services |
| PUT | `/v1/services/metadataServices` | Update metadata service |
| POST | `/v1/services/metadataServices` | Create metadata service |
| GET | `/v1/services/metadataServices/name/{name}` | Get a metadata service by name |
| DELETE | `/v1/services/metadataServices/name/{name}` | Delete a metadata service by name |
| GET | `/v1/services/metadataServices/{id}` | Get a metadata service by Id |
| DELETE | `/v1/services/metadataServices/{id}` | Delete a metadata service by Id |
| PATCH | `/v1/services/metadataServices/{id}` | Update a metadata service |
| DELETE | `/v1/services/metadataServices/async/{id}` | Asynchronously delete a metadata service by Id |
| DELETE | `/v1/services/metadataServices/{id}/followers/{userId}` | Remove a follower |
| GET | `/v1/services/metadataServices/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/services/metadataServices/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/services/metadataServices/{id}/versions/{version}` | Get a version of the metadata service |
| GET | `/v1/services/metadataServices/history` | List all entity versions within a time range |
| GET | `/v1/services/metadataServices/{id}/versions` | List metadata service versions |
| PATCH | `/v1/services/metadataServices/name/{fqn}` | Update a metadata service using name |
| PUT | `/v1/services/metadataServices/restore` | Restore a soft deleted metadata service |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-metadata-services-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

Metadata Services

---

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