# Synatic Data Stores API

**Canonical:** https://apis.io/apis/synatic/synatic-datastores-api/  
**Provider:** Synatic — https://apis.io/providers/synatic/  
**Base URL:** https://api.synatic.com  
**Documentation:** https://api.synatic.com/swagger.json

Synatic Data Stores API is one of 37 APIs that [Synatic](https://apis.io/providers/synatic/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include DataStores. The published artifact set on APIs.io includes an OpenAPI specification.

A DataStore.

## Operations (28)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/sync` | Syncs the data store to retrieve indexes, schema and collection info |
| POST | `/v1/organizations(?:/([^/]+?))/datastores/test-connection` | Tests the connection to ensure it is valid |
| GET | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/test-connection` | Tests the mongodb connection to ensure it is valid |
| POST | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections` | Saves data store collections |
| GET | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections` | Searches for data store collections |
| GET | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}` | Gets a data store collection |
| PUT | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}` | Updates a data store collection |
| PATCH | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}` | Patches a DataStore collection given the JSON Patch |
| DELETE | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}` | Updates a data store collection |
| DELETE | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/soft-purge` | Deletes all documents in the collection without dropping the collection |
| GET | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/stats` | Gets the stats of a DataStore collection |
| POST | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values` | Saves data store values |
| DELETE | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values` | Deletes data store values based on the filter |
| GET | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values` | Queries the data store values |
| PUT | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values/raw` | Updates a data store value using a raw filter |
| PUT | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values/{valueId}` | Updates a data store value |
| DELETE | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values/{valueId}` | Deletes a data store value |
| GET | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values/{valueId}` | Gets a data store value |
| GET | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values/count` | Returns the count of the number of documents that match the filter |
| POST | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/collections/{collectionIdentifier}/values/aggregate` | Queries the data store values using a mongodb aggregate |
| POST | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/values/noql` | Queries the data store values using noql |
| POST | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}/values/generate-aggregation-pipeline` | Queries the data store values using noql |
| GET | `/v1/organizations(?:/([^/]+?))/datastores` | Queries the DataStores |
| POST | `/v1/organizations(?:/([^/]+?))/datastores` | Creates a DataStore |
| GET | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}` | Retrieves a DataStore |
| PUT | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}` | Updates a DataStore |
| DELETE | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}` | Deletes a DataStore |
| PATCH | `/v1/organizations(?:/([^/]+?))/datastores/{dataStoreId}` | Patches a DataStore given the JSON Patch |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/synatic/openapi/synatic-datastores-api-openapi.yml

## Other Synatic APIs (12)

- [Synatic Agency Fuse Ams360 Webhooks API](https://apis.io/apis/synatic/synatic-agencyfuseams360webhooks-api/)
- [Synatic Agency Fuse Assist API Keys API](https://apis.io/apis/synatic/synatic-agencyfuseassistapikeys-api/)
- [Synatic API Keys API](https://apis.io/apis/synatic/synatic-api-keys-api/)
- [Synatic Billing API](https://apis.io/apis/synatic/synatic-billing-api/)
- [Synatic Buffers API](https://apis.io/apis/synatic/synatic-buffers-api/)
- [Synatic Change Logs API](https://apis.io/apis/synatic/synatic-changelogs-api/)
- [Synatic Comments API](https://apis.io/apis/synatic/synatic-comments-api/)
- [Synatic Content API](https://apis.io/apis/synatic/synatic-content-api/)
- [Synatic Entity Sync API](https://apis.io/apis/synatic/synatic-entity-sync-api/)
- [Synatic Event Logs API](https://apis.io/apis/synatic/synatic-event-logs-api/)
- [Synatic Files API](https://apis.io/apis/synatic/synatic-files-api/)
- [Synatic File Stash API](https://apis.io/apis/synatic/synatic-filestash-api/)

## Tags

DataStores

---

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