Skip to content

TakeoutCreateDto

Endpoints · All schemas

FieldRequiredDescription
directoryNoAdministrators only: the directory inside the root, relative to it; empty for the root itself
nameYesA name for this import
rootIdNoAdministrators only: the permitted import root to read a server directory from

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": {
    "directory": {
      "description": "Administrators only: the directory inside the root, relative to it; empty for the root itself",
      "maxLength": 4096,
      "type": "string"
    },
    "name": {
      "description": "A name for this import",
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "rootId": {
      "description": "Administrators only: the permitted import root to read a server directory from",
      "maxLength": 32,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}