TerminusDB API
API for TerminusDB
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API for TerminusDB
Endpoints 28
connection
- GETGet a list of databases for the authenticated user
/ - GETGet information about the TerminusDB version
/info - GETSimple status update
/ok
database
- GETList details of all databases available to the authorized user.
/db/ - GETList details of the database under the given organization.
/db/:organization/:database - PUTChange qualities of a database (label, comment, etc.)
/db/:organization/:database - POSTCreate a database
/db/:organization/:database - DELETEDelete a database
/db/:organization/:database - HEADCheck that a db exists
/db/:organization/:database - POSTPOST /optimize/{path}
/optimize/:path
document
- GETGet a document
/document/:path - PUTReplace a document
/document/:path?author=Jan&message=Fixed bad name for document - POSTInsert a new document
/document/:path?author=Jan&message=Fixed bad name for document - DELETEDelete one or multiple documents
/document/:path?author=Jan&message=Fixed bad name for document
frame
- GETGet the full class frame for a class or all classes for a schema
/schema
WOQL
- POSTPOST /woql
/woql - POSTPOST /woql/{path}
/woql/:path
collaboration
- POSTPOST /clone/{organization}/{database}
/clone/:organization/:database - POSTFetch the remote repository for the given path (default is origin)
/fetch/:path - POSTPush the branch to the remote
/push/:path - POSTPull to a branch from a remote
/pull/:path
branches
- POSTPOST /branch/{path}
/branch/:path - DELETEDELETE /branch/{path}
/branch/:path - GETGET /squash/{path}
/squash/:path - POSTPOST /reset/{path}
/reset/:path
prefixes
- GETGET /prefixes/{path}
/prefixes/:path
change management
- POSTPOST /diff
/diff - POSTPOST /patch
/patch
API details
- Base URL
http://localhost:6363/api- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 28 operations on 20 pathsPOST 13GET 9DELETE 3PUT 2HEAD 1
- Main resources
- database 7branches 4collaboration 4document 4connection 3WOQL 2change management 2frame 1prefixes 1
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
10.0.3 - Links
- Documentation · OpenAPI document
- Listed from
- TerminusDB's published OpenAPI description (terminusdb/openapi-specs) (Apache-2.0)
How to test the TerminusDB API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the TerminusDB API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get a list of databases for the authenticated user” (GET /), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the TerminusDB API?
API for TerminusDB It is listed under Data & analytics and has 28 endpoints.
Who publishes the TerminusDB API?
It is listed from TerminusDB's public API description (an OpenAPI document), not published by TerminusDB on Swastik Codes. Anyone who controls terminusdb.com can claim the profile by adding a DNS TXT record.
What is the base URL of the TerminusDB API?
Requests go to http://localhost:6363/api. Endpoint paths are added to this base URL.
How do I authenticate with the TerminusDB API?
With HTTP Basic authentication (username and password).
How many endpoints does the TerminusDB API have?
28 operations on 20 paths (13 POST, 9 GET, 3 DELETE, 2 PUT, 1 HEAD). The largest groups are database, branches, collaboration, document.
Is forking the TerminusDB API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.