curl/HTTP
Direct HTTP API access via curl or any HTTP client
36 pages
Access Control Tutorial
Step-by-step tutorial to create a read-only user and grant database access in TerminusDB using curl. Takes less than 10 minutes.
Audit Data Changes
Step-by-step tutorial to audit who changed what and when using TerminusDB's immutable commit log. Query history, diff commits, and trace field-level changes.
Clone a Demo Database
Clone a demo database from the public templates server to your local TerminusDB instance — no account required.
Getting Started
Technical documentation for TerminusDB and the DFRNT TerminusDB cloud.
Git-like version control for JSON data
TerminusDB gives JSON documents Git-like version control — structural diff, patch, branches, and full commit history. Store schemaless JSON with automatic deduplication. Tutorial with curl examples.
Multi-Format Document API with curl
A hands-on tutorial for using the TerminusDB Document API with curl to work with JSON, JSON-LD, RDF/XML, and Turtle formats. Covers a full round-trip cycle for enterprise reference data management.
Recover Data from Version History
Step-by-step tutorial to recover deleted or corrupted data using TerminusDB's immutable commit history. View the log, branch from a known-good commit, and reset.
Rust Client — Getting Started
Connect to TerminusDB from Rust using the community-contributed terminusdb-client crate.
Your First 10 Minutes with TerminusDB
Get started with TerminusDB in 10 minutes. Clone a ready-made dataset, then branch, diff, and merge — the full git-for-data workflow with zero setup.
Access Grant with Capabilities API — Name Mode vs ID Mode
How to grant and revoke permissions using the two calling modes of the TerminusDB capabilities API. Includes worked examples, error diagnosis, and guidance for application developers.
Backup & Restore
How to use the TwinfoxDB Enterprise bundle and unbundle API endpoints for database backup, restore, migration, and disaster recovery.
How to use the HTTP Documents API
Quick introduction to the HTTP Documents API and how to use common ways to interact with it using various clients as a quick reference guide
How to use the terminusdb CLI query interface
Quick introduction to the terminusdb CLI WOQL Query interface which has a distinct syntax to other flavours.
Install on Kubernetes
Install TerminusDB on a Kubernetes cluster
Install TerminusDB from Source Code
Everything you need to install TerminusDB from source code.
Install TerminusDB with Docker
Get TerminusDB running locally in under 2 minutes with Docker Compose.
Install TerminusDB with Docker on Windows
Complete guide to installing and running TerminusDB with Docker on Windows, including backup and restore instructions
Language-Tagged RDF Strings with curl
How to store and retrieve multilingual text in TerminusDB using rdf:langString and the HTTP API with curl.
Manage Access Control with the CLI
Create users, list roles, grant and revoke capabilities using the TerminusDB CLI. Includes a worked example for anonymous public cloning.
Perform a Delta Rollup
How delta rollup works in TerminusDB. Automatic in standard deployments via the built-in rollup plugin — manual optimisation is available for custom deployments.
Self-Hosted Installation Guide
How to deploy TerminusDB on your own infrastructure with production-ready configuration. Docker single container, Docker Compose, and bare-metal options.
Set Commit Messages on Document Operations
How to set author and message on document writes so the commit log records who made the change and why.
Access Control Reference
Complete reference for TerminusDB's role-based access control system. Manage users, roles, capabilities, and database permissions via the HTTP API.
Command Line Interface (CLI) Commands
Documentation of the TerminusDB command line interface (CLI) that enables users to interact with the local database using git-for-data and other operations
Context Cache
How TwinfoxDB Enterprise caches remote JSON-LD contexts locally using pre-seeded files and a disk-backed HTTP cache.
Database Path Identifiers Reference
Reference guide for GRAPH_SPEC, DB_SPEC, and path identifiers used in TerminusDB CLI, REST API, and client libraries to address databases, branches, commits, and graphs
Document Formats & Content Negotiation
How to read and write TerminusDB documents as JSON, JSON-LD, RDF/XML, or Turtle using query parameters or HTTP content negotiation.
Enterprise Configuration Reference
Complete reference for all TwinfoxDB Enterprise environment variables covering context caching, remote context processing, LRU cache tuning, and feature activation.
Managing Users and Invitations in TerminusDB
Learn how to create organizations, invite users with specific roles, and manage authorization in TerminusDB using the REST API
Prefix Management API
Learn how to manage namespace prefixes in TerminusDB to simplify your document IRIs and organize your data vocabularies.
Prometheus Observability
How to use the TwinfoxDB Enterprise Prometheus metrics endpoint for production monitoring, including available gauges for memory, cache, and request tracking.
RDF/XML Support
How TwinfoxDB Enterprise serializes and parses RDF/XML documents with proper namespace declarations, typed literals, subdocument nesting, and round-trip integrity.
Turtle Support
How TwinfoxDB Enterprise serializes and parses Turtle (TTL) documents with prefix declarations, typed literals, subdocument nesting, and round-trip integrity.
Authentication Errors — TerminusDB Troubleshooting
Fix authentication errors with TerminusDB including wrong credentials, password vs key parameter confusion, API key format issues, and permission denied errors.
Connection Failures — TerminusDB Troubleshooting
Diagnose and fix connection failures when connecting to TerminusDB, including Docker networking issues, wrong ports, browser fetch errors, and timeouts.
Troubleshooting Document ID Migration
How to fix subdocument ID prefix mismatches after schema changes using the ChangeKey migration operation.