RESTHeart

  • Ask Sophia
  • Docs
  • FAQ
  • GET
  • Contacts
RESTHeart 8 is the current stable release. Switch documentation to v8
v8 v7 v6 v5 v4 v3
Edit Page

Get Started

  • Setup
  • Try RESTHeart online
  • Absolute Beginner Tutorial
  • Video Tutorials
  • Quick Reference
  • Resource URIs
  • GraalVM
  • Representation Format
  • Logging
  • Other tutorials
  • Performances
  • Clustering & Load Balancing
  • Enterprise License

Upgrade to v5

Roadmap

Content API

  • Read JSON Documents
  • Write JSON Documents
  • Binary Files with GridFS
  • Aggregations
  • Upload CSV files
  • JSON Schema Validation
  • Change Streams
  • Transactions

Management API

  • Databases and Collections
  • Indexes
  • Relationships

Securing Requests

  • Overview
  • Authentication
  • Authorization
  • User Management
  • Configure TLS
  • Secure connection to MongoDB
  • How Clients Authenticate

Plugins

  • Overview
  • Development Environment Setup
  • Core Plugins
  • Security Plugins
  • How to deploy a Plugin

Other Features

  • Proxying requests
  • Serving static resources
  • ETag
  • CORS Support
  • Shard Keys
  • Cursor Pools
  • Monitoring
  • Auditing

Shard Keys

The shard key determines the distribution of the collection’s documents among a cluster’s shards.

When a shared collection has shard key different than _id or a compound shard key, the shardkey query parameter must be used.

Example: if the shard key is X

GET /db/coll/5ac9f95563445900062144aa?shardkey={"X":1} HTTP/1.1
Made with by SoftInstigate
Privacy Policy Cookie Policy