HTTP API

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

Connection

Get a list of databases for the authenticated user

GEThttp://localhost:6363/api//

Response

200401

successful operation

Body

application/json

@idstring

@typestring

commentstring

creation_datestring

labelstring

namestring

statestring

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "@id": "UserDatabase/MyUserDatabase3315d1a3bb196e322e40bc53ac",
    "@type": "UserDatabase",
    "comment": "A comment for my database",
    "creation_date": "2021-12-13T14:27:46.202Z",
    "label": "MyDatabaseLabel",
    "name": "My Database Name",
    "state": "finalized"
  }
]

Get information about the TerminusDB version

GEThttp://localhost:6363/api//info

Response

200

succesful operation

Body

application/json

@typestring

api:infoobject

api:statusstring

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:InfoResponse",
  "api:info": {
    "authority": "terminusdb://system/data/User/admin",
    "storage": {
      "version": "1"
    },
    "terminusdb": {
      "version": "10.0.13"
    },
    "terminusdb_store": {
      "version": "0.19.5"
    }
  },
  "api:status": "api:success"
}

Simple status update

GEThttp://localhost:6363/api//ok

Response

200

Succeeded

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//ok', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Database

List details of all databases available to the authorized user.

GEThttp://localhost:6363/api//db

Query parameters

Response

200404

Database listing

Body

application/json

@idstring

@typestring

commentstring

creation_datestring

labelstring

namestring

statestring

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//db', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@id": "UserDatabase/MyUserDatabase3315d1a3bb196e322e40bc53ac",
  "@type": "UserDatabase",
  "comment": "A comment for my database",
  "creation_date": "2021-12-13T14:27:46.202Z",
  "label": "MyDatabaseLabel",
  "name": "My Database Name",
  "state": "finalized"
}

List details of the database under the given organization.

GEThttp://localhost:6363/api//db/{organization}/{database}

Path parameters

organization*string

Organization for the database

database*string

Database name

Query parameters

Response

200404

Database listing

Body

application/json

@idstring

@typestring

commentstring

creation_datestring

labelstring

namestring

statestring

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//db/{organization}/{database}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "@id": "UserDatabase/MyUserDatabase3315d1a3bb196e322e40bc53ac",
    "@type": "UserDatabase",
    "comment": "A comment for my database",
    "creation_date": "2021-12-13T14:27:46.202Z",
    "label": "MyDatabaseLabel",
    "name": "My Database Name",
    "state": "finalized"
  }
]

Check that a db exists

HEADhttp://localhost:6363/api//db/{organization}/{database}

Path parameters

organization*string

Organization for the database

database*string

Database name

Response

200404

Database exists

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//db/{organization}/{database}', {
    method: 'HEAD',
    headers: {},
});
const data = await response.json();

Create a database

POSThttp://localhost:6363/api//db/{organization}/{database}

Path parameters

organization*string

Organization for the database

database*string

Database name

Body

application/json

comment*string

label*string

publicboolean

Should the database be accessible for all users?

schemaboolean

Should the database be initialized with a schema?

Response

200400401

Added database

Body

application/json

@typestring

api:statusstring

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//db/{organization}/{database}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "comment": "A sample comment for my database",
      "label": "Testdatabase"
    }),
});
const data = await response.json();

Response

{
  "@type": "api:DbCreateResponse",
  "api:status": "api:success"
}

Delete a database

DELETEhttp://localhost:6363/api//db/{organization}/{database}

Path parameters

organization*string

Organization for the database

database*string

Database name

Query parameters

Response

200403404

Succesfully deleted DB

Body

application/json

@typestring

api:statusstring

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//db/{organization}/{database}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:DbDeleteResponse",
  "api:status": "api:success"
}

Change qualities of a database (label, comment, etc.)

PUThttp://localhost:6363/api//db/{organization}/{database}

Path parameters

organization*string

Organization for the database

database*string

Database name

Body

application/json

comment*string

label*string

publicboolean

Should the database be accessible for all users?

schemaboolean

