Skip to main content
Version: master 🏃

Environment REST API

caution

The Environment API is in the alpha stage which is subjected to incompatible changes in future releases.

Create Environment

POST /api/v1/environment

Parameters

Put EnvironmentSpec in request body.

EnvironmentSpec

Field NameTypeDescriptionRequired
nameStringEnvironment name.o
dockerImageStringDocker image name.o
kernelSpecKernelSpecEnvironment spec.o
descriptionStringDescription of environment.x

KernelSpec

Field NameTypeDescriptionRequired
nameStringKernel name.o
channelsList<String>Names of the channels.o
condaDependenciesList<String>List of kernel conda dependencies.o
pipDependenciesList<String>List of kernel pip dependencies.o

Example

Example Request
curl -X POST -H "Content-Type: application/json" -d '
{
"name": "my-submarine-env",
"dockerImage" : "continuumio/anaconda3",
"kernelSpec" : {
"name" : "team_default_python_3.7",
"channels" : ["defaults"],
"condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
"alabaster=0.7.12=py37_0",
"anaconda=2020.02=py37_0",
"anaconda-client=1.7.2=py37_0",
"anaconda-navigator=1.9.12=py37_0"],
"pipDependencies" :
["apache-submarine==0.7.0",
"pyarrow==0.17.0"]
}
}
' http://127.0.0.1:32080/api/v1/environment
Example Response
{
"status": "OK",
"code": 200,
"result": {
"environmentId": "environment_1586156073228_0001",
"environmentSpec": {
"name": "my-submarine-env",
"dockerImage" : "continuumio/anaconda3",
"kernelSpec" : {
"name" : "team_default_python_3.7",
"channels" : ["defaults"],
"condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
"alabaster=0.7.12=py37_0",
"anaconda=2020.02=py37_0",
"anaconda-client=1.7.2=py37_0",
"anaconda-navigator=1.9.12=py37_0"],
"pipDependencies" :
["apache-submarine==0.7.0",
"pyarrow==0.17.0"]
}
}
}
}

List environment

GET /api/v1/environment

Example

Example Request
curl -X GET http://127.0.0.1:32080/api/v1/environment
Example Response
{
"status":"OK",
"code":200,
"success":true,
"message":null,
"result":[
{
"environmentId":"environment_1600862964725_0002",
"environmentSpec":{
"name":"notebook-gpu-env",
"dockerImage":"apache/submarine:jupyter-notebook-gpu-0.7.0",
"kernelSpec":{
"name":"submarine_jupyter_py3",
"channels":[
"defaults"
],
"condaDependencies":[],
"pipDependencies":[]
},
"description":null,
"image":null
}
},
{
"environmentId":"environment_1647192232698_0003",
"environmentSpec":{
"name":"my-submarine-env",
"dockerImage":"continuumio/anaconda3",
"kernelSpec":{
"name":"team_default_python_3.7",
"channels":[
"defaults"
],
"condaDependencies":[
"_ipyw_jlab_nb_ext_conf\u003d0.1.0\u003dpy37_0",
"alabaster\u003d0.7.12\u003dpy37_0",
"anaconda\u003d2020.02\u003dpy37_0",
"anaconda-client\u003d1.7.2\u003dpy37_0",
"anaconda-navigator\u003d1.9.12\u003dpy37_0"
],
"pipDependencies":[
"apache-submarine\u003d\u003d0.7.0",
"pyarrow\u003d\u003d0.17.0"
]
},
"description":null,
"image":null
}
},
{
"environmentId":"environment_1600862964725_0001",
"environmentSpec":{
"name":"notebook-env",
"dockerImage":"apache/submarine:jupyter-notebook-0.7.0",
"kernelSpec":{
"name":"submarine_jupyter_py3",
"channels":[
"defaults"
],
"condaDependencies":[],
"pipDependencies":[]
},
"description":null,
"image":null
}
}
],
"attributes":{}
}

Get environment

GET /api/v1/environment/{name}

Parameters

