Notebook REST API
caution
The Notebook API is in the alpha stage which is subjected to incompatible changes in future releases.
Create a notebook instance
POST /api/v1/notebook
Parameters
NotebookSpec in request body.
NotebookSpec
Field Name | Type | Description | Required |
---|---|---|---|
meta | NotebookMeta | Meta data of the notebook. | o |
environment | EnvironmentSpec | Environment of the experiment template. | o |
spec | NotebookPodSpec | Spec of the notebook pods. | o |
NotebookMeta
Field Name | Type | Description | Required |
---|---|---|---|
name | String | Notebook name. | o |
namespace | String | Notebook namespace. | o |
ownerId | String | User id. | o |
EnvironmentSpec
See more details in environment api.
NotebookPodSpec
Field Name | Type | Description | Required |
---|---|---|---|
envVars | Map<String, String> | Environmental variables. | x |
resources | String | Resourecs of the pod. | o |
Example
Example Request
Example Response
List notebook instances which belong to user
GET /api/v1/notebook?id={user_id}
Parameters
Field Name | Type | In | Description | Required |
---|---|---|---|---|
id | String | query | User id. | o |
Example
Example Request
Example Response
Get the notebook instance
GET /api/v1/notebook/{id}
Parameters
Field Name | Type | In | Description | Required |
---|---|---|---|---|
id | String | path | Notebook id. | o |
Example
Example Request
Example Response
Delete the notebook instance
DELETE /api/v1/notebook/{id}
Parameters
Field Name | Type | In | Description | Required |
---|---|---|---|---|
id | String | path | Notebook id. | o |