DEdeepnote
Machines

Get the state of a project's editor machine

Changed on

Reports whether the project machine is running, and its machine type. Cheap enough to poll while the machine starts or stops. This is the machine the editor, live-mode runs and hosted Streamlit apps use; detached runs and interactive sessions run on machines of their own, which this endpoint does not report.

get/projects/{projectId}/machine

Request

  • Base URL
    https://api.deepnote.com/v2
  • URL
    https://api.deepnote.com/v2/projects/{projectId}/machine
  • Auth
    HTTP bearer

Path parameters

projectIdstring uuid required

ID of the project whose machine to use.

Response

Current state of the project machine

Example response

{
  "machine": {
    "status": "running",
    "startingPhase": "pulling_image",
    "type": {
      "id": "fjord",
      "name": "CPU (Plus)",
      "type": "deepnote",
      "vCpus": 4,
      "memoryGiB": 16
    },
    "sandboxEnvironmentId": "deepnote",
    "idleShutdownSeconds": 900
  }
}

Changes

  • 062f5f1b4638Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      response property machine/error list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property machine/sandboxEnvironmentId list-of-types was narrowed by removing types null from media type application/json of response 200

  • df3d4eb06bcfRevision changes
    • info

      added the required property / to the response with the status