Should the database be initialized with a schema?

Response

200401403404

Updated database

Body

application/json

@typestring

api:statusstring

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//db/{organization}/{database}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "comment": "A sample comment for my database",
      "label": "Testdatabase"
    }),
});
const data = await response.json();

Response

{
  "@type": "api:DbUpdatedResponse",
  "api:status": "api:success"
}

Document

Get a document

GEThttp://localhost:6363/api//document/{path}

Path parameters

path*string

Path for document

Query parameters

Response

200

List of documents

Body

application/json

object

Concatenated list of JSON documents

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//document/{path}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@id": "Organization/admin",
  "@type": "Organization",
  "database": [
    "SystemDatabase/system",
    "UserDatabase/60c35164e937174bbf4dd814c78153d660edc55b3d799c534c1e2d872a3d2dd6"
  ],
  "name": "admin"
}

Insert a new document

POSThttp://localhost:6363/api//document/{path}

Path parameters

path*string

Path for document

Query parameters

Response

200

Succesfully added documents

Body

application/json

object

Added documents

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//document/{path}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Delete one or multiple documents

DELETEhttp://localhost:6363/api//document/{path}

Path parameters

path*string

Path for document

Query parameters

Response

200

Succesfully deleted document(s)

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//document/{path}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Replace a document

PUThttp://localhost:6363/api//document/{path}

Path parameters

path*string

Path for document

Query parameters

Response

200

Succesfully replaced documents

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//document/{path}', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Frame

Get the full class frame for a class or all classes for a schema

GEThttp://localhost:6363/api//schema

Path parameters

path*string

Path for document

Query parameters

Response

200

Class Frame, or object of all class frames has been successfully returned

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//schema', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

WOQL

POSThttp://localhost:6363/api//woql

Body

application/json

queryobject

WOQL Query

commit_infoCommitInfo (object)

all_witnessesboolean

Check for all errors

Response

200

Query result

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//woql', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

POSThttp://localhost:6363/api//woql/{path}

Path parameters

path*string

Database Path

Body

application/json

queryobject

WOQL Query

commit_infoCommitInfo (object)

all_witnessesboolean

Check for all errors

Response

200

Query result

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//woql/{path}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Collaboration

POSThttp://localhost:6363/api//clone/{organization}/{database}

Path parameters

organization*string

Organization for the database

database*string

Database name

Body

application/json

comment*string

The comment to use in the cloned database

label*string

The label to use for the cloned database

remote_url*string

The URL of the database to clone

publicboolean

Whether to make the newly cloned database public

Response

200

Database cloned succesfully

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//clone/{organization}/{database}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "comment": "This is a comment on my cloned database",
      "label": "This is how I label my cloned database",
      "remote_url": "http://cloud.terminusdb.com/TerminatorsX/TerminatorsX/nuclear"
    }),
});
const data = await response.json();

Fetch the remote repository for the given path (default is origin)

POSThttp://localhost:6363/api//fetch/{path}

Path parameters

path*string

Path for branch

Header parameters

Response

200

Successful fetch

Body

application/json

@type:enum

api:FetchRequest

api:statusenum

api:success

api:head_has_changedboolean

api:headstring

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//fetch/{path}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "@type:": "api:FetchRequest",
  "api:status": "api:success",
  "api:head_has_changed": false,
  "api:head": "194822f8942286517e151817d38acca4c9ac7d01"
}

Push the branch to the remote

POSThttp://localhost:6363/api//push/{path}

Path parameters

path*string

Path for branch

Body

application/json

remote*string

The name of the remote to push to

remote_branch*string

The name of the branch on the remote to push

push_prefixesboolean

Should the prefixes also be pushed to the remote?

Response

200400

Push Response

Body

application/json

@typeenum

api:PushResponse

api:repo_head_updatedboolean

api:repo_headstring

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//push/{path}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "remote": "origin",
      "remote_branch": "main"
    }),
});
const data = await response.json();

Response

