# Collate Database Services API

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

`Database Service` is a service such as MySQL, BigQuery, Redshift, Postgres, or Snowflake. Alternative terms such as Database Cluster, Database Server instance are also used for database service.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/services/databaseServices/{id}/followers` | Add a follower |
| PUT | `/v1/services/databaseServices/{id}/testConnectionResult` | Add test connection result |
| GET | `/v1/services/databaseServices` | List database services |
| PUT | `/v1/services/databaseServices` | Update database service |
| POST | `/v1/services/databaseServices` | Create database service |
| GET | `/v1/services/databaseServices/name/{name}` | Get database service by name |
| DELETE | `/v1/services/databaseServices/name/{name}` | Delete a database service by name |
| GET | `/v1/services/databaseServices/{id}` | Get a database service |
| DELETE | `/v1/services/databaseServices/{id}` | Delete a database service by Id |
| PATCH | `/v1/services/databaseServices/{id}` | Update a database service |
| DELETE | `/v1/services/databaseServices/async/{id}` | Asynchronously delete a database service by Id |
| DELETE | `/v1/services/databaseServices/{id}/followers/{userId}` | Remove a follower |
| GET | `/v1/services/databaseServices/name/{name}/export` | Export database service in CSV format |
| GET | `/v1/services/databaseServices/name/{name}/exportAsync` | Export database service in CSV format |
| GET | `/v1/services/databaseServices/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/services/databaseServices/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/services/databaseServices/{id}/versions/{version}` | Get a version of the database service |
| PUT | `/v1/services/databaseServices/name/{name}/import` | Import service from CSV to update database service (no creation allowed) |
| PUT | `/v1/services/databaseServices/name/{name}/importAsync` | Import service from CSV to update database service asynchronously (no creation… |
| GET | `/v1/services/databaseServices/history` | List all entity versions within a time range |
| GET | `/v1/services/databaseServices/{id}/versions` | List database service versions |
| PATCH | `/v1/services/databaseServices/name/{fqn}` | Update a database service using name |
| PUT | `/v1/services/databaseServices/restore` | Restore a soft deleted database service |

## Machine-readable artifacts (3)

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

Database Services

---

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