Jupyter
App · 20 actions
Manage Jupyter Server notebooks, files, kernels and sessions.
Actions
| Action | What it does |
|---|---|
| Create contents | Create contents. |
| Create session | Create session. |
| Delete contents | Delete contents. |
| Delete session | Delete session. |
| Get contents | Get contents. |
| Get kernel | Get kernel. |
| Get session | Get session. |
| Get status | Get status. |
| Interrupt kernel | Interrupt kernel. |
| List checkpoints | List checkpoints. |
| List kernel specs | List kernel specs. |
| List kernels | List kernels. |
| List sessions | List sessions. |
| Rename contents | Rename contents. |
| Restart kernel | Restart kernel. |
| Save file | Save file. |
| Save notebook | Save the complete notebook JSON. |
| Shutdown kernel | Shutdown kernel. |
| Start kernel | Start kernel. |
| Update session | Update session. |
Create contents
Create contents.
Inputs
- Path
pathtextRequired - Path.
- Content type
content_typetext - Content type.One of:
notebook,file,directory. - Extension
extensiontext - Extension.
- Copy from
copy_fromtext - Copy from.
Outputs
dataobject- Service response.
Example output
{
"data": {
"content": {},
"format": "example",
"last_modified": "example",
"name": "example",
"path": "example",
"type": "example"
}
}Create session
Create session.
Inputs
- Path
pathtextRequired - Path.
- Name
nametext - Name.
- Session type
session_typetextRequired - Session type.One of:
notebook,console,file. - Kernel name
kernel_nametext - Kernel name.
Outputs
dataobject- Service response.
Example output
{
"data": {
"id": "example",
"kernel": {
"execution_state": "example",
"id": "example",
"name": "example"
},
"name": "example",
"path": "example",
"type": "example"
}
}Delete contents
Delete contents.
Inputs
- Path
pathtextRequired - file path
Outputs
dataobject- Service response.
Example output
{
"data": {}
}Delete session
Delete session.
Inputs
- Session
session_idtextRequired - session uuid
Outputs
dataobject- Service response.
Example output
{
"data": {}
}Get contents
Get contents.
Inputs
- Path
pathtextRequired - file path
- Type
typetext - File type ('file', 'directory')One of:
notebook,file,directory. - Format
formattext - How file content should be returned ('text', 'base64')One of:
json,text,base64. - Content
contentnumber - Return content (0 for no content, 1 for return content)
- Hash
hashnumber - May return hash hexdigest string of content and the hash algorithm (0 for no hash - default, 1 for return hash). It may be ignored by the content manager.
Outputs
dataobject- Service response.
Example output
{
"data": {
"content": {},
"format": "example",
"last_modified": "example",
"name": "example",
"path": "example",
"type": "example"
}
}Get kernel
Get kernel.
Inputs
- Kernel
kernel_idtextRequired - kernel uuid
Outputs
dataobject- Service response.
Example output
{
"data": {
"execution_state": "example",
"id": "example",
"name": "example"
}
}Get session
Get session.
Inputs
- Session
session_idtextRequired - session uuid
Outputs
dataobject- Service response.
Example output
{
"data": {
"id": "example",
"kernel": {
"execution_state": "example",
"id": "example",
"name": "example"
},
"name": "example",
"path": "example",
"type": "example"
}
}Get status
Get status.
Inputs
None.
Outputs
dataobject- Service response.
Example output
{
"data": {}
}Interrupt kernel
Interrupt kernel.
Inputs
- Kernel
kernel_idtextRequired - kernel uuid
Outputs
dataobject- Service response.
Example output
{
"data": {}
}List checkpoints
List checkpoints. Returns one page; use the continuation fields for more results.
Inputs
- Path
pathtextRequired - file path
Outputs
datalist- Service response.
Example output
{
"data": []
}List kernel specs
List kernel specs. Returns one page; use the continuation fields for more results.
Inputs
None.
Outputs
dataobject- Service response.
Example output
{
"data": {}
}List kernels
List kernels. Returns one page; use the continuation fields for more results.
Inputs
None.
Outputs
datalist- Service response.
Example output
{
"data": []
}List sessions
List sessions. Returns one page; use the continuation fields for more results.
Inputs
None.
Outputs
datalist- Service response.
Example output
{
"data": []
}Rename contents
Rename contents.
Inputs
- Path
pathtextRequired - Path.
- New path
new_pathtextRequired - New path.
Outputs
dataobject- Service response.
Example output
{
"data": {
"content": {},
"format": "example",
"last_modified": "example",
"name": "example",
"path": "example",
"type": "example"
}
}Restart kernel
Restart kernel.
Inputs
- Kernel
kernel_idtextRequired - kernel uuid
Outputs
dataobject- Service response.
Example output
{
"data": {
"execution_state": "example",
"id": "example",
"name": "example"
}
}Save file
Save file.
Inputs
- Path
pathtextRequired - Path.
- Content
contenttextRequired - The complete file text. Replaces all existing file content.
Outputs
dataobject- Service response.
Example output
{
"data": {
"content": {},
"format": "example",
"last_modified": "example",
"name": "example",
"path": "example",
"type": "example"
}
}Save notebook
Save the complete notebook JSON. Replaces all existing notebook content.
Inputs
- Path
pathtextRequired - Path.
- Content
contentobjectRequired - Complete nbformat notebook object, including cells and metadata.
Outputs
dataobject- Service response.
Example output
{
"data": {
"content": {},
"format": "example",
"last_modified": "example",
"name": "example",
"path": "example",
"type": "example"
}
}Shutdown kernel
Shutdown kernel.
Inputs
- Kernel
kernel_idtextRequired - kernel uuid
Outputs
dataobject- Service response.
Example output
{
"data": {}
}Start kernel
Start kernel.
Inputs
- Name
nametext - Name.
- Path
pathtext - Path.
Outputs
dataobject- Service response.
Example output
{
"data": {
"execution_state": "example",
"id": "example",
"name": "example"
}
}Update session
Update session.
Inputs
- Session
session_idtextRequired - Session id.
- Path
pathtext - Path.
- Name
nametext - Name.
- Session type
session_typetext - Session type.One of:
notebook,console,file.
Outputs
dataobject- Service response.
Example output
{
"data": {
"id": "example",
"kernel": {
"execution_state": "example",
"id": "example",
"name": "example"
},
"name": "example",
"path": "example",
"type": "example"
}
}