DQ0 REST API Reference - version 1.0

Rest API for the secure data to machine learning interface DQ0.

Start local server with dq0.io using dq0 server start. The server listens on port 9000 and communicates with dq0-main via current active dq0-proxy instance.

To start your local DQ0 API server, use the dq0.io (command line interface) application:

dq0 server start [--hostname] [--port]

By default, hostname is 127.0.0.1 and port 9000. Resulting default API endpoint would be:

http://127.0.0.1:9000/api/

Response Format

The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:

# error response will contain only error property
{
"error": "error message"
}

# message response will contain only message property
{
"message": "some message"
}

# single item response will contain only item itself
{
"id": "id1",
"prop": "value",
...
}

# list items response format looks like:
{
"total": 120,
"page": 3,
"page_size": 10,
"items": [
{
"id": "id1",
"prop": "value",
...
}
]
}

The status codes that are returned for each endpoint are specified in the endpoint documentation below.

Base URLs:

• http://localhost:9000/api

actions

ActionPermissionSetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/actions \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"action":"UserRegister","action_id":1,"permission":4,"role_id":1,"role_name":"admin"}'

GET /actions

Body parameter

{
  "action": "UserRegister",
  "action_id": 1,
  "permission": 4,
  "role_id": 1,
  "role_name": "admin"
}

Parameters

Name	In	Type	Required	Description
body	body	ActionPermissionSetRequestBody	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ActionPermissionSetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

artifacts

ArtifactDownloadRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/artifacts/download \
  --header 'Accept: application/json'

GET /artifacts/download

Downloads specific artifact from specific run

Parameters

Name	In	Type	Required	Description
run_uuid	query	string	false	UUID of run (=job uuid)
artifact_path	query	string	false	Path of artifact to download

Example responses

200 Response

