Deployments

List deployments

GET /deployments

Get list of deployments.

Query Parameters

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

200 List of deployments.

[
  {
    "id": "string",
    "project_id": 0,
    "model_id": "string",
    "version": "string",
    "model_uri": "string",
    "type": "local",
    "created_at": "2020-01-31T11:30:32.076Z",
    "host": "string",
    "port": "string"
  }
]

Create deployment

POST /deployments

Create new deployment.

Query Parameters

Name	Type	Description
project_id	integer	Project id
model_id	string	Registered model id (name)
version	string	Registerd model version
type	string	Deployment type (local or gcp)

202 Deployment creating started.

{
  "deployment_id": "string"
}

404 Project, registered model or version not found.

500

Get deployment.

GET /deployments/{deployment_id}

Get deployment.

Path Parameters

Name	Type	Description
deployment_id	integer	Deployment id

200 Deployment object.

{
  "id": "string",
  "project_id": 0,
  "model_id": "string",
  "version": "string",
  "model_uri": "string",
  "type": "local",
  "created_at": "2020-01-31T11:41:08.470Z",
  "host": "string",
  "port": "string"
}

404 Deployment not found.

500

Delete deployment

DELETE /deployments​/{deployment_id}

Delete deployment (mark as deleted).

Path Parameters

Name	Type	Description
deployment_id	integer	Deployment id

200 Deployment has deleted.

{
  "deployment_id": "string"
}

404 Deployment not found.

500

Run deployment

PUT /deployments/{deployment_id}/run

Run deployment.

Path Parameters

Name	Type	Description
deployment_id	integer	Deployment id

200 Deployment has run.

{
  "deployment_id": "string"
}

404 Deployment not found.

500

Stop deployment

PUT /deployments​/{deployment_id}​/stop

Stop deployment.

Path Parameters

Name	Type	Description
deployment_id	integer	Deployment id

200 Deployment has stopped.

{
  "deployment_id": "string"
}

404 Deployment not found.

500

Predict

POST /deployments/{deployment_id}/predict

Predict data on deployment.

Path Parameters

Name	Type	Description
deployment_id	integer	Deployment id

Request Body

Name	Type	Description
data	string	Predicted data in format pandas-records (e.g. '[[1,2,3], [4,5,6]]')

200 Prediction object.

{
  "prediction": "string"
}

404 Deployment not found.

500

Ping

GET /deployments/{deployment_id}/ping

Ping deployment (check if deployment is available by http).

Path Parameters

Name	Type	Description
deployment_id	integer	Deployment id

200 Deployment started and available by http.

400 Deployment's model is not loaded yet.

404 Deployment not found.

500