Default

Generate Token

post

Body

application/json

accessKeystringRequired

secretKeystringRequired

usernamestringRequired

Responses

201

Token created

application/json

post

/api/v1/servers

HTTPcURLJavaScriptPython

POST /api/v1/servers HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "accessKey": "text",
  "secretKey": "text",
  "username": "text"
}

201

Token created

{
  "token": "text",
  "username": "text",
  "message": "text",
  "bucketName": "text",
  "bucketRegion": "text",
  "tags": {},
  "groupMembership": "text"
}

Server Health Check

get

Header parameters

AuthorizationstringRequired

Responses

200

Server health status

application/json

get

/api/v1/servers/ping

HTTPcURLJavaScriptPython

GET /api/v1/servers/ping HTTP/1.1
Host: 
Authorization: text
Accept: */*

200

Server health status

{
  "status": "text",
  "message": "text",
  "username": "text",
  "bucketName": "text",
  "region": "text"
}

Shutdown Server

post

Header parameters

AuthorizationstringRequired

Responses

200

Server shutdown

application/json

post

/api/v1/servers/shutdown

HTTPcURLJavaScriptPython

POST /api/v1/servers/shutdown HTTP/1.1
Host: 
Authorization: text
Accept: */*

200

Server shutdown

{
  "message": "text"
}

List Databases

get

Header parameters

AuthorizationstringRequired

Responses

200

List of databases

application/json

get

/api/v1/databases

HTTPcURLJavaScriptPython

GET /api/v1/databases HTTP/1.1
Host: 
Authorization: text
Accept: */*

200

List of databases

{
  "databases": [
    "text"
  ],
  "count": 1
}

Create Database

post

Header parameters

AuthorizationstringRequired

Body

application/json

namestringRequired

Responses

201

Database created

application/json

post

/api/v1/databases

HTTPcURLJavaScriptPython

POST /api/v1/databases HTTP/1.1
Host: 
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

201

Database created

{
  "message": "text",
  "name": "text"
}

Get Database Info

get

Path parameters

namestringRequired

Header parameters

AuthorizationstringRequired

Responses

200

Database information

application/json

get

/api/v1/databases/{name}

HTTPcURLJavaScriptPython

GET /api/v1/databases/{name} HTTP/1.1
Host: 
Authorization: text
Accept: */*

200

Database information

{
  "id": "text",
  "name": "text",
  "createdAt": "text",
  "lastAccessed": "text",
  "lastSynced": "text",
  "sizeBytes": 1,
  "isAttached": true,
  "local": true,
  "schemas": {}
}

Delete Database

delete

Path parameters

namestringRequired

Header parameters

AuthorizationstringRequired

Responses

200

Database deleted

application/json

delete

/api/v1/databases/{name}

HTTPcURLJavaScriptPython

DELETE /api/v1/databases/{name} HTTP/1.1
Host: 
Authorization: text
Accept: */*

200

Database deleted

{
  "message": "text",
  "name": "text"
}

Execute Query

post

Header parameters

AuthorizationstringRequired

Body

application/json

sqlstringRequired

parametersstring[]Optional

Responses

200

Query result

application/json

post

/api/v1/query

HTTPcURLJavaScriptPython

POST /api/v1/query HTTP/1.1
Host: 
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "sql": "text",
  "parameters": [
    "text"
  ]
}

200

Query result

{
  "columns": [
    "text"
  ],
  "rows": [
    [
      "text"
    ]
  ]
}

Get Table Syncs

get

Header parameters

AuthorizationstringRequired

Responses

200

Table syncs grouped by replication

application/json

get

/api/replication/table_syncs_v1

HTTPcURLJavaScriptPython

GET /api/replication/table_syncs_v1 HTTP/1.1
Host: 
Authorization: text
Accept: */*

200

Table syncs grouped by replication

{
  "databases": [
    {
      "id": "text",
      "name": "text",
      "source": {
        "credentials": {}
      },
      "destination": {
        "credentials": {}
      },
      "tables": [
        {
          "id": "text",
          "source_details": {},
          "destination_details": {}
        }
      ]
    }
  ]
}

Run Table Sync

post

Header parameters

AuthorizationstringRequired

Body

application/json

tableSyncIdstringRequired

incrementalbooleanOptional

Responses

200

Table sync triggered

application/json

Responseobject

post

/api/replication/table_syncs_v1

HTTPcURLJavaScriptPython

POST /api/replication/table_syncs_v1 HTTP/1.1
Host: 
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "tableSyncId": "text",
  "incremental": true
}

200

Table sync triggered

{}