{
  "@type": "api:PushResponse",
  "api:repo_head_updated": false,
  "api:repo_head": "194822f8942286517e151817d38acca4c9ac7d01",
  "api:status": "api:success"
}

Pull to a branch from a remote

POSThttp://localhost:6363/api//pull/{path}

Path parameters

path*string

Path for branch

Body

application/json

remote*string

The name of the remote to push to

remote_branch*string

The name of the branch on the remote to push

Response

200

Pull Response

Body

application/json

@typeenum

api:PullResponse

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//pull/{path}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "remote": "origin",
      "remote_branch": "main"
    }),
});
const data = await response.json();

Response

{
  "@type": "api:PullResponse",
  "api:status": "api:success"
}

Create a new remote

POSThttp://localhost:6363/api//remote/{path}

Path parameters

path*string

Path for branch

Body

application/json

remote_name*string

The name of the remote

remote_location*string

The URI to associate with the remote

Response

200

Remote update success

Body

application/json

@typeenum

api:RemoteResponse

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//remote/{path}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "remote_name": "origin",
      "remote_location": "http://cloud.terminusdb.com/TerminatorsX/TerminatorsX/nuclear"
    }),
});
const data = await response.json();

Response

{
  "@type": "api:RemoteResponse",
  "api:status": "api:success"
}

Delete a remote

DELETEhttp://localhost:6363/api//remote/{path}

Path parameters

path*string

Path for branch

Query parameters

Response

200

Remote delete success

Body

application/json

@typeenum

api:RemoteResponse

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//remote/{path}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:RemoteResponse",
  "api:status": "api:success"
}

Update a remote with a new location

PUThttp://localhost:6363/api//remote/{path}

Path parameters

path*string

Path for branch

Body

application/json

remote_name*string

The name of the remote

remote_location*string

The URI to associate with the remote

Response

200

Remote update success

Body

application/json

@typeenum

api:RemoteResponse

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//remote/{path}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "remote_name": "origin",
      "remote_location": "http://cloud.terminusdb.com/TerminatorsX/TerminatorsX/nuclear"
    }),
});
const data = await response.json();

Response

{
  "@type": "api:RemoteResponse",
  "api:status": "api:success"
}

Get the url for a given remote

GEThttp://localhost:6363/api//remote/{path}

Path parameters

path*string

Path for branch

Query parameters

Response

200

Remote delete success

Body

application/json

@typeenum

api:RemoteResponse

api:remote_namestring

api:remote_urlstring

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//remote/{path}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:RemoteResponse",
  "api:remote_name": "origin",
  "api:remote_url": "http://cloud.terminusdb.com/TerminatorsX/TerminatorsX/nuclear",
  "api:status": "api:success"
}

Branches

POSThttp://localhost:6363/api//branch/{path}

Path parameters

path*string

Path for branch

Body

application/json

object

Response

200

Branch succesfully added

Body

application/json

@type:enum

api:BranchResponse

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//branch/{path}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "@type:": "api:BranchResponse",
  "api:status": "api:success"
}

DELETEhttp://localhost:6363/api//branch/{path}

Path parameters

path*string

Path for branch

Response

200

Branch succesfully deleted

Body

application/json

@type:enum

api:BranchResponse

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//branch/{path}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "@type:": "api:BranchResponse",
  "api:status": "api:success"
}

GEThttp://localhost:6363/api//squash/{path}

Path parameters

path*string

Path for branch

Response

200

Succesfully squashed the branch

Body

application/json

@typeenum

api:SquashResponse

api:commitstring

api:old_commitstring

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//squash/{path}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:SquashResponse",
  "api:commit": "admin/test/local/commit/apgatilsa03g4lsa9ra5698wom5wcv7",
  "api:old_commit": "admin/test/local/commit/5jndjh9lexe62q9u1q2vofyjemfnmyt",
  "api:status": "api:success"
}

POSThttp://localhost:6363/api//reset/{path}

Path parameters

path*string

Path for branch

Body

application/json

commit_descriptorstring

Response

200

