"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[1494],{3905:function(e,n,t){t.d(n,{Zo:function(){return d},kt:function(){return s}});var a=t(7294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function l(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function i(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?l(Object(t),!0).forEach((function(n){r(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):l(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function p(e,n){if(null==e)return{};var t,a,r=function(e,n){if(null==e)return{};var t,a,r={},l=Object.keys(e);for(a=0;a<l.length;a++)t=l[a],n.indexOf(t)>=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)t=l[a],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var m=a.createContext({}),o=function(e){var n=a.useContext(m),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},d=function(e){var n=o(e.components);return a.createElement(m.Provider,{value:n},e.children)},u={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},c=a.forwardRef((function(e,n){var t=e.components,r=e.mdxType,l=e.originalType,m=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=o(t),s=r,k=c["".concat(m,".").concat(s)]||c[s]||u[s]||l;return t?a.createElement(k,i(i({ref:n},d),{},{components:t})):a.createElement(k,i({ref:n},d))}));function s(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var l=t.length,i=new Array(l);i[0]=c;var p={};for(var m in n)hasOwnProperty.call(n,m)&&(p[m]=n[m]);p.originalType=e,p.mdxType="string"==typeof e?e:r,i[1]=p;for(var o=2;o<l;o++)i[o]=t[o];return a.createElement.apply(null,i)}return a.createElement.apply(null,t)}c.displayName="MDXCreateElement"},6497:function(e,n,t){t.r(n),t.d(n,{assets:function(){return d},contentTitle:function(){return m},default:function(){return s},frontMatter:function(){return p},metadata:function(){return o},toc:function(){return u}});var a=t(7462),r=t(3366),l=(t(7294),t(3905)),i=["components"],p={title:"Environment REST API"},m=void 0,o={unversionedId:"api/environment",id:"version-0.7.0/api/environment",title:"Environment REST API",description:"\x3c!--",source:"@site/versioned_docs/version-0.7.0/api/environment.md",sourceDirName:"api",slug:"/api/environment",permalink:"/docs/0.7.0/api/environment",editUrl:"https://github.com/apache/submarine/edit/master/website/versioned_docs/version-0.7.0/api/environment.md",tags:[],version:"0.7.0",frontMatter:{title:"Environment REST API"},sidebar:"api",next:{title:"Experiment REST API",permalink:"/docs/0.7.0/api/experiment"}},d={},u=[{value:"Create Environment",id:"create-environment",level:2},{value:"Parameters",id:"parameters",level:3},{value:"<strong>EnvironmentSpec</strong>",id:"environmentspec",level:4},{value:"<strong>KernelSpec</strong>",id:"kernelspec",level:4},{value:"Example",id:"example",level:3},{value:"List environment",id:"list-environment",level:2},{value:"Example",id:"example-1",level:3},{value:"Get environment",id:"get-environment",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Example",id:"example-2",level:3},{value:"Patch environment",id:"patch-environment",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Example",id:"example-3",level:3},{value:"Delete environment",id:"delete-environment",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Example",id:"example-4",level:3}],c={toc:u};function s(e){var n=e.components,t=(0,r.Z)(e,i);return(0,l.kt)("wrapper",(0,a.Z)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,l.kt)("div",{className:"admonition admonition-caution alert alert--warning"},(0,l.kt)("div",{parentName:"div",className:"admonition-heading"},(0,l.kt)("h5",{parentName:"div"},(0,l.kt)("span",{parentName:"h5",className:"admonition-icon"},(0,l.kt)("svg",{parentName:"span",xmlns:"http://www.w3.org/2000/svg",width:"16",height:"16",viewBox:"0 0 16 16"},(0,l.kt)("path",{parentName:"svg",fillRule:"evenodd",d:"M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"}))),"caution")),(0,l.kt)("div",{parentName:"div",className:"admonition-content"},(0,l.kt)("p",{parentName:"div"},"The Environment API is in the alpha stage which is subjected to incompatible changes in future releases."))),(0,l.kt)("h2",{id:"create-environment"},"Create Environment"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"POST /api/v1/environment")),(0,l.kt)("h3",{id:"parameters"},"Parameters"),(0,l.kt)("p",null,"Put EnvironmentSpec in request body."),(0,l.kt)("h4",{id:"environmentspec"},(0,l.kt)("strong",{parentName:"h4"},"EnvironmentSpec")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Field Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:"center"},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"Environment name."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"dockerImage"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"Docker image name."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"kernelSpec"),(0,l.kt)("td",{parentName:"tr",align:null},"KernelSpec"),(0,l.kt)("td",{parentName:"tr",align:null},"Environment spec."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"Description of environment."),(0,l.kt)("td",{parentName:"tr",align:"center"},"x")))),(0,l.kt)("h4",{id:"kernelspec"},(0,l.kt)("strong",{parentName:"h4"},"KernelSpec")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Field Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:"center"},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"Kernel name."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"channels"),(0,l.kt)("td",{parentName:"tr",align:null},"List<String",">"),(0,l.kt)("td",{parentName:"tr",align:null},"Names of the channels."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"condaDependencies"),(0,l.kt)("td",{parentName:"tr",align:null},"List<String",">"),(0,l.kt)("td",{parentName:"tr",align:null},"List of kernel conda dependencies."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"pipDependencies"),(0,l.kt)("td",{parentName:"tr",align:null},"List<String",">"),(0,l.kt)("td",{parentName:"tr",align:null},"List of kernel pip dependencies."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")))),(0,l.kt)("h3",{id:"example"},"Example"),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Request"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-shell"},'curl -X POST -H "Content-Type: application/json" -d \'\n{\n  "name": "my-submarine-env",\n  "dockerImage" : "continuumio/anaconda3",\n  "kernelSpec" : {\n    "name" : "team_default_python_3.7",\n    "channels" : ["defaults"],\n    "condaDependencies" : \n      ["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",\n      "alabaster=0.7.12=py37_0",\n      "anaconda=2020.02=py37_0",\n      "anaconda-client=1.7.2=py37_0",\n      "anaconda-navigator=1.9.12=py37_0"],\n    "pipDependencies" : \n      ["apache-submarine==0.7.0",\n      "pyarrow==0.17.0"]\n  }\n}\n\' http://127.0.0.1:32080/api/v1/environment\n')))),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Response"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n  "status": "OK",\n  "code": 200,\n  "result": {\n    "environmentId": "environment_1586156073228_0001",\n    "environmentSpec": {\n      "name": "my-submarine-env",\n      "dockerImage" : "continuumio/anaconda3",\n      "kernelSpec" : {\n        "name" : "team_default_python_3.7",\n        "channels" : ["defaults"],\n        "condaDependencies" : \n          ["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",\n          "alabaster=0.7.12=py37_0",\n          "anaconda=2020.02=py37_0",\n          "anaconda-client=1.7.2=py37_0",\n          "anaconda-navigator=1.9.12=py37_0"],\n        "pipDependencies" : \n          ["apache-submarine==0.7.0",\n          "pyarrow==0.17.0"]\n      }\n    }\n  }\n}\n')))),(0,l.kt)("h2",{id:"list-environment"},"List environment"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"GET /api/v1/environment")),(0,l.kt)("h3",{id:"example-1"},"Example"),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Request"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-shell"},"curl -X GET http://127.0.0.1:32080/api/v1/environment\n")))),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Response"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n  "status":"OK",\n  "code":200,\n  "success":true,\n  "message":null,\n  "result":[\n    {\n      "environmentId":"environment_1600862964725_0002",\n      "environmentSpec":{\n        "name":"notebook-gpu-env",\n        "dockerImage":"apache/submarine:jupyter-notebook-gpu-0.7.0",\n        "kernelSpec":{\n          "name":"submarine_jupyter_py3",\n          "channels":[\n            "defaults"\n          ],\n          "condaDependencies":[],\n          "pipDependencies":[]\n        },\n        "description":null,\n        "image":null\n      }\n    },\n    {\n      "environmentId":"environment_1647192232698_0003",\n      "environmentSpec":{\n        "name":"my-submarine-env",\n        "dockerImage":"continuumio/anaconda3",\n        "kernelSpec":{\n          "name":"team_default_python_3.7",\n          "channels":[\n            "defaults"\n          ],\n          "condaDependencies":[\n            "_ipyw_jlab_nb_ext_conf\\u003d0.1.0\\u003dpy37_0",\n            "alabaster\\u003d0.7.12\\u003dpy37_0",\n            "anaconda\\u003d2020.02\\u003dpy37_0",\n            "anaconda-client\\u003d1.7.2\\u003dpy37_0",\n            "anaconda-navigator\\u003d1.9.12\\u003dpy37_0"\n          ],\n          "pipDependencies":[\n            "apache-submarine\\u003d\\u003d0.7.0",\n            "pyarrow\\u003d\\u003d0.17.0"\n          ]\n        },\n        "description":null,\n        "image":null\n      }\n    },\n    {\n      "environmentId":"environment_1600862964725_0001",\n      "environmentSpec":{\n        "name":"notebook-env",\n        "dockerImage":"apache/submarine:jupyter-notebook-0.7.0",\n        "kernelSpec":{\n          "name":"submarine_jupyter_py3",\n          "channels":[\n            "defaults"\n          ],\n          "condaDependencies":[],\n          "pipDependencies":[]\n        },\n        "description":null,\n        "image":null\n      }\n    }\n  ],\n  "attributes":{}\n}\n')))),(0,l.kt)("h2",{id:"get-environment"},"Get environment"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"GET /api/v1/environment/{name}")),(0,l.kt)("h3",{id:"parameters-1"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Field Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"In"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:"center"},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null},"Environment name."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")))),(0,l.kt)("h3",{id:"example-2"},"Example"),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Request"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-shell"},"curl -X GET http://127.0.0.1:32080/api/v1/environment/my-submarine-env\n")))),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Response"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n  "status":"OK",\n  "code":200,\n  "success":true,\n  "message":null,\n  "result":{\n    "environmentId":"environment_1647192232698_0003",\n    "environmentSpec":{\n      "name":"my-submarine-env",\n      "dockerImage":"continuumio/anaconda3",\n      "kernelSpec":{\n        "name":"team_default_python_3.7",\n        "channels":[\n          "defaults"\n        ],\n        "condaDependencies":[\n          "_ipyw_jlab_nb_ext_conf\\u003d0.1.0\\u003dpy37_0",\n          "alabaster\\u003d0.7.12\\u003dpy37_0",\n          "anaconda\\u003d2020.02\\u003dpy37_0",\n          "anaconda-client\\u003d1.7.2\\u003dpy37_0",\n          "anaconda-navigator\\u003d1.9.12\\u003dpy37_0"\n        ],\n        "pipDependencies":[\n          "apache-submarine\\u003d\\u003d0.7.0",\n          "pyarrow\\u003d\\u003d0.17.0"\n        ]\n      },\n      "description":null,\n      "image":null\n    }\n  },\n  "attributes":{}\n}\n')))),(0,l.kt)("h2",{id:"patch-environment"},"Patch environment"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"PATCH /api/v1/environment/{name}")),(0,l.kt)("h3",{id:"parameters-2"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Field Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"In"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:"center"},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"path and body"),(0,l.kt)("td",{parentName:"tr",align:null},"Environment name."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"dockerImage"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Docker image name."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"kernelSpec"),(0,l.kt)("td",{parentName:"tr",align:null},"KernelSpec"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Environment spec."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Description of environment. This field is optional."),(0,l.kt)("td",{parentName:"tr",align:"center"},"x")))),(0,l.kt)("h3",{id:"example-3"},"Example"),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Request"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-shell"},'curl -X PATCH -H "Content-Type: application/json" -d \'\n{\n  "name": "my-submarine-env",\n  "dockerImage" : "continuumio/anaconda3",\n  "kernelSpec" : {\n    "name" : "team_default_python_3.7_updated",\n    "channels" : ["defaults"],\n    "condaDependencies" : \n      ["_ipyw_jlab_nb_ext_conf=0.1.0=py37_0",\n      "alabaster=0.7.12=py37_0"],\n    "pipDependencies" : \n      []\n  }\n}\n\' http://127.0.0.1:32080/api/v1/environment/my-submarine-env\n')))),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Response"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n  "status":"OK",\n  "code":200,\n  "success":true,\n  "message":null,\n  "result":{\n    "environmentId":"environment_1647192232698_0004",\n    "environmentSpec":{\n      "name":"my-submarine-env",\n      "dockerImage":"continuumio/anaconda3",\n      "kernelSpec":{\n        "name":"team_default_python_3.7_updated",\n        "channels":[\n          "defaults"\n        ],\n        "condaDependencies":[\n          "_ipyw_jlab_nb_ext_conf\\u003d0.1.0\\u003dpy37_0",\n          "alabaster\\u003d0.7.12\\u003dpy37_0"\n        ],\n        "pipDependencies":[]\n      },\n      "description":null,\n      "image":null\n    }\n  },\n  "attributes":{}\n}\n')))),(0,l.kt)("div",{className:"admonition admonition-note alert alert--secondary"},(0,l.kt)("div",{parentName:"div",className:"admonition-heading"},(0,l.kt)("h5",{parentName:"div"},(0,l.kt)("span",{parentName:"h5",className:"admonition-icon"},(0,l.kt)("svg",{parentName:"span",xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"},(0,l.kt)("path",{parentName:"svg",fillRule:"evenodd",d:"M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"}))),"note")),(0,l.kt)("div",{parentName:"div",className:"admonition-content"},(0,l.kt)("p",{parentName:"div"},'dockerImage, "name" (of kernelSpec), "channels", "condaDependencies", "pipDependencies" etc can be updated using this API.\n"name" of environmentSpec is not supported.'))),(0,l.kt)("h2",{id:"delete-environment"},"Delete environment"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"GET /api/v1/environment/{name}")),(0,l.kt)("h3",{id:"parameters-3"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Field Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"In"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:"center"},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"String"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null},"Environment name."),(0,l.kt)("td",{parentName:"tr",align:"center"},"o")))),(0,l.kt)("h3",{id:"example-4"},"Example"),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Request"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-shell"},"curl -X DELETE http://127.0.0.1:32080/api/v1/environment/my-submarine-env\n")))),(0,l.kt)("details",null,(0,l.kt)("summary",null,"Example Response"),(0,l.kt)("div",null,(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n  "status":"OK",\n  "code":200,\n  "success":true,\n  "message":null,\n  "result":{\n    "environmentId":"environment_1647192232698_0003",\n    "environmentSpec":{\n      "name":"my-submarine-env",\n      "dockerImage":"continuumio/anaconda3",\n      "kernelSpec":{\n        "name":"team_default_python_3.7",\n        "channels":[\n          "defaults"\n        ],\n        "condaDependencies":[\n          "_ipyw_jlab_nb_ext_conf\\u003d0.1.0\\u003dpy37_0",\n          "alabaster\\u003d0.7.12\\u003dpy37_0",\n          "anaconda\\u003d2020.02\\u003dpy37_0",\n          "anaconda-client\\u003d1.7.2\\u003dpy37_0",\n          "anaconda-navigator\\u003d1.9.12\\u003dpy37_0"\n        ],\n        "pipDependencies":[\n          "apache-submarine\\u003d\\u003d0.7.0",\n          "pyarrow\\u003d\\u003d0.17.0"\n        ]\n      },\n      "description":null,\n      "image":null\n    }\n  },\n  "attributes":{}\n}\n')))))}s.isMDXComponent=!0}}]);