DEdeepnote
Projects

Import a project ZIP archive

Changed on

Reconciles an existing project from the ZIP produced by project export. Before applying changes, Deepnote creates a version-history snapshot of the project's current notebook state, which can be used to restore notebooks to their pre-import state. Importing a notebook clears the outputs and execution state of all its blocks; notebooks omitted from a partial import are unchanged. Each .deepnote document must contain exactly one notebook from the target project and use the same project name and, when present, integration attachments. The project name and declared integration attachments are applied during import; changing the project name requires project rename permission. Notebooks are matched by document-facing id. Missing notebooks are left untouched unless deleteMissingNotebooks=true. Requirements are not imported.

post/projects/{projectId}/import

Request

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

Path parameters

projectIdstring uuid required

Query parameters

baseModifiedAtstring date-time

Structural version from the export this import is based on. The import returns 409 when the project structure has changed since this timestamp.

baseContentHashstring

Canonical lowercase SHA-256 hash of the exploded .deepnote documents.

Example:2f3a4b5c6d7e8f90123456789abcdef02f3a4b5c6d7e8f90123456789abcdef0

Canonical content hash from the export this import is based on. The import returns 409 when the currently exported documents differ.

deleteMissingNotebooks'true' | 'false'

Delete active project notebooks that are absent from the archive. Defaults to false, which leaves missing notebooks untouched.

force'true' | 'false'

Skip both lost-update checks and then import regardless of concurrent project changes. Defaults to false.

Request body application/zip

string binary required

ZIP archive containing one .deepnote YAML document per notebook.

Response

Project notebooks reconciled

Example response

{
  "project": {
    "contentHash": "2f3a4b5c6d7e8f90123456789abcdef02f3a4b5c6d7e8f90123456789abcdef0"
  }
}

Changes

  • 062f5f1b4638Revision changes
    • warning

      changed the pattern of the query request parameter baseModifiedAt 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))$

    • 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

  • 031374d599f3Revision changes
    • info

      endpoint added