Succesfully reset branch HEAD to commit_descriptor

Body

application/json

@typeenum

api:ResetResponse

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//reset/{path}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "@type": "api:ResetResponse",
  "api:status": "api:success"
}

Optimize

POSThttp://localhost:6363/api//optimize/{path}

Path parameters

path*string

Database Path

Response

200

Succesfully optimized resource

Body

application/json

@typeenum

api:OptimizeResponse

api:statusenum

api:success

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//optimize/{path}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:OptimizeResponse",
  "api:status": "api:success"
}

Prefixes

GEThttp://localhost:6363/api//prefixes/{path}

Path parameters

path*string

Database Path

Response

200

Succesfully fetched prefixes of graph

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//prefixes/{path}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Change management

POSThttp://localhost:6363/api//diff

Body

application/json

beforeobject

afterobject

before_data_versionstring

after_data_versionstring

document_idstring

keepobject

Response

200404

Successful Diff

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//diff', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "name": {
    "@op": "ValueSwap",
    "@before": "Jane",
    "@after": "Janine"
  }
}

POSThttp://localhost:6363/api//patch

Body

application/json

beforeobject

patchobject

Response

200404

Successful Patch

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//patch', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "@id": "Person/Jane",
  "@type": "Person",
  "name": "Jannet"
}

POSThttp://localhost:6363/api//apply/{path}

Path parameters

path*string

Path for branch

Body

application/json

before_commit*object

after_commit*object

commit_info*CommitInfo (object)

match_final_stateboolean

keepobject

Response

200409

Successful Patch Application

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//apply/{path}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "before_commit": {
        "@id": "Person/Jane",
        "@type": "Person",
        "name": "Jane"
      },
      "after_commit": {
        "name": {
          "@op": "ValueSwap",
          "@before": "Jane",
          "@after": "Janine"
        }
      },
      "commit_info": {}
    }),
});
const data = await response.json();

Response

{
  "@type": "api:ApplyResponse",
  "api:status": "api:success"
}

Get commits from a specific database or branch

GEThttp://localhost:6363/api//log/{organization}/{database}

Path parameters

organization*string

Organization for the database

database*string

Database name

Query parameters

Response

200

Successful log request

Body

application/json

@idstring

@typestring

authorstring

identifierstring

messagestring

schemastring

timestampnumber

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//log/{organization}/{database}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "@type": "api:ApplyResponse",
    "api:status": "api:success"
  }
]

Account management

Adding a new role

POSThttp://localhost:6363/api//roles

Body

application/json

name*string

action*array of string

Response

200400403

Successfully added role

Body

application/json

string

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//roles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Grand Pubah",
      "action": [
        "branch",
        "class_frame",
        "clone",
        "commit_read_access",
        "commit_write_access",
        "create_database",
        "delete_database",
        "fetch",
        "instance_read_access",
        "instance_write_access",
        "manage_capabilities",
        "meta_read_access",
        "meta_write_access",
        "push",
        "rebase",
        "schema_read_access",
        "schema_write_access"
      ]
    }),
});
const data = await response.json();

Response

"Role/Grand%20Pubah"

Changing actions for a role

PUThttp://localhost:6363/api//roles

Body

application/json

name*string

action*array of string

Response

200400403404

Successfully updated role

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//roles', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Grand Pubah",
      "action": [
        "branch",
        "class_frame",
        "clone",
        "commit_read_access",
        "commit_write_access",
        "create_database",
        "delete_database",
        "fetch",
        "instance_read_access",
        "instance_write_access",
        "manage_capabilities",
        "meta_read_access",
        "meta_write_access",
        "push",
        "rebase",
        "schema_read_access",
        "schema_write_access"
      ]
    }),
});
const data = await response.json();

Response

{
  "@type": "api:RolesResponse",
  "api:status": "api:success"
}

Get all roles available with the current authority

GEThttp://localhost:6363/api//roles

Response

200

