Projects

List projects

GET /projects

Get list of projects.

Query Parameters

Name	Type	Description
_sort	string	Sort key
_order	string	Sorting order (ASC or DESC)
_start	integer	Start index
_end	integer	E

200 List of projects.

[
  {
    "id": 0,
    "description": "string",
    "name": "string",
    "status": "running",
    "mlflowUri": "string",
    "createdBy": 0,
    "createdAt": "2020-01-30T12:36:52.602Z"
  }
]

500

Create project

POST /projects

Create new project.

Request Body

Name	Type	Description
name	string	Project name
description	string	Project description

201 Created project.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T12:43:41.969Z"
}

400 Bad project name OR project already exists

500

Get project

GET /projects/{project_id}

Get project.

Path Parameters

Name	Type	Description
project_id	integer	Project id

200 Project object.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T12:51:33.040Z"
}

404 Project not found.

500

Update project

PUT /projects/{project_id}

Update project's name or/and description. Whate field not specified that will not be updated.

Path Parameters

Name	Type	Description
project_id	integer	Project id

Request Body

Name	Type	Description
name	string	New project name
description	string	New project description

200 Update project object.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T12:55:11.228Z"
}

404 Project not found

500

Delete project

DELETE /projects/{project_id}

Path Parameters

Name	Type	Description
project_id	integer	Project id

200 Project object.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T12:59:41.677Z"
}

400 Only admin users can delete projects (in future).

404 Project not found.

Healthcheck

GET ​/projects​/{project_id}​/healthcheck

Check if tracking server process started.

Path Parameters

Name	Type	Description
project_id	integer	Project id

200 Tracking server started.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T13:03:58.910Z"
}

400 Tracking server did not start.

404 Project not found.

Run project

PUT /projects/{project_id}/run

Run project's tracking server.

Path Parameters

Name	Type	Description
project_id	integer	Project id

200 Tracking server has run.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T13:06:58.737Z"
}

404 Project not found.

409 Tracking server is already run.

500

Terminate

PUT /projects​/{project_id}​/terminate

Terminate tracking server.

Path Parameters

Name	Type	Description
project_id	integer	Project id

200 Tracking server has terminated.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T13:11:56.315Z"
}

500

Archive

PUT /projects​/{project_id}​/archive

Archive

Path Parameters

Name	Type	Description
project_id	integer	Project id

200 Project has archived.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T13:13:55.645Z"
}

404 Project not found.

500

Restore

PUT /projects​/{project_id}​/restore

Restore project.

Path Parameters

Name	Type	Description
project_id	integer	Project id

200 Project has restored.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T13:18:24.772Z"
}

404 Project not found.

500

Ping

GET /projects​/{project_id}​/ping

Ping tracking server - check if the server started and available by http.

Path Parameters

Name	Type	Description
project_id	integer	Project id

200 Tracking server started and available by http.

{
  "id": 0,
  "description": "string",
  "name": "string",
  "status": "running",
  "mlflowUri": "string",
  "createdBy": 0,
  "createdAt": "2020-01-30T13:20:56.567Z"
}

400 Tracking server not available by http.

404 Project not found.

500