TakeoutOptionsDto

Endpoints · All schemas

Field	Required	Description
albums	No	Recreate album memberships, including for photos already in the library
archive	No	Bring over archived photos as archived
dates	No	Bring over the dates photos were taken
descriptions	No	Bring over descriptions
favorites	No	Bring over favorites
locations	No	Bring over locations
selectedAlbums	No	Album folders to recreate; omitted means every folder that is not a year folder
sidecarReview	No	Hold items whose metadata sidecars disagree for a decision; off imports them without a sidecar
updateMatchedMetadata	No	Fill metadata missing from photos already in the library; values already there are never replaced

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "albums": {
      "default": true,
      "description": "Recreate album memberships, including for photos already in the library",
      "type": "boolean"
    },
    "archive": {
      "default": true,
      "description": "Bring over archived photos as archived",
      "type": "boolean"
    },
    "dates": {
      "default": true,
      "description": "Bring over the dates photos were taken",
      "type": "boolean"
    },
    "descriptions": {
      "default": true,
      "description": "Bring over descriptions",
      "type": "boolean"
    },
    "favorites": {
      "default": true,
      "description": "Bring over favorites",
      "type": "boolean"
    },
    "locations": {
      "default": true,
      "description": "Bring over locations",
      "type": "boolean"
    },
    "selectedAlbums": {
      "description": "Album folders to recreate; omitted means every folder that is not a year folder",
      "items": {
        "maxLength": 4096,
        "type": "string"
      },
      "maxItems": 20000,
      "type": "array"
    },
    "sidecarReview": {
      "default": true,
      "description": "Hold items whose metadata sidecars disagree for a decision; off imports them without a sidecar",
      "type": "boolean"
    },
    "updateMatchedMetadata": {
      "default": false,
      "description": "Fill metadata missing from photos already in the library; values already there are never replaced",
      "type": "boolean"
    }
  },
  "type": "object"
}