Stargate Document API reference

Number of APIs: 20

The Stargate Document API provides CRUD operations on document data managed by Stargate.

  1. v2-namespaces/{namespace-id}/collections-{collection-id}-{document-id} - Replace a document by {document-id} PUT {{baseUrl}}/v2/namespaces/:namespace-id/collections/:collection-id/:document-id

  2. v2-namespaces/{namespace-id}/collections-{collection-id}-{document-id} - Delete a document DELETE {{baseUrl}}/v2/namespaces/:namespace-id/collections/:collection-id/:document-id

  3. v2-namespaces/{namespace-id}/collections-{collection-id} - Search for documents in {collection-id} GET {{baseUrl}}/v2/namespaces/:namespace-id/collections/:collection-id?author.name=Cliff Wicklow&createTime={"$gte":0}&$or=[{"name":"Cliff"},{"documentId":"my-first-post-a6h54"}]&fields=name, email&page-size=10&page-state=&raw=true

  4. v2-namespaces/{namespace-id}/collections-{collection-id} - Write multiple new documents in one request POST {{baseUrl}}/v2/namespaces/:namespace-id/collections/:collection-id/batch?id-path=irure sunt

  5. v2-namespaces/{namespace-id}/collections - Create a collection POST {{baseUrl}}/v2/namespaces/:namespace-id/collections

  6. v2-namespaces/{namespace-id}/collections - List collections in a namespace GET {{baseUrl}}/v2/namespaces/:namespace-id/collections?raw=false

  7. v2-schemas/namespaces-{namespace-id}-collections/{collection-id} - Get a collection GET {{baseUrl}}/v2/schemas/namespaces/:namespace-id/collections/:collection-id?raw=true

  8. v2-schemas/namespaces-{namespace-id}-collections/{collection-id} - Delete a collection DELETE {{baseUrl}}/v2/schemas/namespaces/:namespace-id/collections/:collection-id

  9. v2-schemas/namespaces-{namespace-id} - Get a namespace GET {{baseUrl}}/v2/schemas/namespaces/:namespace-id?raw=true

  10. v2-schemas/namespaces-{namespace-id} - Delete a namespace DELETE {{baseUrl}}/v2/schemas/namespaces/:namespace-id