Jupyter

App · 20 actions

Manage Jupyter Server notebooks, files, kernels and sessions.

Actions

ActionWhat it does
Create contentsCreate contents.
Create sessionCreate session.
Delete contentsDelete contents.
Delete sessionDelete session.
Get contentsGet contents.
Get kernelGet kernel.
Get sessionGet session.
Get statusGet status.
Interrupt kernelInterrupt kernel.
List checkpointsList checkpoints.
List kernel specsList kernel specs.
List kernelsList kernels.
List sessionsList sessions.
Rename contentsRename contents.
Restart kernelRestart kernel.
Save fileSave file.
Save notebookSave the complete notebook JSON.
Shutdown kernelShutdown kernel.
Start kernelStart kernel.
Update sessionUpdate session.

Create contents

Create contents.

Inputs

PathpathtextRequired
Path.
Content typecontent_typetext
Content type.One of: notebook, file, directory.
Extensionextensiontext
Extension.
Copy fromcopy_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

PathpathtextRequired
Path.
Namenametext
Name.
Session typesession_typetextRequired
Session type.One of: notebook, console, file.
Kernel namekernel_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

PathpathtextRequired
file path

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Delete session

Delete session.

Inputs

Sessionsession_idtextRequired
session uuid

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Get contents

Get contents.

Inputs

PathpathtextRequired
file path
Typetypetext
File type ('file', 'directory')One of: notebook, file, directory.
Formatformattext
How file content should be returned ('text', 'base64')One of: json, text, base64.
Contentcontentnumber
Return content (0 for no content, 1 for return content)
Hashhashnumber
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

Kernelkernel_idtextRequired
kernel uuid

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "execution_state": "example",
    "id": "example",
    "name": "example"
  }
}

Get session

Get session.

Inputs

Sessionsession_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

Kernelkernel_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

PathpathtextRequired
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

PathpathtextRequired
Path.
New pathnew_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

Kernelkernel_idtextRequired
kernel uuid

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "execution_state": "example",
    "id": "example",
    "name": "example"
  }
}

Save file

Save file.

Inputs

PathpathtextRequired
Path.
ContentcontenttextRequired
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

PathpathtextRequired
Path.
ContentcontentobjectRequired
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

Kernelkernel_idtextRequired
kernel uuid

Outputs

dataobject
Service response.
Example output
{
  "data": {}
}

Start kernel

Start kernel.

Inputs

Namenametext
Name.
Pathpathtext
Path.

Outputs

dataobject
Service response.
Example output
{
  "data": {
    "execution_state": "example",
    "id": "example",
    "name": "example"
  }
}

Update session

Update session.

Inputs

Sessionsession_idtextRequired
Session id.
Pathpathtext
Path.
Namenametext
Name.
Session typesession_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"
  }
}

On this page