Skip to content

Latest commit

 

History

History
328 lines (170 loc) · 22.1 KB

openapi.md

File metadata and controls

328 lines (170 loc) · 22.1 KB

HTTP API

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

Connection

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/info" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/ok" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Database

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/db" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/db/{organization}/{database}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/db/{organization}/{database}" method="head" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/db/{organization}/{database}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/db/{organization}/{database}" method="delete" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/db/{organization}/{database}" method="put" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Document

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/document/{path}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/document/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/document/{path}" method="delete" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/document/{path}" method="put" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Frame

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/schema" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

WOQL

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/woql" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/woql/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Collaboration

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/clone/{organization}/{database}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/fetch/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/push/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/pull/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/remote/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/remote/{path}" method="delete" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/remote/{path}" method="put" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/remote/{path}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Branches

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/branch/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/branch/{path}" method="delete" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/squash/{path}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/reset/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Optimize

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/optimize/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Prefixes

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/prefixes/{path}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Change management

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/diff" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/patch" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/apply/{path}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/log/{organization}/{database}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Account management

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/roles" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/roles" method="put" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/roles" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/roles/{roleName}" method="delete" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/roles/{roleName}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/organizations" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/organizations/{organizationName}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/organizations/{organizationName}" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/organizations/{organizationName}" method="delete" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/organizations/{organizationName}/users" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/organizations/{organizationName}/users/{userName}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/organizations/{organizationName}/users/{userName}/databases" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/users" method="put" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/users" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/capabilities" method="post" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

Account Management

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/users" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/users/{userName}" method="get" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}

{% swagger src="https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml" path="/users/{userName}" method="delete" %} https://raw.githubusercontent.com/terminusdb/terminusdb/c432572241a3dd77b681a7a9e82247bb6d9caeaa/docs/openapi.yaml {% endswagger %}