{
  "data_path": "\"out_file.txt\"",
  "data_string": "[]"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ArtifactDownloadResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ArtifactTreeStructureRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/artifacts/tree_structure \
  --header 'Accept: application/json'

GET /artifacts/tree_structure

Returns hierarchical tree structure for specific run

Parameters

Name	In	Type	Required	Description
run_uuid	query	string	false	UUID of run (=job)
path	query	string	false	Optional path inside artifact directory
level	query	string	false	Level of depth to search the artifact directory, default 4

Example responses

200 Response

{
  "artifact_files": [
    {
      "children": [
        {}
      ],
      "file_size": "string",
      "header": "string",
      "is_dir": true,
      "label": "string",
      "path": "string"
    }
  ],
  "artifact_next_page_token": "string",
  "commit_name": "string",
  "commit_uuid": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "job_name": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "run_id": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ArtifactTreeStructureResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

audits

AuditListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/audits \
  --header 'Accept: application/json'

GET /audits

Lists all available audit log entries.

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page

Example responses

200 Response

{
  "items": [
    {
      "action": "auth.login",
      "actor": "user@dq0.io",
      "description": "user with email 'user@dq0.io' and device '78e1e9d4-cc8c-48da-a325-1c0f908cd9a5' logged in successfully",
      "timestamp": "1587463859"
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	AuditListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

auth

authLoginRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/auth/login \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"user@dq0.io","password":"@veryStrongPasswd1900"}'

POST /auth/login

Login user in quarantine through current proxy

Body parameter

{
  "email": "user@dq0.io",
  "password": "@veryStrongPasswd1900"
}

Parameters

Name	In	Type	Required	Description
body	body	AuthLoginRequestBody	true	none

Example responses

200 Response

{
  "token": "9a157ce8-fff2-481a-a58e-32d070f080f4"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	AuthLoginResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

authLogoutRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/auth/logout \
  --header 'Accept: application/json'

POST /auth/logout

Logout user in quarantine through current proxy

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	AuthLogoutResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

authRegisterRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/auth/register \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"user@dq0.io","password":"@veryStrongPasswd1900"}'

POST /auth/register

Register user in activated proxy

Body parameter

{
  "email": "user@dq0.io",
  "password": "@veryStrongPasswd1900"
}

Parameters

Name	In	Type	Required	Description
body	body	AuthRegisterRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	AuthRegisterResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

authSessionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/auth/session \
  --header 'Accept: application/json'

GET /auth/session

Get current activated proxy session

Example responses

200 Response

{
  "token": "9a157ce8-fff2-481a-a58e-32d070f080f4"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	AuthSessionResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

commits

CommitListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/commits \
  --header 'Accept: application/json'

GET /commits

Lists all available commits.

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
order_by	query	string	false	Set 'order_by' to sort list items
user_id	query	integer(int64)	false	User id to filter list for
project_uuid	query	string	false	UUID of project

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "data_name": "string",
      "data_uuid": "string",
      "latest_experiment_name": "string",
      "latest_experiment_result": "string",
      "latest_experiment_uuid": "string",
      "model_checker_status": "string",
      "model_name": "string",
      "model_uuid": "string",
      "predict_allowed": true,
      "predict_proba_allowed": true,
      "project_name": "string",
      "project_uuid": "string",
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	CommitListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

CommitInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/commits/ \
  --header 'Accept: application/json'

GET /commits/{commit_uuid}

Get information for specific commit

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	CommitInfoResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

CommitContentRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/commits/string/content \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"local_only":true,"project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /commits/{commit_uuid}/content

Get information for specific commit

Body parameter

{
  "local_only": true,
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

Name	In	Type	Required	Description
commit_uuid	path	string	true	UUID of commit
body	body	CommitContentRequestBody	true	none

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	CommitContentResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

CommitRunRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/commits/string/run \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"args":{"property1":"string","property2":"string"},"ml_project_entry_point":"train","project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /commits/{commit_uuid}/run

Run specific commit with passed user arguments

Body parameter

{
  "args": {
    "property1": "string",
    "property2": "string"
  },
  "ml_project_entry_point": "train",
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

Name	In	Type	Required	Description
commit_uuid	path	string	true	UUID of commit
body	body	CommitRunRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	CommitRunResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

CommitTransformRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/commits//transform \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /commits/{commit_uuid}/transform

Start data transform for specific commit

Body parameter

{
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of commit
body	body	CommitTransformRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	CommitTransformResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

data

DataListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/data \
  --header 'Accept: application/json'

GET /data

Lists all available datasets.

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
order_by	query	string	false	Set 'order_by' to sort list items
user_id	query	integer(int64)	false	User id to filter list for
project_uuid	query	string	false	UUID of project
commit_uuid	query	string	false	UUID of commit

Example responses

200 Response

{
  "items": "'[{\"id\":1,\"uuid\":\"78fbda3a-6530-45ba-83b0-fe2d7dda899d\",\"name\":\"source 1\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\",\"sample\"],\"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source1.csv\",\"size\":4,\"mean\":\"(-23.538887188473396, 4.5820969395656865, 10.53646357964901, 7.1721683055053)\",\"std\":\"(8.79595482855613, 15.038949447047374, 15.76694875021541, 55.907788290107405)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"2020-03-24 08:50:57.175\",\"updated_at\":\"2020-04-06 07:05:05.079\"},{\"id\":2,\"uuid\":\"a87e55d0-aa7c-41c8-9147-1f69b16accc2\",\"name\":\"source 2\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\"],\"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source2.csv\",\"size\":5,\"mean\":\"(-64.64820261903593, 45.56088456347706, 44.27540826516029, 0.8988506631702773, -43.96628296178475)\",\"std\":\"(38.296517680818894, 18.843032606250475, 30.83218542407734, 39.104564678591636, 62.714621754899326)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"2020-03-24 08:50:57.176\",\"updated_at\":\"2020-04-06 07:05:05.08\"},{\"id\":3,\"uuid\":\"1d3c0ed7-a092-4ce6-b947-55a376dc312b\",\"name\":\"source 3\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\"],\"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source3.csv\",\"size\":5323669,\"mean\":\"(0.2964112953231287, 0.12005084567531446, 0.6048137927357801, 0.014094863934083933, 0.02116986459954208, 0.40440611493306095, 0.029147126455147773, 0.0650217121756085, 0.00026026997636017146, 0.016913810102030358, 0.0019003011109808422, 0.0005982953058642256, 0.23932725135030042)\",\"std\":\"(0.18807155928503272, 0.07656611702507954, 0.1709745075446674, 0.06317847401767661, 0.09497729877421364, 0.12309145556565027, 0.17006894010079007, 0.24460727006477984, 0.009326928792466644, 0.4608292162296523, 0.17959469088151425, 0.26998778640743437, 0.19910365111781858)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"2020-03-26 08:28:01.871\",\"updated_at\":\"2020-04-06 07:05:05.08\"}]'",
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	DataListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

DataCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/data \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"meta":"string"}'

POST /data

Creates new dataset

Body parameter

{
  "meta": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	DataCreateRequestBody	true	none

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "data_description": "string",
  "data_mean": "string",
  "data_name": "string",
  "data_permissions": [
    "string"
  ],
  "data_sample": "string",
  "data_size": 0,
  "data_stats": "string",
  "data_std": "string",
  "data_type": "string",
  "data_usage": 0,
  "data_uuid": "string",
  "privacy_budget": 0,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	DataCreateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

DataDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/data/ \
  --header 'Accept: application/json'

DELETE /data/{data_uuid}

Deletes specific data

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "data_description": "string",
  "data_mean": "string",
  "data_name": "string",
  "data_permissions": [
    "string"
  ],
  "data_sample": "string",
  "data_size": 0,
  "data_stats": "string",
  "data_std": "string",
  "data_type": "string",
  "data_usage": 0,
  "data_uuid": "string",
  "privacy_budget": 0,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	DataDeleteResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

DataGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/data/ \
  --header 'Accept: application/json'

GET /data/{data_uuid}

Get information for specific dataset

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "data_description": "string",
  "data_mean": "string",
  "data_name": "string",
  "data_permissions": [
    "string"
  ],
  "data_sample": "string",
  "data_size": 0,
  "data_stats": "string",
  "data_std": "string",
  "data_type": "string",
  "data_usage": 0,
  "data_uuid": "string",
  "privacy_budget": 0,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	DataGetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

DataPatchRequest

Code samples

curl --request PATCH \
  --url http://localhost:9000/api/data/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"meta":"string"}'

PATCH /data/{data_uuid}

Update a specific dataset

Body parameter

{
  "meta": "string"
}

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of dataset
body	body	DataPatchRequestBody	true	none

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "data_description": "string",
  "data_mean": "string",
  "data_name": "string",
  "data_permissions": [
    "string"
  ],
  "data_sample": "string",
  "data_size": 0,
  "data_stats": "string",
  "data_std": "string",
  "data_type": "string",
  "data_usage": 0,
  "data_uuid": "string",
  "privacy_budget": 0,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	DataPatchResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

DataPermissionSetRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/data//permissions \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_id":1,"data_name":"census","data_uuid":"string","permission":4,"role_id":1,"role_name":"admins"}'

POST /data/{data_uuid}/permissions

Set permission for specific dataset

Body parameter

{
  "data_id": 1,
  "data_name": "census",
  "data_uuid": "string",
  "permission": 4,
  "role_id": 1,
  "role_name": "admins"
}

Parameters

Name	In	Type	Required	Description
body	body	DataPermissionSetRequestBody	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	DataPermissionSetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

DataGetSampleRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/data//sample \
  --header 'Accept: application/json'

GET /data/{data_uuid}/sample

Get sample data for specific dataset

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of dataset

Example responses

200 Response

{
  "name": "census",
  "sample": "[{\"lastname\":\"Lastname282\",\"firstname\":\"Firstname928\",\"age\":24,\"workclass\":\"Private\",\"fnlwgt\":157177,\"education\":\"Masters\",\"education-num\":14,\"marital-status\":\"Married-civ-spouse\",\"occupation\":\"Prof-specialty\",\"relationship\":\"Husband\",\"race\":\"White\",\"sex\":\"Male\",\"capital-gain\":0,\"capital-loss\":0,\"hours-per-week\":50,\"native-country\":\"United-States\",\"income\":\"<=50K\"}]",
  "type": "csv",
  "uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	DataSampleResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

device

DeviceVersionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/device/version \
  --header 'Accept: application/json'

GET /device/version

Get version information from current device

Example responses

200 Response

{
  "api_version": "1.2.6",
  "architecture": "amd64",
  "built": "2020-05-28T09:55:02Z",
  "cli_version": "1.1.0",
  "os": "darwin"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	DeviceVersionResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

experiments

ExperimentListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/experiments \
  --header 'Accept: application/json'

GET /experiments

Lists all available experiments.

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
order_by	query	string	false	Set 'order_by' to sort list items
user_id	query	integer(int64)	false	User id to filter list for
project_uuid	query	string	false	UUID of project

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "data_name": "string",
      "data_uuid": "string",
      "latest_experiment_name": "string",
      "latest_experiment_result": "string",
      "latest_experiment_uuid": "string",
      "model_checker_status": "string",
      "model_name": "string",
      "model_uuid": "string",
      "predict_allowed": true,
      "predict_proba_allowed": true,
      "project_name": "string",
      "project_uuid": "string",
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ExperimentListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ExperimentCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/experiments \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"experiment_name":"My Cool Experiment 42"}'

POST /experiments

Creates new experiment

Body parameter

{
  "experiment_name": "My Cool Experiment 42"
}

Parameters

Name	In	Type	Required	Description
project_uuid	query	string	false	UUID of project
body	body	ExperimentCreateRequestBody	true	none

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ExperimentCreateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ExperimentDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/experiments/ \
  --header 'Accept: application/json'

DELETE /experiments/{experiment_uuid}

Deletes specific experiment

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ExperimentDeleteResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ExperimentInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/experiments/ \
  --header 'Accept: application/json'

GET /experiments/{experiment_uuid}

Get information for specific experiment

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ExperimentInfoResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ExperimentUpdateRequest

Code samples

curl --request PATCH \
  --url http://localhost:9000/api/experiments/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"experiment_name":"My Cool Experiment 42"}'

PATCH /experiments/{experiment_uuid}

Updates specific experiment

Body parameter

{
  "experiment_name": "My Cool Experiment 42"
}

Parameters

Name	In	Type	Required	Description
body	body	ExperimentUpdateRequestBody	true	none

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ExperimentUpdateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ExperimentRestoreRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/experiments//restore \
  --header 'Accept: application/json'

POST /experiments/{experiment_uuid}/restore

Return information for specific experiment

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ExperimentRestoreResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

groups

GroupRemoveRoleRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/groups \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"group_id":1,"group_name":"owners","role_id":4,"role_name":"owners"}'

GET /groups

RemoveRoles all available groups

Body parameter

{
  "group_id": 1,
  "group_name": "owners",
  "role_id": 4,
  "role_name": "owners"
}

Parameters

Name	In	Type	Required	Description
body	body	GroupRemoveRoleRequestBody	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	GroupRemoveRoleResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

GroupCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/groups \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"group_name":"Admin, User"}'

POST /groups

Creates new Group

Body parameter

{
  "group_name": "Admin, User"
}

Parameters

Name	In	Type	Required	Description
body	body	GroupCreateRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	GroupCreateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

GroupDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/groups/string \
  --header 'Accept: application/json'

DELETE /groups/{group_id}

Remove specific group instance from list

Parameters

Name	In	Type	Required	Description
group_id	path	string	true	ID of Group

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	GroupDeleteResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

GroupGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/groups/string \
  --header 'Accept: application/json'

GET /groups/{group_id}

Get detail information for specific group

Parameters

Name	In	Type	Required	Description
group_id	path	string	true	ID of Group

Example responses

200 Response

{
  "created_at": 0,
  "group_id": 0,
  "group_name": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	GroupGetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

GroupPatchRequest

Code samples

curl --request PATCH \
  --url 'http://localhost:9000/api/groups/0?group_id=0' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"group_name":"MyGroup"}'

PATCH /groups/{group_id}

Update a specific group

Body parameter

{
  "group_name": "MyGroup"
}

Parameters

Name	In	Type	Required	Description
group_id	query	integer(int64)	true	ID of Group
body	body	GroupPatchRequestBody	true	none

Example responses

200 Response

{
  "created_at": 0,
  "group_id": 0,
  "group_name": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	GroupPatchResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

jobs

JobListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/jobs \
  --header 'Accept: application/json'

GET /jobs

Lists all available jobs.

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
order_by	query	string	false	Set 'order_by' to sort list items
user_id	query	integer(int64)	false	User id to filter list for
project_uuid	query	string	false	UUID of project
commit_uuid	query	string	false	UUID of commit
job_type	query	string	false	Type of job
job_params	query	string	false	Params of job

Example responses

200 Response

{
  "items": [],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	JobListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

JobInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/jobs/ \
  --header 'Accept: application/json'

GET /jobs/{job_uuid}

Get information for specific job

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "job_errors": "string",
  "job_logs": "string",
  "job_name": "string",
  "job_params": "string",
  "job_progress": 0,
  "job_results": "string",
  "job_state": "string",
  "job_type": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	JobInfoResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

JobCancelRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/jobs/string/cancel \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"force":false,"job_uuid":"79ef8712-f3ed-4494-bb34-aa44fe0f000a"}'

POST /jobs/{job_uuid}/cancel

Cancel a running job

Body parameter

{
  "force": false,
  "job_uuid": "79ef8712-f3ed-4494-bb34-aa44fe0f000a"
}

Parameters

Name	In	Type	Required	Description
job_uuid	path	string	true	UUID of job
body	body	JobCancelRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	JobCancelResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

models

ModelListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/models \
  --header 'Accept: application/json'

GET /models

Lists all available models.

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
order_by	query	string	false	Set 'order_by' to sort list items
user_id	query	integer(int64)	false	User id to filter list for
project_uuid	query	string	false	UUID of project
commit_uuid	query	string	false	UUID of commit

Example responses

200 Response

{
  "items": [
    {
      "commit_name": "string",
      "commit_uuid": "string",
      "description": "string",
      "experiment_name": "string",
      "experiment_uuid": "string",
      "location": "string",
      "model_name": "string",
      "model_uuid": "string",
      "permissions": [
        "string"
      ],
      "project_name": "string",
      "project_uuid": "string",
      "user_id": 0,
      "user_name": "string"
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ModelListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ModelInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/models/ \
  --header 'Accept: application/json'

GET /models/{model_uuid}

Get detail information for specific model

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "description": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "location": "string",
  "model_name": "string",
  "model_uuid": "string",
  "permissions": [
    "string"
  ],
  "project_name": "string",
  "project_uuid": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ModelInfoResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ModelPatchRequest

Code samples

curl --request PATCH \
  --url http://localhost:9000/api/models/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"model_description":"\"Model with trained stuff that is crazy\"","model_name":"\"myModel123\"","permissions":"['\''predict_allowed'\'', '\''predict_proba_allowed'\'']"}'

PATCH /models/{model_uuid}

Update a specific model

Body parameter

{
  "model_description": "\"Model with trained stuff that is crazy\"",
  "model_name": "\"myModel123\"",
  "permissions": "['predict_allowed', 'predict_proba_allowed']"
}

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of model
body	body	ModelPatchRequestBody	true	none

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "description": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "location": "string",
  "model_name": "string",
  "model_uuid": "string",
  "permissions": [
    "string"
  ],
  "project_name": "string",
  "project_uuid": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ModelPatchResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ModelContentRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/models/string/content \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}'

POST /models/{model_uuid}/content

Get information for specific model

Body parameter

{}

Parameters

Name	In	Type	Required	Description
model_uuid	path	string	true	UUID of model
body	body	ModelContentRequestBody	true	none

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "description": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "location": "string",
  "model_name": "string",
  "model_uuid": "string",
  "permissions": [
    "string"
  ],
  "project_name": "string",
  "project_uuid": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ModelContentResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ModelPredictRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/models//predict \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"input_data":"{a:1, b:2}","input_type":"json"}'

POST /models/{model_uuid}/predict

Predicting specific model with custom input data

Body parameter

{
  "input_data": "{a:1, b:2}",
  "input_type": "json"
}

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of model
body	body	ModelPredictRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ModelPredictResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ModelRegisterRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/models/register \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"model_path":"\"myfolder/model.h5\"","run_uuid":"string"}'

POST /models/register

Register specific model to dq0 quarantine

Body parameter

{
  "model_path": "\"myfolder/model.h5\"",
  "run_uuid": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ModelRegisterRequestBody	true	none

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "description": "string",
  "experiment_name": "string",
  "experiment_uuid": "string",
  "location": "string",
  "model_name": "string",
  "model_uuid": "string",
  "permissions": [
    "string"
  ],
  "project_name": "string",
  "project_uuid": "string",
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ModelRegisterResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ModelUnregisterRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/models/unregister \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"model_uuid":"string"}'

POST /models/unregister

Unregister specific model to dq0 quarantine

Body parameter

{
  "model_uuid": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ModelUnregisterRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ModelUnregisterResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

privacy

PrivacyBudgetListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/privacy/budgets \
  --header 'Accept: application/json'

GET /privacy/budgets

Lists all available PrivacyBudgets

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
data_id	query	integer(int64)	false	none

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "current": 0,
      "data_id": 0,
      "data_name": "string",
      "initial": 0,
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	PrivacyBudgetListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

PrivacyBudgetSetPermissionRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/privacy/budgets \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"current":1000,"data_id":1,"data_name":"owners"}'

POST /privacy/budgets

SetPrivacyBudget for data

Body parameter

{
  "current": 1000,
  "data_id": 1,
  "data_name": "owners"
}

Parameters

Name	In	Type	Required	Description
body	body	PrivacyBudgetPermissionSetRequestBody	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	PrivacyBudgetPermissionSetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

PrivacyMaskListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/privacy/masks \
  --header 'Accept: application/json'

GET /privacy/masks

Lists all available PrivacyMasks

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
data_id	query	integer(int64)	false	none

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "data_id": 0,
      "data_name": "string",
      "hidden": "string",
      "private": "string",
      "public": "string",
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	PrivacyMaskListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

PrivacyMaskSetPermissionRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/privacy/masks \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_id":1,"data_name":"owners","mask_data":{},"user_email":"1","user_id":1}'

POST /privacy/masks

SetPrivacyMask for data

Body parameter

{
  "data_id": 1,
  "data_name": "owners",
  "mask_data": {},
  "user_email": "1",
  "user_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	PrivacyMaskPermissionSetRequestBody	true	none

Example responses

default Response

{
  "error": "invalid parameters provided"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	None
default	Default	GenericErrorResponse contains a 'error' field only	Error

PrivacyThresholdListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/privacy/thresholds \
  --header 'Accept: application/json'

GET /privacy/thresholds

Lists all available PrivacyThresholds

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
data_id	query	integer(int64)	false	none

Example responses

200 Response

{
  "items": [
    {
      "created_at": 0,
      "data_id": 0,
      "data_name": "string",
      "field": "string",
      "threshold": 0,
      "updated_at": 0
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	PrivacyThresholdListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

PrivacyThresholdSetPermissionRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/privacy/thresholds \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_id":1,"data_name":"owners","field":"households","threshold":75,"user_email":"1","user_id":1}'

POST /privacy/thresholds

SetPrivacyThreshold for data

Body parameter

{
  "data_id": 1,
  "data_name": "owners",
  "field": "households",
  "threshold": 75,
  "user_email": "1",
  "user_id": 1
}

Parameters

Name	In	Type	Required	Description
body	body	PrivacyThresholdPermissionSetRequestBody	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	PrivacyThresholdPermissionSetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

projects

ProjectSetPermissionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/projects \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"permission":4,"project_id":1,"project_name":"Project1","project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2","role_id":1,"role_name":"owners"}'

GET /projects

SetPermissions all available projects

Body parameter

{
  "permission": 4,
  "project_id": 1,
  "project_name": "Project1",
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2",
  "role_id": 1,
  "role_name": "owners"
}

Parameters

Name	In	Type	Required	Description
body	body	ProjectSetPermissionRequestBody	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProjectSetPermissionResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProjectCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"name":"MyProject","working_dir":"/path/to/my/workingDir"}'

POST /projects

Creates new project

Body parameter

{
  "name": "MyProject",
  "working_dir": "/path/to/my/workingDir"
}

Parameters

Name	In	Type	Required	Description
body	body	ProjectCreateRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProjectCreateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProjectUnlinkRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/projects/ \
  --header 'Accept: application/json'

DELETE /projects/{project_uuid}

Removes specific project from local project list (does not actually delete the project files)

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of project

Example responses

default Response

{
  "error": "invalid parameters provided"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	None
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProjectInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/projects/ \
  --header 'Accept: application/json'

GET /projects/{project_uuid}

Get information for specific project

Example responses

200 Response

{
  "created_at": 0,
  "data_name": "string",
  "data_uuid": "string",
  "latest_experiment_name": "string",
  "latest_experiment_result": "string",
  "latest_experiment_uuid": "string",
  "model_checker_status": "string",
  "model_name": "string",
  "model_uuid": "string",
  "predict_allowed": true,
  "predict_proba_allowed": true,
  "project_name": "string",
  "project_uuid": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProjectInfoResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProjectDeployRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects//deploy \
  --header 'Accept: application/json'

POST /projects/{project_uuid}/deploy

Deploys specific projects to dq0 quarantine

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of project

Example responses

default Response

{
  "error": "invalid parameters provided"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	None
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProjectDetachRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects//detach \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_name":"census","data_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /projects/{project_uuid}/detach

Detach dataset to specific project

Body parameter

{
  "data_name": "census",
  "data_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of project
body	body	ProjectDetachRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProjectDetachResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProjectSetExperimentNameRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects//set-experiment-name \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"experiment_name":"My Cool Experiment 42"}'

POST /projects/{project_uuid}/set-experiment-name

Sets the experiment name for specific project uuid

Body parameter

{
  "experiment_name": "My Cool Experiment 42"
}

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of project
body	body	ProjectSetExperimentNameRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProjectSetExperimentNameResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProjectAttachRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/projects/string/attach \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"data_name":"census","data_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /projects/{uuid}/attach

Attach dataset to specific project

Body parameter

{
  "data_name": "census",
  "data_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of project
body	body	ProjectAttachRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProjectAttachResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

proxies

ProxyListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/proxies \
  --header 'Accept: application/json'

GET /proxies

Lists all available proxy instances

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page

Example responses

200 Response

{
  "items": [
    {
      "active": true,
      "email_address": "string",
      "hostname": "string",
      "port": 0,
      "public_key": "string",
      "request_uri": "string",
      "scheme": "string",
      "session_key": "string"
    }
  ],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProxyListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProxyCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/proxies \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"hostname":"string","port":0,"request_uri":"string","scheme":"string"}'

POST /proxies

Adds new proxy entry

Body parameter

{
  "hostname": "string",
  "port": 0,
  "request_uri": "string",
  "scheme": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	ProxyCreateRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Proxy Create response struct	ProxyCreateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProxyDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/proxies/string \
  --header 'Accept: application/json'

DELETE /proxies/{id}

Remove specific proxy instance from list

Parameters

Name	In	Type	Required	Description
id	path	string	true	ID of proxy

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProxyDeleteResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProxyGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/proxies/string \
  --header 'Accept: application/json'

GET /proxies/{id}

Get detail information for specific proxy

Parameters

Name	In	Type	Required	Description
id	path	string	true	ID of proxy

Example responses

200 Response

{
  "active": true,
  "email_address": "string",
  "hostname": "string",
  "port": 0,
  "public_key": "string",
  "request_uri": "string",
  "scheme": "string",
  "session_key": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProxyGetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProxyActivateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/proxies/string/activate \
  --header 'Accept: application/json'

POST /proxies/{id}/activate

Activate existing proxy by id

Parameters

Name	In	Type	Required	Description
id	path	string	true	ID of proxy

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProxyActivateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

ProxiesCurrentRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/proxies/current \
  --header 'Accept: application/json'

GET /proxies/current

Get current activated proxy instance

Example responses

200 Response

{
  "active": true,
  "email_address": "string",
  "hostname": "string",
  "port": 0,
  "public_key": "string",
  "request_uri": "string",
  "scheme": "string",
  "session_key": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	ProxyCurrentResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

queries

QueryListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/queries \
  --header 'Accept: application/json'

GET /queries

Lists all available queries.

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
order_by	query	string	false	Set 'order_by' to sort list items
user_id	query	integer(int64)	false	User id to filter list for

Example responses

200 Response

{
  "items": [],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	QueryListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

QueryCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/queries \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"datasets":"\"data_source1,data2\"","epsilon":1,"params":"p1=123","permissions":"households<75","private_column":"\"user_id\"","query":"SELECT COUNT(*) FROM table;","tau":100}'

POST /queries

Creates new query request

Body parameter

{
  "datasets": "\"data_source1,data2\"",
  "epsilon": 1,
  "params": "p1=123",
  "permissions": "households<75",
  "private_column": "\"user_id\"",
  "query": "SELECT COUNT(*) FROM table;",
  "tau": 100
}

Parameters

Name	In	Type	Required	Description
body	body	QueryCreateRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	QueryCreateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

QueryInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/queries/ \
  --header 'Accept: application/json'

GET /queries/{query_uuid}

Get information for specific query

Parameters

Name	In	Type	Required	Description
include_run	query	boolean	false	Set to include run meta information for this query
include_result	query	boolean	false	Set to include results for this query

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "experiment_name": "string",
  "experiment_uuid": "string",
  "job_errors": "string",
  "job_logs": "string",
  "job_name": "string",
  "job_params": "string",
  "job_progress": 0,
  "job_results": "string",
  "job_state": "string",
  "job_type": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "query_datasets": {
    "property1": "string",
    "property2": "string"
  },
  "query_result_data": "string",
  "query_result_message": "string",
  "query_statement": "string",
  "run_end_time": 0,
  "run_metrics": [
    {
      "key": "string",
      "step": "string",
      "timestamp": "string",
      "value": 0
    }
  ],
  "run_params": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_stage": "string",
  "run_start_time": 0,
  "run_status": "string",
  "run_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	QueryInfoResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

QueryCancelRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/queries//cancel \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"force":false,"query_uuid":"79ef8712-f3ed-4494-bb34-aa44fe0f000a"}'

POST /queries/{query_uuid}/cancel

Cancel a ongoing query

Body parameter

{
  "force": false,
  "query_uuid": "79ef8712-f3ed-4494-bb34-aa44fe0f000a"
}

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	UUID of query
body	body	QueryCancelRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	QueryCancelResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

roles

RoleSetPermissionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/roles \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"permission":4,"role_id":1,"role_name":"owners"}'

GET /roles

SetPermissions all available roles

Body parameter

{
  "permission": 4,
  "role_id": 1,
  "role_name": "owners"
}

Parameters

Name	In	Type	Required	Description
body	body	RoleSetPermissionRequestBody	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RoleSetPermissionResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RoleCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/roles \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"role_name":"Admin, User"}'

POST /roles

Creates new role

Body parameter

{
  "role_name": "Admin, User"
}

Parameters

Name	In	Type	Required	Description
body	body	RoleCreateRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RoleCreateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RoleDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/roles/string \
  --header 'Accept: application/json'

DELETE /roles/{role_id}

Remove specific role instance by id

Parameters

Name	In	Type	Required	Description
role_id	path	string	true	ID of Role

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RoleDeleteResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RoleGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/roles/string \
  --header 'Accept: application/json'

GET /roles/{role_id}

Get detail information for specific Role

Parameters

Name	In	Type	Required	Description
role_id	path	string	true	ID of Role

Example responses

200 Response

{
  "created_at": 0,
  "role_id": 0,
  "role_name": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RoleGetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RolePatchRequest

Code samples

curl --request PATCH \
  --url 'http://localhost:9000/api/roles/0?role_id=0' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"role_name":"MyRole"}'

PATCH /roles/{role_id}

Update a specific Role

Body parameter

{
  "role_name": "MyRole"
}

Parameters

Name	In	Type	Required	Description
role_id	query	integer(int64)	true	ID of Role
body	body	RolePatchRequestBody	true	none

Example responses

200 Response

{
  "created_at": 0,
  "role_id": 0,
  "role_name": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RolePatchResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

runs

RunListRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/runs \
  --header 'Accept: application/json'

GET /runs

Lists all available runs

Parameters

Name	In	Type	Required	Description
page	query	integer(int64)	false	Set 'page' to page through the results list
page_size	query	integer(int64)	false	Set 'page-size' to set the number of result items per page
order_by	query	string	false	Set 'order_by' to sort list items
user_id	query	integer(int64)	false	User id to filter list for
project_uuid	query	string	false	UUID of project
commit_uuid	query	string	false	UUID of commit (filter by this uuid only)
experiment_uuid	query	string	false	UUID of experiment (filter by this uuid only)

Example responses

200 Response

{
  "items": [],
  "page": 3,
  "page_size": 100,
  "total": 552
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RunListResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RunCreateRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/runs \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"args":{"property1":"string","property2":"string"},"commit_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2","ml_project_entry_point":"train","project_uuid":"6af92043-33db-4c27-8b38-e8733f4713c2"}'

POST /runs

Creates new run

Body parameter

{
  "args": {
    "property1": "string",
    "property2": "string"
  },
  "commit_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2",
  "ml_project_entry_point": "train",
  "project_uuid": "6af92043-33db-4c27-8b38-e8733f4713c2"
}

Parameters

Name	In	Type	Required	Description
body	body	RunCreateRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RunCreateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RunDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/runs/ \
  --header 'Accept: application/json'

DELETE /runs/{run_uuid}

Return information for specific run

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RunDeleteResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RunInfoRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/runs/ \
  --header 'Accept: application/json'

GET /runs/{run_uuid}

Get information for specific run

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "experiment_name": "string",
  "experiment_uuid": "string",
  "job_errors": "string",
  "job_logs": "string",
  "job_name": "string",
  "job_params": "string",
  "job_progress": 0,
  "job_results": "string",
  "job_state": "string",
  "job_type": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "run_end_time": 0,
  "run_metrics": [
    {
      "key": "string",
      "step": "string",
      "timestamp": "string",
      "value": 0
    }
  ],
  "run_params": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_stage": "string",
  "run_start_time": 0,
  "run_status": "string",
  "run_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RunInfoResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RunGetMetricHistoryRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/runs//metric_history \
  --header 'Accept: application/json'

GET /runs/{run_uuid}/metric_history

Get metric history values from specific run

Parameters

Name	In	Type	Required	Description
metric_key	query	string	false	Metric Key

Example responses

200 Response

{
  "commit_name": "string",
  "commit_uuid": "string",
  "created_at": 0,
  "experiment_name": "string",
  "experiment_uuid": "string",
  "job_errors": "string",
  "job_logs": "string",
  "job_name": "string",
  "job_params": "string",
  "job_progress": 0,
  "job_results": "string",
  "job_state": "string",
  "job_type": "string",
  "job_uuid": "string",
  "project_name": "string",
  "project_uuid": "string",
  "run_end_time": 0,
  "run_metrics": [
    {
      "key": "string",
      "step": "string",
      "timestamp": "string",
      "value": 0
    }
  ],
  "run_params": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_stage": "string",
  "run_start_time": 0,
  "run_status": "string",
  "run_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "run_uuid": "string",
  "updated_at": 0,
  "user_id": 0,
  "user_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RunGetMetricHistoryResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

RunRestoreRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/runs//restore \
  --header 'Accept: application/json'

POST /runs/{run_uuid}/restore

Restores specific run

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	RunRestoreResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

users

UserDeleteRequest

Code samples

curl --request DELETE \
  --url http://localhost:9000/api/user/ \
  --header 'Accept: application/json'

DELETE /user/{id}

Remove specific User instance from list

Parameters

Name	In	Type	Required	Description
user_id	path	string	true	ID of User

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserDeleteResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserRemoveRoleRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"role_id":4,"role_name":"owners","user_email":"owners","user_id":1,"user_name":"owners"}'

GET /users

RemoveRoles all available users

Body parameter

{
  "role_id": 4,
  "role_name": "owners",
  "user_email": "owners",
  "user_id": 1,
  "user_name": "owners"
}

Parameters

Name	In	Type	Required	Description
body	body	UserRemoveRoleRequestBody	true	none

Example responses

200 Response

{}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserRemoveRoleResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users/string \
  --header 'Accept: application/json'

GET /users/{user_id}

Get detail information for specific user

Parameters

Name	In	Type	Required	Description
user_id	path	string	true	ID of user

Example responses

200 Response

{
  "avatar": "string",
  "company": "string",
  "location": "string",
  "name": "string",
  "public_email": "string",
  "user_id": 0,
  "website": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserGetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserUpdateRequest

Code samples

curl --request PATCH \
  --url http://localhost:9000/api/users/0 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"roles":[0],"state":"string"}'

PATCH /users/{user_id}

Update a specific user

Body parameter

{
  "roles": [
    0
  ],
  "state": "string"
}

Parameters

Name	In	Type	Required	Description
user_id	path	integer(int64)	true	UserID of user
body	body	UserUpdateRequestBody	true	none

Example responses

200 Response

{
  "created_at": 0,
  "email": "string",
  "id": 0,
  "password": "string",
  "role": 0,
  "role_name": "string",
  "state": "string",
  "updated_at": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserUpdateResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserLoginRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/users/login \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"user@dq0.io","password":"@veryStrongPasswd1900"}'

POST /users/login

Login user in quarantine through current proxy

Body parameter

{
  "email": "user@dq0.io",
  "password": "@veryStrongPasswd1900"
}

Parameters

Name	In	Type	Required	Description
body	body	UserLoginRequestBody	true	none

Example responses

200 Response

{
  "token": "9a157ce8-fff2-481a-a58e-32d070f080f4"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserLoginResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserLogoutRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/users/logout \
  --header 'Accept: application/json'

POST /users/logout

Logout user in quarantine through current proxy

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserLogoutResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserProfileCurrentRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users/profile \
  --header 'Accept: application/json'

GET /users/profile

Get detail profile information for current user

Example responses

200 Response

{
  "avatar": "string",
  "company": "string",
  "location": "string",
  "name": "string",
  "public_email": "string",
  "user_id": 0,
  "website": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserGetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserProfileGetRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users/profile/ \
  --header 'Accept: application/json'

GET /users/profile/{user_id}

Get detail profile information for specific user

Example responses

200 Response

{
  "avatar": "string",
  "company": "string",
  "location": "string",
  "name": "string",
  "public_email": "string",
  "user_id": 0,
  "website": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserGetResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserRegisterRequest

Code samples

curl --request POST \
  --url http://localhost:9000/api/users/register \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"email":"user@dq0.io","password":"@veryStrongPasswd1900"}'

POST /users/register

Register user in activated proxy

Body parameter

{
  "email": "user@dq0.io",
  "password": "@veryStrongPasswd1900"
}

Parameters

Name	In	Type	Required	Description
body	body	UserRegisterRequestBody	true	none

Example responses

200 Response

{
  "message": "succesfully started training ..."
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserRegisterResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

UserSessionRequest

Code samples

curl --request GET \
  --url http://localhost:9000/api/users/session \
  --header 'Accept: application/json'

GET /users/session

Get current activated proxy session

Example responses

200 Response

{
  "token": "9a157ce8-fff2-481a-a58e-32d070f080f4"
}

Responses

Status	Meaning	Description	Schema
200	OK	Response structure	UserSessionResponseBody
default	Default	GenericErrorResponse contains a 'error' field only	Error

Schemas

ActionItem

action_id: 0
action_name: string
action_next_page_token: string

Properties

Name	Type	Required	Restrictions	Description
action_id	integer(int64)	false	none	none
action_name	string	false	none	none
action_next_page_token	string	false	none	none

ActionListResponseBody

items: []
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[ActionItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

ActionPermissionSetRequestBody

action: UserRegister
action_id: 1
permission: 4
role_id: 1
role_name: admin

Properties

Name	Type	Required	Restrictions	Description
action	string	false	none	Action Name
action_id	integer(int64)	false	none	Action ID
permission	integer(int64)	false	none	PermissionLevel
role_id	integer(int64)	false	none	Role ID
role_name	string	false	none	Role Name

ActionPermissionSetResponseBody

{}

Properties

None

ArtifactDownloadResponseBody

data_path: '"out_file.txt"'
data_string: "[]"

Properties

Name	Type	Required	Restrictions	Description
data_path	string	true	none	Path to this artifact
data_string	string	true	none	Data as string

ArtifactFile

children:
  - children: []
    file_size: string
    header: string
    is_dir: true
    label: string
    path: string
file_size: string
header: string
is_dir: true
label: string
path: string

ArtifactFile struct

Properties

Name	Type	Required	Restrictions	Description
children	[ArtifactFile]	false	none	[ArtifactFile struct]
file_size	string	false	none	none
header	string	false	none	none
is_dir	boolean	false	none	none
label	string	false	none	none
path	string	false	none	none

ArtifactTreeStructureResponseBody

artifact_files:
  - children:
      - {}
    file_size: string
    header: string
    is_dir: true
    label: string
    path: string
artifact_next_page_token: string
commit_name: string
commit_uuid: string
experiment_name: string
experiment_uuid: string
job_name: string
job_uuid: string
project_name: string
project_uuid: string
run_id: string
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
artifact_files	[ArtifactFile]	false	none	[ArtifactFile struct]
artifact_next_page_token	string	false	none	none
commit_name	string	false	none	none
commit_uuid	string	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	none
job_name	string	false	none	none
job_uuid	string	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
run_id	string	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

AuditListItem

action: '"model.deploy"'
actor: '"user@dq0.io" or "system"'
description: "\"model with uuid 'c4a790eb-104f-48bf-97b3-ba5d5ffa8d95' and
  version 'da0a84e9-29f9-4cf3-a0a2-54aa39c82c64' deployed\""
timestamp: '"1589786433"'

Properties

Name	Type	Required	Restrictions	Description
action	string	false	none	Action identifier: type of event
actor	string	false	none	Email / Identifier of the actor (creator of an audit entry)
description	string	false	none	Audit description
timestamp	string	false	none	Unix timestamp in seconds

AuditListResponseBody

items:
  - action: auth.login
    actor: user@dq0.io
    description: user with email 'user@dq0.io' and device
      '78e1e9d4-cc8c-48da-a325-1c0f908cd9a5' logged in successfully
    timestamp: "1587463859"
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[AuditListItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

AuthLoginRequestBody

email: user@dq0.io
password: "@veryStrongPasswd1900"

Properties

Name	Type	Required	Restrictions	Description
email	string	false	none	Email address
password	string	false	none	Password in plain text (will be encrypted)

AuthLoginResponseBody

token: 9a157ce8-fff2-481a-a58e-32d070f080f4

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	Token identifying current session

AuthLogoutResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

AuthRegisterRequestBody

email: user@dq0.io
password: "@veryStrongPasswd1900"

Properties

Name	Type	Required	Restrictions	Description
email	string	false	none	Email address
password	string	false	none	Password in plain text (will be encrypted)

AuthRegisterResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

AuthSessionResponseBody

token: 9a157ce8-fff2-481a-a58e-32d070f080f4

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	Token identifying current session

CommitContentRequestBody

local_only: true
project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

Name	Type	Required	Restrictions	Description
local_only	boolean	false	none	read only local project
project_uuid	string	false	none	UUID of project

CommitContentResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

CommitInfoResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

CommitItem

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

CommitListResponseBody

items:
  - created_at: 0
    data_name: string
    data_uuid: string
    latest_experiment_name: string
    latest_experiment_result: string
    latest_experiment_uuid: string
    model_checker_status: string
    model_name: string
    model_uuid: string
    predict_allowed: true
    predict_proba_allowed: true
    project_name: string
    project_uuid: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[CommitItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

CommitRunRequestBody

args:
  property1: string
  property2: string
ml_project_entry_point: train
project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

Name	Type	Required	Restrictions	Description
args	object	false	none	Arguments to pass for this run
» additionalProperties	string	false	none	none
ml_project_entry_point	string	false	none	MLproject entry point
project_uuid	string	false	none	UUID of project

CommitRunResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

CommitTransformRequestBody

project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

Name	Type	Required	Restrictions	Description
project_uuid	string	false	none	UUID of project

CommitTransformResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

DataCreateRequestBody

meta: string

Properties

Name	Type	Required	Restrictions	Description
meta	string	false	none	Meta yaml content for data set definition

DataCreateResponseBody

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
data_description	string	false	none	none
data_mean	string	false	none	none
data_name	string	false	none	none
data_permissions	[string]	false	none	none
data_sample	string	false	none	none
data_size	integer(int64)	false	none	none
data_stats	string	false	none	none
data_std	string	false	none	none
data_type	string	false	none	none
data_usage	number(double)	false	none	none
data_uuid	string	false	none	none
privacy_budget	integer(int64)	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

DataDeleteResponseBody

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
data_description	string	false	none	none
data_mean	string	false	none	none
data_name	string	false	none	none
data_permissions	[string]	false	none	none
data_sample	string	false	none	none
data_size	integer(int64)	false	none	none
data_stats	string	false	none	none
data_std	string	false	none	none
data_type	string	false	none	none
data_usage	number(double)	false	none	none
data_uuid	string	false	none	none
privacy_budget	integer(int64)	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

DataGetResponseBody

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
data_description	string	false	none	none
data_mean	string	false	none	none
data_name	string	false	none	none
data_permissions	[string]	false	none	none
data_sample	string	false	none	none
data_size	integer(int64)	false	none	none
data_stats	string	false	none	none
data_std	string	false	none	none
data_type	string	false	none	none
data_usage	number(double)	false	none	none
data_uuid	string	false	none	none
privacy_budget	integer(int64)	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

DataItem

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
data_description	string	false	none	none
data_mean	string	false	none	none
data_name	string	false	none	none
data_permissions	[string]	false	none	none
data_sample	string	false	none	none
data_size	integer(int64)	false	none	none
data_stats	string	false	none	none
data_std	string	false	none	none
data_type	string	false	none	none
data_usage	number(double)	false	none	none
data_uuid	string	false	none	none
privacy_budget	integer(int64)	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

DataListResponseBody

items: "'[{\"id\":1,\"uuid\":\"78fbda3a-6530-45ba-83b0-fe2d7dda899d\",\"name\":\
  \"source
  1\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\",\\
  "sample\"],\"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source\
  1.csv\",\"size\":4,\"mean\":\"(-23.538887188473396, 4.5820969395656865,
  10.53646357964901, 7.1721683055053)\",\"std\":\"(8.79595482855613,
  15.038949447047374, 15.76694875021541,
  55.907788290107405)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"202\
  0-03-24 08:50:57.175\",\"updated_at\":\"2020-04-06
  07:05:05.079\"},{\"id\":2,\"uuid\":\"a87e55d0-aa7c-41c8-9147-1f69b16accc2\",\\
  "name\":\"source
  2\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\"],\
  \"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source2.csv\",\"s\
  ize\":5,\"mean\":\"(-64.64820261903593, 45.56088456347706, 44.27540826516029,
  0.8988506631702773, -43.96628296178475)\",\"std\":\"(38.296517680818894,
  18.843032606250475, 30.83218542407734, 39.104564678591636,
  62.714621754899326)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"202\
  0-03-24 08:50:57.176\",\"updated_at\":\"2020-04-06
  07:05:05.08\"},{\"id\":3,\"uuid\":\"1d3c0ed7-a092-4ce6-b947-55a376dc312b\",\"\
  name\":\"source
  3\",\"type\":\"csv\",\"permissions\":[\"read\",\"meta\",\"types\",\"stats\"],\
  \"version\":1,\"location\":\"\\/path\\/to\\/data\\/source\\/source3.csv\",\"s\
  ize\":5323669,\"mean\":\"(0.2964112953231287, 0.12005084567531446,
  0.6048137927357801, 0.014094863934083933, 0.02116986459954208,
  0.40440611493306095, 0.029147126455147773, 0.0650217121756085,
  0.00026026997636017146, 0.016913810102030358, 0.0019003011109808422,
  0.0005982953058642256, 0.23932725135030042)\",\"std\":\"(0.18807155928503272,
  0.07656611702507954, 0.1709745075446674, 0.06317847401767661,
  0.09497729877421364, 0.12309145556565027, 0.17006894010079007,
  0.24460727006477984, 0.009326928792466644, 0.4608292162296523,
  0.17959469088151425, 0.26998778640743437,
  0.19910365111781858)\",\"stats\":\"\",\"original_data\":0,\"created_at\":\"20\
  20-03-26 08:28:01.871\",\"updated_at\":\"2020-04-06 07:05:05.08\"}]'"
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[DataItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

DataPatchRequestBody

meta: string

Properties

Name	Type	Required	Restrictions	Description
meta	string	false	none	Meta yaml definition of data set

DataPatchResponseBody

commit_name: string
commit_uuid: string
created_at: 0
data_description: string
data_mean: string
data_name: string
data_permissions:
  - string
data_sample: string
data_size: 0
data_stats: string
data_std: string
data_type: string
data_usage: 0
data_uuid: string
privacy_budget: 0
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
data_description	string	false	none	none
data_mean	string	false	none	none
data_name	string	false	none	none
data_permissions	[string]	false	none	none
data_sample	string	false	none	none
data_size	integer(int64)	false	none	none
data_stats	string	false	none	none
data_std	string	false	none	none
data_type	string	false	none	none
data_usage	number(double)	false	none	none
data_uuid	string	false	none	none
privacy_budget	integer(int64)	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

DataPermissionSetRequestBody

data_id: 1
data_name: census
data_uuid: string
permission: 4
role_id: 1
role_name: admins

Properties

Name	Type	Required	Restrictions	Description
data_id	integer(int64)	false	none	Data ID
data_name	string	false	none	Data Name
data_uuid	string	false	none	Data UUID
permission	integer(int64)	false	none	PermissionLevel
role_id	integer(int64)	false	none	Role ID
role_name	string	false	none	Role Name

DataPermissionSetResponseBody

{}

Properties

None

DataSampleResponseBody

name: census
sample: '[{"lastname":"Lastname282","firstname":"Firstname928","age":24,"workclass":"Private","fnlwgt":157177,"education":"Masters","education-num":14,"marital-status":"Married-civ-spouse","occupation":"Prof-specialty","relationship":"Husband","race":"White","sex":"Male","capital-gain":0,"capital-loss":0,"hours-per-week":50,"native-country":"United-States","income":"<=50K"}]'
type: csv
uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Name of dataset
sample	string	false	none	Sample of dataset as string
type	string	false	none	Type of dataset
uuid	string	false	none	UUID of dataset

DeviceVersionResponseBody

api_version: 1.2.6
architecture: amd64
built: 2020-05-28T09:55:02Z
cli_version: 1.1.0
os: darwin

Properties

Name	Type	Required	Restrictions	Description
api_version	string	false	none	API version information
architecture	string	false	none	Operating System architecture information
built	string	false	none	Built timestamp information
cli_version	string	false	none	CLI version information
os	string	false	none	Operating System information

Error

error: invalid parameters provided

Properties

Name	Type	Required	Restrictions	Description
error	string	true	none	The error message

ExperimentCreateRequestBody

experiment_name: My Cool Experiment 42

Properties

Name	Type	Required	Restrictions	Description
experiment_name	string	false	none	Name of the experiment

ExperimentCreateResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

ExperimentDeleteResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

ExperimentInfoResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

ExperimentListItem

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

ExperimentListResponseBody

items:
  - created_at: 0
    data_name: string
    data_uuid: string
    latest_experiment_name: string
    latest_experiment_result: string
    latest_experiment_uuid: string
    model_checker_status: string
    model_name: string
    model_uuid: string
    predict_allowed: true
    predict_proba_allowed: true
    project_name: string
    project_uuid: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[ExperimentListItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

ExperimentRestoreResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

ExperimentUpdateRequestBody

experiment_name: My Cool Experiment 42

Properties

Name	Type	Required	Restrictions	Description
experiment_name	string	false	none	Name of the experiment

ExperimentUpdateResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

GroupAddRoleRequestBody

group_id: 1
group_name: owners
role_id: 4
role_name: owners

Properties

Name	Type	Required	Restrictions	Description
group_id	integer(int64)	false	none	Group ID
group_name	string	false	none	Group Name
role_id	integer(int64)	false	none	RoleID
role_name	string	false	none	RoleName

GroupAddRoleResponseBody

{}

Properties

None

GroupCreateRequestBody

group_name: Admin, User

Properties

Name	Type	Required	Restrictions	Description
group_name	string	false	none	Name of the new Group

GroupCreateResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

GroupDeleteResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

GroupGetResponseBody

created_at: 0
group_id: 0
group_name: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
group_id	integer(int64)	false	none	none
group_name	string	false	none	none
updated_at	integer(int64)	false	none	none

GroupListItem

created_at: 0
group_id: 0
group_name: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
group_id	integer(int64)	false	none	none
group_name	string	false	none	none
updated_at	integer(int64)	false	none	none

GroupListResponseBody

items:
  - created_at: 0
    group_id: 0
    group_name: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[GroupListItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

GroupPatchRequestBody

group_name: MyGroup

Properties

Name	Type	Required	Restrictions	Description
group_name	string	false	none	Name of Group

GroupPatchResponseBody

created_at: 0
group_id: 0
group_name: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
group_id	integer(int64)	false	none	none
group_name	string	false	none	none
updated_at	integer(int64)	false	none	none

GroupRemoveRoleRequestBody

group_id: 1
group_name: owners
role_id: 4
role_name: owners

Properties

Name	Type	Required	Restrictions	Description
group_id	integer(int64)	false	none	Group ID
group_name	string	false	none	Group Name
role_id	integer(int64)	false	none	RoleID
role_name	string	false	none	RoleName

GroupRemoveRoleResponseBody

{}

Properties

None

JobCancelRequestBody

force: false
job_uuid: 79ef8712-f3ed-4494-bb34-aa44fe0f000a

Properties

Name	Type	Required	Restrictions	Description
force	boolean	false	none	Force cancelation
job_uuid	string	false	none	UUID of job to cancel

JobCancelResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

JobInfoResponseBody

commit_name: string
commit_uuid: string
created_at: 0
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
job_errors	string	false	none	none
job_logs	string	false	none	none
job_name	string	false	none	none
job_params	string	false	none	none
job_progress	number(double)	false	none	none
job_results	string	false	none	none
job_state	string	false	none	none
job_type	string	false	none	none
job_uuid	string	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

JobItem

commit_name: string
commit_uuid: string
created_at: 0
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
job_errors	string	false	none	none
job_logs	string	false	none	none
job_name	string	false	none	none
job_params	string	false	none	none
job_progress	number(double)	false	none	none
job_results	string	false	none	none
job_state	string	false	none	none
job_type	string	false	none	none
job_uuid	string	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

JobListResponseBody

items: []
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[JobItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

ModelContentRequestBody

{}

Properties

None

ModelContentResponseBody

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
description	string	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	none
location	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
permissions	[string]	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

ModelInfoResponseBody

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
description	string	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	none
location	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
permissions	[string]	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

ModelItem

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
description	string	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	none
location	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
permissions	[string]	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

ModelListResponseBody

items:
  - commit_name: string
    commit_uuid: string
    description: string
    experiment_name: string
    experiment_uuid: string
    location: string
    model_name: string
    model_uuid: string
    permissions:
      - string
    project_name: string
    project_uuid: string
    user_id: 0
    user_name: string
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[ModelItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

ModelPatchRequestBody

model_description: '"Model with trained stuff that is crazy"'
model_name: '"myModel123"'
permissions: "['predict_allowed', 'predict_proba_allowed']"

Properties

Name	Type	Required	Restrictions	Description
model_description	string	false	none	Description for this model
model_name	string	false	none	Name for this model
permissions	[string]	false	none	Permissions of dataset. Values are: predict_allowed: allow to predict predict_proba_allowed: allow to predict proba

ModelPatchResponseBody

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
description	string	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	none
location	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
permissions	[string]	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

ModelPredictRequestBody

input_data: "{a:1, b:2}"
input_type: json

Properties

Name	Type	Required	Restrictions	Description
input_data	string	false	none	Path to input file
input_type	string	false	none	Type either json or csv

ModelPredictResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ModelRegisterRequestBody

model_path: '"myfolder/model.h5"'
run_uuid: string

Properties

Name	Type	Required	Restrictions	Description
model_path	string	false	none	Path to model
run_uuid	string	true	none	UUID of run (=job uuid) in: path

ModelRegisterResponseBody

commit_name: string
commit_uuid: string
description: string
experiment_name: string
experiment_uuid: string
location: string
model_name: string
model_uuid: string
permissions:
  - string
project_name: string
project_uuid: string
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
description	string	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	none
location	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
permissions	[string]	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

ModelUnregisterRequestBody

model_uuid: string

Properties

Name	Type	Required	Restrictions	Description
model_uuid	string	true	none	UUID of model in: path

ModelUnregisterResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

PrivacyBudgetListItem

created_at: 0
current: 0
data_id: 0
data_name: string
initial: 0
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
current	number(double)	false	none	none
data_id	integer(int64)	false	none	none
data_name	string	false	none	none
initial	number(double)	false	none	none
updated_at	integer(int64)	false	none	none

PrivacyBudgetListResponseBody

items:
  - created_at: 0
    current: 0
    data_id: 0
    data_name: string
    initial: 0
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[PrivacyBudgetListItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

PrivacyBudgetPermissionSetRequestBody

current: 1000
data_id: 1
data_name: owners

Properties

Name	Type	Required	Restrictions	Description
current	number(double)	false	none	Current (or initial) Budget
data_id	integer(int64)	false	none	Data ID
data_name	string	false	none	DataName

PrivacyBudgetPermissionSetResponseBody

{}

Properties

None

PrivacyMaskListItem

created_at: 0
data_id: 0
data_name: string
hidden: string
private: string
public: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_id	integer(int64)	false	none	none
data_name	string	false	none	none
hidden	string	false	none	none
private	string	false	none	none
public	string	false	none	none
updated_at	integer(int64)	false	none	none

PrivacyMaskListResponseBody

items:
  - created_at: 0
    data_id: 0
    data_name: string
    hidden: string
    private: string
    public: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[PrivacyMaskListItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

PrivacyMaskPermissionSetRequestBody

data_id: 1
data_name: owners
mask_data: {}
user_email: "1"
user_id: 1

Properties

Name	Type	Required	Restrictions	Description
data_id	integer(int64)	false	none	Data ID
data_name	string	false	none	DataName
mask_data	object	false	none	JSON encoded data containing information about column masking
user_email	string	false	none	UserEmail
user_id	integer(int64)	false	none	User ID

PrivacyMaskPermissionSetResponseBody

{}

Properties

None

PrivacyThresholdListItem

created_at: 0
data_id: 0
data_name: string
field: string
threshold: 0
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_id	integer(int64)	false	none	none
data_name	string	false	none	none
field	string	false	none	none
threshold	integer(int64)	false	none	none
updated_at	integer(int64)	false	none	none

PrivacyThresholdListResponseBody

items:
  - created_at: 0
    data_id: 0
    data_name: string
    field: string
    threshold: 0
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[PrivacyThresholdListItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

PrivacyThresholdPermissionSetRequestBody

data_id: 1
data_name: owners
field: households
threshold: 75
user_email: "1"
user_id: 1

Properties

Name	Type	Required	Restrictions	Description
data_id	integer(int64)	false	none	Data ID
data_name	string	false	none	DataName
field	string	false	none	Column, column name
threshold	integer(int64)	false	none	Threshold value
user_email	string	false	none	UserEmail
user_id	integer(int64)	false	none	User ID

PrivacyThresholdPermissionSetResponseBody

{}

Properties

None

ProjectAttachRequestBody

data_name: census
data_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

Name	Type	Required	Restrictions	Description
data_name	string	false	none	Name of dataset
data_uuid	string	false	none	UUID of dataset

ProjectAttachResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProjectCreateRequestBody

name: MyProject
working_dir: /path/to/my/workingDir

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Name of your new project
working_dir	string	false	none	Working directory path

ProjectCreateResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProjectDeployResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProjectDetachRequestBody

data_name: census
data_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

Name	Type	Required	Restrictions	Description
data_name	string	false	none	Name of dataset
data_uuid	string	false	none	UUID of dataset

ProjectDetachResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProjectInfoResponseBody

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

ProjectItem

created_at: 0
data_name: string
data_uuid: string
latest_experiment_name: string
latest_experiment_result: string
latest_experiment_uuid: string
model_checker_status: string
model_name: string
model_uuid: string
predict_allowed: true
predict_proba_allowed: true
project_name: string
project_uuid: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
data_name	string	false	none	none
data_uuid	string	false	none	none
latest_experiment_name	string	false	none	none
latest_experiment_result	string	false	none	none
latest_experiment_uuid	string	false	none	none
model_checker_status	string	false	none	none
model_name	string	false	none	none
model_uuid	string	false	none	none
predict_allowed	boolean	false	none	none
predict_proba_allowed	boolean	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
updated_at	integer(int64)	false	none	none

ProjectListResponseBody

items:
  - created_at: 0
    data_name: string
    data_uuid: string
    latest_experiment_name: string
    latest_experiment_result: string
    latest_experiment_uuid: string
    model_checker_status: string
    model_name: string
    model_uuid: string
    predict_allowed: true
    predict_proba_allowed: true
    project_name: string
    project_uuid: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[ProjectItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

ProjectSetExperimentNameRequestBody

experiment_name: My Cool Experiment 42

Properties

Name	Type	Required	Restrictions	Description
experiment_name	string	false	none	Name of the experiment

ProjectSetExperimentNameResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProjectSetPermissionRequestBody

permission: 4
project_id: 1
project_name: Project1
project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2
role_id: 1
role_name: owners

Properties

Name	Type	Required	Restrictions	Description
permission	integer(int64)	false	none	PermissionLevel
project_id	integer(int64)	false	none	Project ID
project_name	string	false	none	Project Name
project_uuid	string	false	none	Project UUID
role_id	integer(int64)	false	none	Role ID
role_name	string	false	none	RoleName

ProjectSetPermissionResponseBody

{}

Properties

None

ProjectUnlinkResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProxyActivateResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProxyCreateRequestBody

hostname: string
port: 0
request_uri: string
scheme: string

Properties

Name	Type	Required	Restrictions	Description
hostname	string	false	none	none
port	integer(int64)	false	none	none
request_uri	string	false	none	none
scheme	string	false	none	none

ProxyCreateResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProxyCurrentResponseBody

active: true
email_address: string
hostname: string
port: 0
public_key: string
request_uri: string
scheme: string
session_key: string

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
email_address	string	false	none	none
hostname	string	false	none	none
port	integer(int64)	false	none	none
public_key	string	false	none	none
request_uri	string	false	none	none
scheme	string	false	none	none
session_key	string	false	none	none

ProxyDeleteResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

ProxyGetResponseBody

active: true
email_address: string
hostname: string
port: 0
public_key: string
request_uri: string
scheme: string
session_key: string

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
email_address	string	false	none	none
hostname	string	false	none	none
port	integer(int64)	false	none	none
public_key	string	false	none	none
request_uri	string	false	none	none
scheme	string	false	none	none
session_key	string	false	none	none

ProxyListResponseBody

items:
  - active: true
    email_address: string
    hostname: string
    port: 0
    public_key: string
    request_uri: string
    scheme: string
    session_key: string
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[ProxyResultItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

ProxyResultItem

active: true
email_address: string
hostname: string
port: 0
public_key: string
request_uri: string
scheme: string
session_key: string

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
email_address	string	false	none	none
hostname	string	false	none	none
port	integer(int64)	false	none	none
public_key	string	false	none	none
request_uri	string	false	none	none
scheme	string	false	none	none
session_key	string	false	none	none

QueryCancelRequestBody

force: false
query_uuid: 79ef8712-f3ed-4494-bb34-aa44fe0f000a

Properties

Name	Type	Required	Restrictions	Description
force	boolean	false	none	Force cancelation
query_uuid	string	false	none	UUID of query to cancel

QueryCancelResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

QueryCreateRequestBody

datasets: '"data_source1,data2"'
epsilon: 1
params: p1=123
permissions: households<75
private_column: '"user_id"'
query: SELECT COUNT(*) FROM table;
tau: 100

Properties

Name	Type	Required	Restrictions	Description
datasets	string	false	none	Used dataset uuid for provided query
epsilon	number(double)	false	none	Epsilon value for differential private query.
params	[string]	false	none	Additional parameters
permissions	[string]	false	none	Permissions for provided query
private_column	string	false	none	Private column for this query. Leave empty or omit for default value from metadata.
query	string	false	none	SQL query to execute
tau	number(double)	false	none	Tau threshold value for private query. Optional.

QueryCreateResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

QueryInfoResponseBody

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
query_datasets:
  property1: string
  property2: string
query_result_data: string
query_result_message: string
query_statement: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	additional meta information: experiment
job_errors	string	false	none	none
job_logs	string	false	none	none
job_name	string	false	none	none
job_params	string	false	none	none
job_progress	number(double)	false	none	none
job_results	string	false	none	none
job_state	string	false	none	none
job_type	string	false	none	none
job_uuid	string	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
query_datasets	object	false	none	none
» additionalProperties	string	false	none	none
query_result_data	string	false	none	none
query_result_message	string	false	none	none
query_statement	string	false	none	none
run_end_time	integer(int64)	false	none	none
run_metrics	[RunMetricItem]	false	none	[RunMetricItem model struct]
run_params	[RunParamItem]	false	none	[RunParamItem model struct]
run_stage	string	false	none	none
run_start_time	integer(int64)	false	none	none
run_status	string	false	none	none
run_tags	[RunTagItem]	false	none	[RunTagItem model struct]
run_uuid	string	false	none	run info
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

QueryItem

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
query_datasets:
  property1: string
  property2: string
query_result_data: string
query_result_message: string
query_statement: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	additional meta information: experiment
job_errors	string	false	none	none
job_logs	string	false	none	none
job_name	string	false	none	none
job_params	string	false	none	none
job_progress	number(double)	false	none	none
job_results	string	false	none	none
job_state	string	false	none	none
job_type	string	false	none	none
job_uuid	string	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
query_datasets	object	false	none	none
» additionalProperties	string	false	none	none
query_result_data	string	false	none	none
query_result_message	string	false	none	none
query_statement	string	false	none	none
run_end_time	integer(int64)	false	none	none
run_metrics	[RunMetricItem]	false	none	[RunMetricItem model struct]
run_params	[RunParamItem]	false	none	[RunParamItem model struct]
run_stage	string	false	none	none
run_start_time	integer(int64)	false	none	none
run_status	string	false	none	none
run_tags	[RunTagItem]	false	none	[RunTagItem model struct]
run_uuid	string	false	none	run info
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

QueryListResponseBody

items: []
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[QueryItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

RoleAddGroupRequestBody

group_id: 4
group_name: owners
role_id: 1
role_name: owners

Properties

Name	Type	Required	Restrictions	Description
group_id	integer(int64)	false	none	GroupID
group_name	string	false	none	Group Name
role_id	integer(int64)	false	none	Role ID
role_name	string	false	none	RoleName

RoleAddGroupResponseBody

{}

Properties

None

RoleCreateRequestBody

role_name: Admin, User

Properties

Name	Type	Required	Restrictions	Description
role_name	string	false	none	Name of the new Role

RoleCreateResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

RoleDeleteResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

RoleGetResponseBody

created_at: 0
role_id: 0
role_name: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
role_id	integer(int64)	false	none	none
role_name	string	false	none	none
updated_at	integer(int64)	false	none	none

RoleListItem

created_at: 0
role_id: 0
role_name: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
role_id	integer(int64)	false	none	none
role_name	string	false	none	none
updated_at	integer(int64)	false	none	none

RoleListResponseBody

items:
  - created_at: 0
    role_id: 0
    role_name: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[RoleListItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

RolePatchRequestBody

role_name: MyRole

Properties

Name	Type	Required	Restrictions	Description
role_name	string	false	none	Name of Role

RolePatchResponseBody

created_at: 0
role_id: 0
role_name: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
role_id	integer(int64)	false	none	none
role_name	string	false	none	none
updated_at	integer(int64)	false	none	none

RoleRemoveGroupRequestBody

group_id: 4
group_name: owners
role_id: 1
role_name: owners

Properties

Name	Type	Required	Restrictions	Description
group_id	integer(int64)	false	none	GroupID
group_name	string	false	none	Group Name
role_id	integer(int64)	false	none	Role ID
role_name	string	false	none	RoleName

RoleRemoveGroupResponseBody

{}

Properties

None

RoleSetPermissionRequestBody

permission: 4
role_id: 1
role_name: owners

Properties

Name	Type	Required	Restrictions	Description
permission	integer(int64)	false	none	PermissionLevel
role_id	integer(int64)	false	none	Role ID
role_name	string	false	none	RoleName

RoleSetPermissionResponseBody

{}

Properties

None

RunCreateRequestBody

args:
  property1: string
  property2: string
commit_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2
ml_project_entry_point: train
project_uuid: 6af92043-33db-4c27-8b38-e8733f4713c2

Properties

Name	Type	Required	Restrictions	Description
args	object	false	none	Arguments to pass for this run
» additionalProperties	string	false	none	none
commit_uuid	string	false	none	UUID of commit
ml_project_entry_point	string	false	none	MLproject entry point
project_uuid	string	false	none	UUID of project

RunCreateResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

RunDeleteResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

RunGetMetricHistoryResponseBody

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	additional meta information: experiment
job_errors	string	false	none	none
job_logs	string	false	none	none
job_name	string	false	none	none
job_params	string	false	none	none
job_progress	number(double)	false	none	none
job_results	string	false	none	none
job_state	string	false	none	none
job_type	string	false	none	none
job_uuid	string	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
run_end_time	integer(int64)	false	none	none
run_metrics	[RunMetricItem]	false	none	[RunMetricItem model struct]
run_params	[RunParamItem]	false	none	[RunParamItem model struct]
run_stage	string	false	none	none
run_start_time	integer(int64)	false	none	none
run_status	string	false	none	none
run_tags	[RunTagItem]	false	none	[RunTagItem model struct]
run_uuid	string	false	none	run info
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

RunInfoResponseBody

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	additional meta information: experiment
job_errors	string	false	none	none
job_logs	string	false	none	none
job_name	string	false	none	none
job_params	string	false	none	none
job_progress	number(double)	false	none	none
job_results	string	false	none	none
job_state	string	false	none	none
job_type	string	false	none	none
job_uuid	string	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
run_end_time	integer(int64)	false	none	none
run_metrics	[RunMetricItem]	false	none	[RunMetricItem model struct]
run_params	[RunParamItem]	false	none	[RunParamItem model struct]
run_stage	string	false	none	none
run_start_time	integer(int64)	false	none	none
run_status	string	false	none	none
run_tags	[RunTagItem]	false	none	[RunTagItem model struct]
run_uuid	string	false	none	run info
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

RunItem

commit_name: string
commit_uuid: string
created_at: 0
experiment_name: string
experiment_uuid: string
job_errors: string
job_logs: string
job_name: string
job_params: string
job_progress: 0
job_results: string
job_state: string
job_type: string
job_uuid: string
project_name: string
project_uuid: string
run_end_time: 0
run_metrics:
  - key: string
    step: string
    timestamp: string
    value: 0
run_params:
  - key: string
    value: string
run_stage: string
run_start_time: 0
run_status: string
run_tags:
  - key: string
    value: string
run_uuid: string
updated_at: 0
user_id: 0
user_name: string

Properties

Name	Type	Required	Restrictions	Description
commit_name	string	false	none	none
commit_uuid	string	false	none	none
created_at	integer(int64)	false	none	none
experiment_name	string	false	none	none
experiment_uuid	string	false	none	additional meta information: experiment
job_errors	string	false	none	none
job_logs	string	false	none	none
job_name	string	false	none	none
job_params	string	false	none	none
job_progress	number(double)	false	none	none
job_results	string	false	none	none
job_state	string	false	none	none
job_type	string	false	none	none
job_uuid	string	false	none	none
project_name	string	false	none	none
project_uuid	string	false	none	none
run_end_time	integer(int64)	false	none	none
run_metrics	[RunMetricItem]	false	none	[RunMetricItem model struct]
run_params	[RunParamItem]	false	none	[RunParamItem model struct]
run_stage	string	false	none	none
run_start_time	integer(int64)	false	none	none
run_status	string	false	none	none
run_tags	[RunTagItem]	false	none	[RunTagItem model struct]
run_uuid	string	false	none	run info
updated_at	integer(int64)	false	none	none
user_id	integer(int64)	false	none	none
user_name	string	false	none	none

RunListResponseBody

items: []
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[RunItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

RunMetricItem

key: string
step: string
timestamp: string
value: 0

RunMetricItem model struct

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
step	string	false	none	none
timestamp	string	false	none	none
value	number(double)	false	none	none

RunParamItem

key: string
value: string

RunParamItem model struct

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
value	string	false	none	none

RunRestoreResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

RunTagItem

key: string
value: string

RunTagItem model struct

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
value	string	false	none	none

UserAddGroupRequestBody

group_id: 4
group_name: owners
user_email: owners
user_id: 1

Properties

Name	Type	Required	Restrictions	Description
group_id	integer(int64)	false	none	GroupID
group_name	string	false	none	Group Name
user_email	string	false	none	UserEmail
user_id	integer(int64)	false	none	User ID

UserAddGroupResponseBody

{}

Properties

None

UserAddRoleRequestBody

role_id: 4
role_name: owners
user_email: owners
user_id: 1
user_name: owners

Properties

Name	Type	Required	Restrictions	Description
role_id	integer(int64)	false	none	RoleID
role_name	string	false	none	RoleName
user_email	string	false	none	User Email
user_id	integer(int64)	false	none	User ID
user_name	string	false	none	User Name

UserAddRoleResponseBody

{}

Properties

None

UserDeleteResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

UserGetResponseBody

avatar: string
company: string
location: string
name: string
public_email: string
user_id: 0
website: string

Properties

Name	Type	Required	Restrictions	Description
avatar	string	false	none	none
company	string	false	none	none
location	string	false	none	none
name	string	false	none	none
public_email	string	false	none	none
user_id	integer(int64)	false	none	none
website	string	false	none	none

UserListItem

created_at: 0
email: string
id: 0
password: string
role: 0
role_name: string
state: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
email	string	false	none	none
id	integer(int64)	false	none	none
password	string	false	none	none
role	integer(int64)	false	none	none
role_name	string	false	none	none
state	string	false	none	none
updated_at	integer(int64)	false	none	none

UserListResponseBody

items:
  - created_at: 0
    email: string
    id: 0
    password: string
    role: 0
    role_name: string
    state: string
    updated_at: 0
page: 3
page_size: 100
total: 552

Properties

Name	Type	Required	Restrictions	Description
items	[UserListItem]	true	none	Array with resulting items
page	integer(int64)	false	none	Current page in result list
page_size	integer(int64)	false	none	Number of records per page
total	integer(int64)	false	none	Number of total records available in database

UserLoginRequestBody

email: user@dq0.io
password: "@veryStrongPasswd1900"

Properties

Name	Type	Required	Restrictions	Description
email	string	false	none	Email address
password	string	false	none	Password in plain text (will be encrypted)

UserLoginResponseBody

token: 9a157ce8-fff2-481a-a58e-32d070f080f4

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	Token identifying current session

UserLogoutResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

UserProfileCurrentResponseBody

avatar: string
company: string
location: string
name: string
public_email: string
user_id: 0
website: string

Properties

Name	Type	Required	Restrictions	Description
avatar	string	false	none	none
company	string	false	none	none
location	string	false	none	none
name	string	false	none	none
public_email	string	false	none	none
user_id	integer(int64)	false	none	none
website	string	false	none	none

UserProfileUpdateRequestBody

avatar: string
company: gradient0
location: Vienna
name: John
public_email: john@gmail.com
website: gradient0.com

Properties

Name	Type	Required	Restrictions	Description
avatar	string	false	none	Avatar base64 encoded string
company	string	false	none	Company
location	string	false	none	Location
name	string	false	none	Name
public_email	string	false	none	Public Email
website	string	false	none	Website

UserProfileUpdateResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

UserRegisterRequestBody

email: user@dq0.io
password: "@veryStrongPasswd1900"

Properties

Name	Type	Required	Restrictions	Description
email	string	false	none	Email address
password	string	false	none	Password in plain text (will be encrypted)

UserRegisterResponseBody

message: succesfully started training ...

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	The message response contains 'message' field only

UserRemoveGroupRequestBody

group_id: 4
group_name: owners
user_email: owners
user_id: 1

Properties

Name	Type	Required	Restrictions	Description
group_id	integer(int64)	false	none	GroupID
group_name	string	false	none	Group Name
user_email	string	false	none	UserEmail
user_id	integer(int64)	false	none	User ID

UserRemoveGroupResponseBody

{}

Properties

None

UserRemoveRoleRequestBody

role_id: 4
role_name: owners
user_email: owners
user_id: 1
user_name: owners

Properties

Name	Type	Required	Restrictions	Description
role_id	integer(int64)	false	none	RoleID
role_name	string	false	none	RoleName
user_email	string	false	none	User Email
user_id	integer(int64)	false	none	User ID
user_name	string	false	none	User Name

UserRemoveRoleResponseBody

{}

Properties

None

UserSessionResponseBody

token: 9a157ce8-fff2-481a-a58e-32d070f080f4

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	Token identifying current session

UserUpdateRequestBody

roles:
  - 0
state: string

Properties

Name	Type	Required	Restrictions	Description
roles	[integer]	false	none	none
state	string	false	none	none

UserUpdateResponseBody

created_at: 0
email: string
id: 0
password: string
role: 0
role_name: string
state: string
updated_at: 0

Properties

Name	Type	Required	Restrictions	Description
created_at	integer(int64)	false	none	none
email	string	false	none	none
id	integer(int64)	false	none	none
password	string	false	none	none
role	integer(int64)	false	none	none
role_name	string	false	none	none
state	string	false	none	none
updated_at	integer(int64)	false	none	none