Overview
- Upgrade to v8
- Overview
- FAQ
- Demo WebApp with RESTHeart
- Performances
- Roadmap
- Framework Tutorial
- REST API Tutorial
- GraphQL API Tutorial
- Auth^2 Tutorial
- Example Web Apps built with RESTHeart
- Blog posts
- Video Tutorials
Setup
- Setup
- Setup with Docker
- Configuration
- Default Configuration
- Client Authentication Howto
- User Management
- GraalVM
- Security Hardening
- Configure TLS
- Secure connection to MongoDB
- Proxying requests
- Serving static resources
- Logging
- Monitoring
- Auditing
- Clustering & Load Balancing
- Enterprise License
Framework
- Overview
- Tutorial
- How to deploy Plugins
- Services
- Interceptors
- Providers
- Initializers
- Services and Inteceptors in JavaScript
- Overview
- Authentication Mechanisms
- Authenticators
- Authorizers
- Token Managers
Base Plugins
Security Plugins
Security Plugins
MongoDB Plugins
- Tutorial
- Read Documents
- Write Documents
- Binary Files with GridFS
- Aggregations
- Caching
- Manage Dbs and Collections
- Indexes
- Relationships
- Upload CSV files
- JSON Schema Validation
- Transactions
- Resource URIs
- Representation Format
- Load Sample Data into MongoDB
- ETag
- Shard Keys
- Overview
- Tutorial
- GraphQL App Definition
- Optimization
- A complex GraphQL App
- Overview
- Streams definition
- Variables
- Examples
REST API
GraphQL API
Websocket API
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