DEdeepnote
Projects

Update a project

Changed on

Updates static website sharing and viewer API access settings for a project, whether hosted Streamlit apps may call the public API as their viewers, the environment its machine runs, and the folder it is in. Changing the environment restarts a running machine. Static website API access can be enabled only when sharing is already enabled or is enabled in the same request. Disabling sharing also disables API access. This settings-only patch does not create a project content version.

patch/projects/{projectId}

Request

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

Path parameters

projectIdstring uuid required

Request body

streamlitAppApiAccessEnabledboolean

Whether hosted Streamlit apps may request viewer-scoped public API tokens.

environmentIdstring uuid

Environment (Docker image) for the project machine. A running machine restarts to apply it, which clears kernel state. List the options via GET /environments.

folderIdstring uuid nullable

Folder to move the project into, or null to move it to the workspace root. Resolve a folder name to its ID via GET /folders, or create it via POST /folders.

Response

Project updated

Example response

{
  "project": {
    "staticFiles": {
      "sharingEnabled": true,
      "url": "https://deepnote.com/apps/Sales-dashboard-61a8d92e-aa72-4f2e-8dce-cb78e10ecf7c/"
    },
    "environment": {
      "id": "0b2f9c3e-6d7a-4f1e-9a8b-2c4d6e8f0a1b",
      "name": "Python 3.13 (data science)",
      "image": "deepnote/python:3.13-datascience",
      "isDefault": true
    }
  }
}

Changes

  • 062f5f1b4638Revision changes
    • info

      the / response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status

    • info

      the // response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status

  • 2fdeb3ba84a6Revision changes
    • info

      added the new optional request property /

    • info

      added the required property // to the response with the status