HTTP API
View the HTTP API docs on the Swagger editor interface as well. It has a better UI

Connection

get
http://localhost:6363/api/
/
Get a list of databases for the authenticated user
get
http://localhost:6363/api/
/info
Get information about the TerminusDB version
get
http://localhost:6363/api/
/ok
Simple status update

Database

get
http://localhost:6363/api/
/db
List details of all databases available to the authorized user.
get
http://localhost:6363/api/
/db/{organization}/{database}
List details of the database under the given organization.
head
http://localhost:6363/api/
/db/{organization}/{database}
Check that a db exists
post
http://localhost:6363/api/
/db/{organization}/{database}
Create a database
delete
http://localhost:6363/api/
/db/{organization}/{database}
Delete a database
put
http://localhost:6363/api/
/db/{organization}/{database}
Change qualities of a database (label, comment, etc.)

Document

get
http://localhost:6363/api/
/document/{path}
Get a document
post
http://localhost:6363/api/
/document/{path}
Insert a new document
delete
http://localhost:6363/api/
/document/{path}
Delete one or multiple documents
put
http://localhost:6363/api/
/document/{path}
Replace a document

Frame

get
http://localhost:6363/api/
/schema
Get the full class frame for a class or all classes for a schema

WOQL

post
http://localhost:6363/api/
/woql
post
http://localhost:6363/api/
/woql/{path}

Collaboration

post
http://localhost:6363/api/
/clone/{organization}/{database}
post
http://localhost:6363/api/
/fetch/{path}
Fetch the remote repository for the given path (default is origin)
post
http://localhost:6363/api/
/push/{path}
Push the branch to the remote
post
http://localhost:6363/api/
/pull/{path}
Pull to a branch from a remote
post
http://localhost:6363/api/
/remote/{path}
Create a new remote
delete
http://localhost:6363/api/
/remote/{path}
Delete a remote
put
http://localhost:6363/api/
/remote/{path}
Update a remote with a new location
get
http://localhost:6363/api/
/remote/{path}
Get the url for a given remote

Branches

post
http://localhost:6363/api/
/branch/{path}
delete
http://localhost:6363/api/
/branch/{path}
get
http://localhost:6363/api/
/squash/{path}
post
http://localhost:6363/api/
/reset/{path}

Optimize

post
http://localhost:6363/api/
/optimize/{path}

Prefixes

get
http://localhost:6363/api/
/prefixes/{path}

Change management

post
http://localhost:6363/api/
/diff
post
http://localhost:6363/api/
/patch
post
http://localhost:6363/api/
/apply/{path}
get
http://localhost:6363/api/
/log/{organization}/{database}
Get commits from a specific database or branch

Account management

post
http://localhost:6363/api/
/roles
Adding a new role
put
http://localhost:6363/api/
/roles
Changing actions for a role
get
http://localhost:6363/api/
/roles
Get all roles available with the current authority
delete
http://localhost:6363/api/
/roles/{roleName}
get
http://localhost:6363/api/
/roles/{roleName}
Get the role object by role name
get
http://localhost:6363/api/
/organizations
Get all organizations according to the capabilities of the user
get
http://localhost:6363/api/
/organizations/{organizationName}
Get the organization object by name
post
http://localhost:6363/api/
/organizations/{organizationName}
Add an organization with the given name
delete
http://localhost:6363/api/
/organizations/{organizationName}
Delete the organization of the given name
get
http://localhost:6363/api/
/organizations/{organizationName}/users
Get all available users according to capabilities within an organization
get
http://localhost:6363/api/
/organizations/{organizationName}/users/{userName}
Get a user record for a given organization
get
http://localhost:6363/api/
/organizations/{organizationName}/users/{userName}/databases
Get the databases available to a user which are inside an organization
put
http://localhost:6363/api/
/users
Update a user's password
post
http://localhost:6363/api/
/users
Create a new user
post
http://localhost:6363/api/
/capabilities
Grant or remove capabilities over a resource to a user

Account Management

get
http://localhost:6363/api/
/users
Get all users
get
http://localhost:6363/api/
/users/{userName}
Get a user by name
delete
http://localhost:6363/api/
/users/{userName}
Delete a user
Export as PDF
Copy link
On this page
Connection
get
/
get
/info
get
/ok
Database
get
/db
get
/db/{organization}/{database}
head
/db/{organization}/{database}
post
/db/{organization}/{database}
delete
/db/{organization}/{database}
put
/db/{organization}/{database}
Document
get
/document/{path}
post
/document/{path}
delete
/document/{path}
put
/document/{path}
Frame
get
/schema
WOQL
post
/woql
post
/woql/{path}
Collaboration
post
/clone/{organization}/{database}
post
/fetch/{path}
post
/push/{path}
post
/pull/{path}
post
/remote/{path}
delete
/remote/{path}
put
/remote/{path}
get
/remote/{path}
Branches
post
/branch/{path}
delete
/branch/{path}
get
/squash/{path}
post
/reset/{path}
Optimize
post
/optimize/{path}
Prefixes
get
/prefixes/{path}
Change management
post
/diff
post
/patch
post
/apply/{path}
get
/log/{organization}/{database}
Account management
post
/roles
put
/roles
get
/roles
delete
/roles/{roleName}
get
/roles/{roleName}
get
/organizations
get
/organizations/{organizationName}
post
/organizations/{organizationName}
delete
/organizations/{organizationName}
get
/organizations/{organizationName}/users
get
/organizations/{organizationName}/users/{userName}
get
/organizations/{organizationName}/users/{userName}/databases
put
/users
post
/users
post
/capabilities
Account Management
get
/users
get
/users/{userName}
delete
/users/{userName}