Doc Store / Collections
The list of collections has been successfully retrieved.
No content
The list of collections has been successfully retrieved.
No content
Target store for the collection. Defaults to "doc" for backward compatibility.
The collection and its documents have been successfully retrieved.
No content
The collection was not found.
No content
Use with extreme caution. Consider backing up important data before deletion. This endpoint requires elevated privileges.The collection has been successfully deleted.
The collection was not found.
No content
Executes advanced queries against documents in a specific collection. Features include:
- Complex filtering with multiple operators (eq, ne, gt, lt, gte, lte, in, nin, regex)
- Nested field queries using dot notation (e.g., 'user.email')
- Sorting by multiple fields with ascending/descending order
- Pagination support with limit and offset
- Field projection to return only specific fields
This is the recommended way to retrieve documents when you need specific filtering or working with large collections.Maximum number of results to return
10Number of results to skip
0Query executed successfully.
Query executed successfully.
**This is the recommended endpoint for all collection queries**, as it correctly handles nested collection paths.
Common use cases:
- Query specific collections with nested names (e.g., 'flxbl-io/sf-core/builds-v2')
- Find all metadata across repositories
- Search for specific configurations across environments
- Aggregate data from multiple sourcesTarget store for the query. Defaults to "doc" for backward compatibility.
Maximum number of results to return
10Number of results to skip
0Collection path pattern to match
repo-id/packages/core_crmInclude sub-collections in search
falseQuery executed successfully.
Query executed successfully.
Use this endpoint when you know the exact document key. For searching or filtering, use the query endpoints instead.Target store for the document. Defaults to "doc" for backward compatibility.
The document has been successfully retrieved.
No content
The collection or document was not found.
No content
The document value can be any valid JSON structure. Collections are created automatically if they don't exist. Returns the document with its new version number.Target store for the document. Defaults to "doc" for backward compatibility.
Required for updates, must not be provided for new documents
The document has been successfully created or updated in the collection.
The collection was not found.
Version conflict or invalid version usage.
No content
Requires owner or application role for security. The collection itself remains even if it becomes empty.Target store for the document. Defaults to "doc" for backward compatibility.
The document has been successfully deleted.
The collection or document was not found.
No content
Returns only the version number, making it efficient for version checks.Target store for the document. Defaults to "doc" for backward compatibility.
The document version has been successfully retrieved.
No content
The collection or document was not found.
No content
For retrieving actual document content, use the query endpoint or get individual documents by key.The list of documents has been successfully retrieved.
No content
The collection was not found.
No content
Last updated