Skip To Content
ArcGIS Developer
Dashboard

Container Sessions

Description

When an ArcGIS Notebook is opened in a container, a computational engine called a kernel is launched; the kernel runs while the notebook is active and executes all the work done by the notebook. This resource tracks the active kernels running in the specified container to provide information about current notebook sessions.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json | pjson

Response properties

PropertyDetails
ID

The unique ID string for the container session.

path

The working path to the running ArcGIS Notebook, ending in .ipynb.

kernel

Properties describing the kernel. They are as follows:

  • last_activity—The date and time of the most recent action performed by the kernel.
  • name—The name of the kernel. At 10.7, this value is python3.
  • id—The unique ID string for the kernel.
  • execution_state—Whether the kernel is currently executing an action or is idle.
  • connections—The number of users currently accessing the notebook.

JSON Response syntax

{
  "sessions": [
    {
      "path": "<notebook path>",
      "kernel": {
        "last_activity": "<timestamp of most recent action>",
        "name": "python3",
        "id": "<kernel ID>",
        "execution_state": "<status>",
        "connections": <integer>
      },
      "name": "",
      "id": "<session ID>",
      "type": "notebook"
    }
  ]
}

JSON Response example

{
  "sessions": [
    {
      "path": "4ea4aae5d60247cb8af7146b0f7f64e4.ipynb",
      "kernel": {
        "last_activity": "2019-01-01T00:00:00.705020Z",
        "name": "python3",
        "id": "12464d15-b579-4495-865f-31aae936bef8",
        "execution_state": "idle",
        "connections": 0
      },
      "name": "",
      "id": "7b3c6009-b226-47b5-bff4-3c8fd3472d44",
      "type": "notebook"
    }
  ]
}