Field NameTypeInDescriptionRequired
nameStringpathEnvironment name.o

Example

Example Request
curl -X GET http://127.0.0.1:32080/api/v1/environment/my-submarine-env
Example Response
{
"status":"OK",
"code":200,
"success":true,
"message":null,
"result":{
"environmentId":"environment_1647192232698_0003",
"environmentSpec":{
"name":"my-submarine-env",
"dockerImage":"continuumio/anaconda3",
"kernelSpec":{
"name":"team_default_python_3.7",
"channels":[
"defaults"
],
"condaDependencies":[
"_ipyw_jlab_nb_ext_conf\u003d0.1.0\u003dpy37_0",
"alabaster\u003d0.7.12\u003dpy37_0",
"anaconda\u003d2020.02\u003dpy37_0",
"anaconda-client\u003d1.7.2\u003dpy37_0",
"anaconda-navigator\u003d1.9.12\u003dpy37_0"
],
"pipDependencies":[
"apache-submarine\u003d\u003d0.7.0",
"pyarrow\u003d\u003d0.17.0"
]
},
"description":null,
"image":null
}
},
"attributes":{}
}

Patch environment

PATCH /api/v1/environment/{name}

Parameters

Field NameTypeInDescriptionRequired
nameStringpath and bodyEnvironment name.o
dockerImageStringbodyDocker image name.o
kernelSpecKernelSpecbodyEnvironment spec.o
descriptionStringbodyDescription of environment. This field is optional.x

Example

Example Request
curl -X PATCH -H "Content-Type: application/json" -d '
{
"name": "my-submarine-env",
"dockerImage" : "continuumio/anaconda3",
"kernelSpec" : {
"name" : "team_default_python_3.7_updated",
"channels" : ["defaults"],
"condaDependencies" :
["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",
"alabaster=0.7.12=py37_0"],
"pipDependencies" :
[]
}
}
' http://127.0.0.1:32080/api/v1/environment/my-submarine-env
Example Response
{
"status":"OK",
"code":200,
"success":true,
"message":null,
"result":{
"environmentId":"environment_1647192232698_0004",
"environmentSpec":{
"name":"my-submarine-env",
"dockerImage":"continuumio/anaconda3",
"kernelSpec":{
"name":"team_default_python_3.7_updated",
"channels":[
"defaults"
],
"condaDependencies":[
"_ipyw_jlab_nb_ext_conf\u003d0.1.0\u003dpy37_0",
"alabaster\u003d0.7.12\u003dpy37_0"
],
"pipDependencies":[]
},
"description":null,
"image":null
}
},
"attributes":{}
}
note

dockerImage, "name" (of kernelSpec), "channels", "condaDependencies", "pipDependencies" etc can be updated using this API. "name" of environmentSpec is not supported.

Delete environment

GET /api/v1/environment/{name}

Parameters

Field NameTypeInDescriptionRequired
nameStringpathEnvironment name.o

Example

Example Request
curl -X DELETE http://127.0.0.1:32080/api/v1/environment/my-submarine-env
Example Response
{
"status":"OK",
"code":200,
"success":true,
"message":null,
"result":{
"environmentId":"environment_1647192232698_0003",
"environmentSpec":{
"name":"my-submarine-env",
"dockerImage":"continuumio/anaconda3",
"kernelSpec":{
"name":"team_default_python_3.7",
"channels":[
"defaults"
],
"condaDependencies":[
"_ipyw_jlab_nb_ext_conf\u003d0.1.0\u003dpy37_0",
"alabaster\u003d0.7.12\u003dpy37_0",
"anaconda\u003d2020.02\u003dpy37_0",
"anaconda-client\u003d1.7.2\u003dpy37_0",
"anaconda-navigator\u003d1.9.12\u003dpy37_0"
],
"pipDependencies":[
"apache-submarine\u003d\u003d0.7.0",
"pyarrow\u003d\u003d0.17.0"
]
},
"description":null,
"image":null
}
},
"attributes":{}
}