DEdeepnote
Machines

Stop a project's editor machine

Changed on

Stops the project machine so it no longer uses machine time. Kernel state, such as variables, is lost for everyone working in the project; files in the project are kept. Stopping a machine that is not running does nothing and succeeds. This is the machine the editor, live-mode runs and hosted Streamlit apps use; machines of detached runs and interactive sessions keep running. Stop a session with DELETE /sessions/{sessionId}.

post/projects/{projectId}/machine/stop

Request

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

Path parameters

projectIdstring uuid required

ID of the project whose machine to use.

Response

Machine stop accepted

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 202

    • info

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

  • df3d4eb06bcfRevision changes
    • info

      added the required property / to the response with the status