Workspaces

get

List workspace

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Responses

200

Success: Workspace List

application/json

get

/api/v1/workspaces/

HTTPcURLJavaScriptPython

GET /api/v1/workspaces/ HTTP/1.1
Host: /
Accept: */*

200

Success: Workspace List

{
  "workspaces": [
    {
      "pk": 1,
      "name": "text",
      "organization": 1,
      "engine_id": "text",
      "owner_name": "text",
      "created_at": "2025-12-23T01:16:59.182Z",
      "status": "text",
      "engine": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "latest_job_status": "STARTED",
        "connector_type": "text",
        "source_database_status": "CURRENT"
      },
      "initialization_mode": "SYNTHESIZE",
      "key_generation_method": "duplicate",
      "default_locale": "en"
    }
  ]
}

post

Create a new workspace and engine

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Query parameters

sample_dbstringOptional

The sample database to use

Body

application/json

initialization_modeany ofOptionalDefault: DE_IDENTIFY

string · enumOptionalPossible values:

or

nullOptional

key_generation_methodany ofOptionalDefault: duplicate

string · enumOptionalPossible values:

or

nullOptional

default_localeany ofOptionalDefault: en

string · enumOptionalPossible values:

or

nullOptional

default_exclude_tablesany ofOptionalDefault: false

booleanOptional

or

nullOptional

source_connectionone ofRequired

or

or

or

or

or

or

target_connectionone ofRequired

or

or

or

or

or

or

or

or

namestringRequired

organizationintegerRequired

Responses

200

Success: Created workspace

application/json

400

Failed

application/json

post

/api/v1/workspaces/

HTTPcURLJavaScriptPython

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

{
  "initialization_mode": "DE_IDENTIFY",
  "key_generation_method": "duplicate",
  "default_locale": "en",
  "default_exclude_tables": false,
  "source_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1433,
    "protocol": "mssql+pyodbc",
    "include_views": false
  },
  "target_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1433,
    "protocol": "mssql+pyodbc",
    "include_views": false
  },
  "name": "text",
  "organization": 1
}

{
  "pk": 1,
  "name": "text",
  "organization": 1,
  "engine_id": "text",
  "owner_name": "text",
  "created_at": "2025-12-23T01:16:59.182Z",
  "status": "text",
  "engine": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_job_status": "STARTED",
    "connector_type": "text",
    "source_database_status": "CURRENT"
  },
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "default_locale": "en"
}

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Responses

200Success

application/json

get

/api/v1/workspaces/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/workspaces/{id}/ HTTP/1.1
Host: /
Accept: */*

200Success

{
  "pk": 1,
  "name": "text",
  "organization": 1,
  "engine_id": "text",
  "owner_name": "text",
  "created_at": "2025-12-23T01:16:59.182Z",
  "status": "text",
  "engine": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_job_status": "STARTED",
    "connector_type": "text",
    "source_database_status": "CURRENT"
  },
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "default_locale": "en"
}

put

Update a workspace and engine

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Body

application/json

source_connectionone ofRequired

or

or

or

or

or

or

target_connectionone ofRequired

or

or

or

or

or

or

or

or

key_generation_methodany ofOptionalDefault: duplicate

string · enumOptionalPossible values:

or

nullOptional

default_localeany ofOptionalDefault: en

string · enumOptionalPossible values:

or

nullOptional

initialization_modeany ofOptionalDefault: DE_IDENTIFY

string · enumOptionalPossible values:

or

nullOptional

namestringRequired

Responses

200

Success: Created workspace

application/json

400

Failed

application/json

put

/api/v1/workspaces/{id}/

HTTPcURLJavaScriptPython

PUT /api/v1/workspaces/{id}/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 1201

{
  "source_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1,
    "protocol": "text",
    "include_views": true
  },
  "target_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1,
    "protocol": "text",
    "include_views": true
  },
  "key_generation_method": "duplicate",
  "default_locale": "en",
  "initialization_mode": "DE_IDENTIFY",
  "name": "text"
}

{
  "pk": 1,
  "name": "text",
  "organization": 1,
  "engine_id": "text",
  "owner_name": "text",
  "created_at": "2025-12-23T01:16:59.182Z",
  "status": "text",
  "engine": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_job_status": "STARTED",
    "connector_type": "text",
    "source_database_status": "CURRENT"
  },
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "default_locale": "en"
}

delete

Delete a workspace and cancel workspace creation job.

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Responses

204

No response body

delete

/api/v1/workspaces/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/workspaces/{id}/ HTTP/1.1
Host: /
Accept: */*

204

No response body

No content

post

Duplicates a workspace, including permissions

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Body

application/json

source_connectionone ofRequired

or

or

or

or

or

or

target_connectionone ofRequired

or

or

or

or

or

or

or

or

key_generation_methodany ofOptionalDefault: duplicate

string · enumOptionalPossible values:

or

nullOptional

default_localeany ofOptionalDefault: en

string · enumOptionalPossible values:

or

nullOptional

initialization_modeany ofOptionalDefault: DE_IDENTIFY

string · enumOptionalPossible values:

or

nullOptional

namestringRequired

Responses

200

Success: Created workspace

application/json

400

Failed

application/json

post

/api/v1/workspaces/{id}/duplicate/

HTTPcURLJavaScriptPython

POST /api/v1/workspaces/{id}/duplicate/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 1201

{
  "source_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1,
    "protocol": "text",
    "include_views": true
  },
  "target_connection": {
    "hooks_params": {
      "SSHTunnel": {
        "host": "text",
        "port": 1,
        "username": "text",
        "local_port": 1,
        "local_host": "text",
        "password": "text",
        "pkey_password": "text",
        "pkey": "text"
      },
      "SSL": {
        "ca_filename": "text",
        "cert_filename": "text",
        "key_filename": "text",
        "ssl_mode": "text",
        "ca": "text",
        "cert": "text",
        "key": "text"
      },
      "Kerberos": {
        "principal": "text",
        "keytab_file": "text"
      }
    },
    "is_source": true,
    "connector_type": "text",
    "host": "text",
    "database": "text",
    "username": "text",
    "password": "text",
    "schema_name": "text",
    "port": 1,
    "protocol": "text",
    "include_views": true
  },
  "key_generation_method": "duplicate",
  "default_locale": "en",
  "initialization_mode": "DE_IDENTIFY",
  "name": "text"
}

{
  "pk": 1,
  "name": "text",
  "organization": 1,
  "engine_id": "text",
  "owner_name": "text",
  "created_at": "2025-12-23T01:16:59.182Z",
  "status": "text",
  "engine": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "latest_job_status": "STARTED",
    "connector_type": "text",
    "source_database_status": "CURRENT"
  },
  "initialization_mode": "SYNTHESIZE",
  "key_generation_method": "duplicate",
  "default_locale": "en"
}

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Responses

200Success

application/json

get

/api/v1/workspaces/{id}/members/

HTTPcURLJavaScriptPython

GET /api/v1/workspaces/{id}/members/ HTTP/1.1
Host: /
Accept: */*

200Success

[
  {
    "pk": 1,
    "workspace": 1,
    "user": {
      "pk": 1,
      "first_name": "text",
      "last_name": "text",
      "full_name": "text",
      "email": "[email protected]"
    },
    "role": "OWNER",
    "data_access": true
  }
]