Listing of all roles

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//roles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "@id": "Role/admin",
    "@type": "Role",
    "action": [
      "branch",
      "class_frame",
      "clone",
      "commit_read_access",
      "commit_write_access",
      "create_database",
      "delete_database",
      "fetch",
      "instance_read_access",
      "instance_write_access",
      "manage_capabilities",
      "meta_read_access",
      "meta_write_access",
      "push",
      "rebase",
      "schema_read_access",
      "schema_write_access"
    ],
    "name": "Admin Role"
  },
  {
    "@id": "Role/consumer",
    "@type": "Role",
    "action": [
      "class_frame",
      "instance_read_access",
      "schema_read_access"
    ],
    "name": "ConsumerRole"
  }
]

DELETEhttp://localhost:6363/api//roles/{roleName}

Path parameters

roleName*string

Response

200404

Successfully deleted role

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//roles/{roleName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:RolesResponse",
  "api:status": "api:success"
}

Get the role object by role name

GEThttp://localhost:6363/api//roles/{roleName}

Path parameters

roleName*string

Response

200404

Successfully aquired role

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//roles/{roleName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@id": "Role/consumer",
  "@type": "Role",
  "action": [
    "class_frame",
    "instance_read_access",
    "schema_read_access"
  ],
  "name": "Consumer Role"
}

Get all organizations according to the capabilities of the user

GEThttp://localhost:6363/api//organizations

Response

200

Succesful listing of organizations

Body

application/json

array of object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//organizations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "@id": "Organization/admin",
    "@type": "Organization",
    "database": [
      "SystemDatabase/system",
      "UserDatabase/326f41af8c9499b0eea69b67fdced3efbd31663ca601dee8c50d3ad3393b367d",
      "UserDatabase/462333349c1a8271aca185a3bd2d601057fdf2584a88687ad55e43cab635da48",
      "UserDatabase/b4e01001e90bd368f8f19640426f346970f5ceb8eb02acaa42c759f3758e1901",
      "UserDatabase/f5a0ef94469b32e1aee321678436c7dfd5a96d9c476672b3282ae89a45b5200e"
    ],
    "name": "admin"
  }
]

Get the organization object by name

GEThttp://localhost:6363/api//organizations/{organizationName}

Path parameters

organizationName*string

Response

200403404

Successfully aquired organization

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//organizations/{organizationName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@id": "Organization/admin",
  "@type": "Organization",
  "database": [
    "SystemDatabase/system",
    "UserDatabase/326f41af8c9499b0eea69b67fdced3efbd31663ca601dee8c50d3ad3393b367d",
    "UserDatabase/462333349c1a8271aca185a3bd2d601057fdf2584a88687ad55e43cab635da48",
    "UserDatabase/b4e01001e90bd368f8f19640426f346970f5ceb8eb02acaa42c759f3758e1901",
    "UserDatabase/f5a0ef94469b32e1aee321678436c7dfd5a96d9c476672b3282ae89a45b5200e"
  ],
  "name": "admin"
}

Add an organization with the given name

POSThttp://localhost:6363/api//organizations/{organizationName}

Path parameters

organizationName*string

Response

200400

Successfully added organization

Body

application/json

string

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//organizations/{organizationName}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

"terminusdb://system/data/Organization/admin"

Delete the organization of the given name

DELETEhttp://localhost:6363/api//organizations/{organizationName}

Path parameters

organizationName*string

Response

200400

Successfully deleted organization

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//organizations/{organizationName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:OrganizationResponse",
  "api:status": "api:success"
}

Get all available users according to capabilities within an organization

GEThttp://localhost:6363/api//organizations/{organizationName}/users

Path parameters

organizationName*string

Response

200400403

Successfully listing users in organization

Body

application/json

array of object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//organizations/{organizationName}/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "@id": "User/admin",
    "capability": [
      {
        "@id": "Capability/server_access",
        "@type": "Capability",
        "role": [
          {
            "@id": "Role/admin",
            "@type": "Role",
            "action": [
              "branch",
              "class_frame",
              "clone",
              "commit_read_access",
              "commit_write_access",
              "create_database",
              "delete_database",
              "fetch",
              "instance_read_access",
              "instance_write_access",
              "manage_capabilities",
              "meta_read_access",
              "meta_write_access",
              "push",
              "rebase",
              "schema_read_access",
              "schema_write_access"
            ],
            "name": "AdminRole"
          }
        ],
        "scope": "Organization/admin"
      }
    ],
    "name": "admin"
  }
]

Get a user record for a given organization

GEThttp://localhost:6363/api//organizations/{organizationName}/users/{userName}

Path parameters

organizationName*string

userName*string

Response

200400403

Successfully listing users in organization

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//organizations/{organizationName}/users/{userName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@id": "User/admin",
  "capability": [
    {
      "@id": "Capability/server_access",
      "@type": "Capability",
      "role": [
        {
          "@id": "Role/admin",
          "@type": "Role",
          "action": [
            "branch",
            "class_frame",
            "clone",
            "commit_read_access",
            "commit_write_access",
            "create_database",
            "delete_database",
            "fetch",
            "instance_read_access",
            "instance_write_access",
            "manage_capabilities",
            "meta_read_access",
            "meta_write_access",
            "push",
            "rebase",
            "schema_read_access",
            "schema_write_access"
          ],
          "name": "AdminRole"
        }
      ],
      "scope": "Organization/admin"
    }
  ],
  "name": "admin"
}

Get the databases available to a user which are inside an organization

GEThttp://localhost:6363/api//organizations/{organizationName}/users/{userName}/databases

Path parameters

organizationName*string

userName*string

Response

200400403

Successfully listing users in organization

Body

application/json

array of object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//organizations/{organizationName}/users/{userName}/databases', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "@id": "SystemDatabase/system",
    "@type": "SystemDatabase",
    "name": "_system"
  }
]

Update a user's password

PUThttp://localhost:6363/api//users

Body

application/json

name*string

password*string

Response

200400

Successfully updated user

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//users', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Jim",
      "password": "Very secret"
    }),
});
const data = await response.json();

Response

{
  "@type": "api:UsersResponse",
  "api:status": "api:success"
}

Create a new user

POSThttp://localhost:6363/api//users

Body

application/json

name*string

passwordstring

Response

200400

Successfully added user

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Jim"
    }),
});
const data = await response.json();

Response

{
  "@type": "api:UsersResponse",
  "api:status": "api:success"
}

Grant or remove capabilities over a resource to a user

POSThttp://localhost:6363/api//capabilities

Body

application/json

operation*enum

revokegrant

scope*string

user*string

roles*array of string

Response

200400

Successfully granted or revoked roles

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//capabilities', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operation": "revoke",
      "scope": "UserDatabase/f5a0ef94469b32e1aee321678436c7dfd5a96d9c476672b3282ae89a45b5200e",
      "user": "User/admin",
      "roles": [
        "Role/consumer",
        "Role/admin"
      ]
    }),
});
const data = await response.json();

Response

{
  "@type": "api:CapabilityResponse",
  "api:status": "api:success"
}

Account Management

Get all users

GEThttp://localhost:6363/api//users

Query parameters

Response

200403

Success at listing users

Body

application/json

array of object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "@id": "User/admin",
    "@type": "User",
    "capability": [
      "Capability/server_access"
    ],
    "name": "admin"
  }
]

Get a user by name

GEThttp://localhost:6363/api//users/{userName}

Path parameters

userName*string

Query parameters

Response

200403

Success at acquiring user record

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//users/{userName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "@id": "User/admin",
  "@type": "User",
  "capability": [
    "Capability/server_access"
  ],
  "name": "admin"
}

Delete a user

DELETEhttp://localhost:6363/api//users/{userName}

Path parameters

userName*string

Response

200403

Success at deleting a user

Body

application/json

object

Request

JavaScriptCurl

const response = await fetch('http://localhost:6363/api//users/{userName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "@type": "api:UsersResponse",
  "api:status": "api:success"
}