TakeoutSourceResponseDto

Endpoints · All schemas

Field	Required	Description
id	Yes	string
kind	Yes	See definition below
name	Yes	The archive’s file name, or the directory’s name
received	Yes	Bytes staged so far; an upload resumes here
rejected	Yes	Entries refused: unsafe names, links or encryption
scanned	Yes	Every entry has been read
size	Yes	Declared archive size in bytes; zero for a directory

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.

Field definitions: TakeoutSourceKind

{
  "properties": {
    "id": {
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "kind": {
      "$ref": "#/components/schemas/TakeoutSourceKind"
    },
    "name": {
      "description": "The archive’s file name, or the directory’s name",
      "type": "string"
    },
    "received": {
      "description": "Bytes staged so far; an upload resumes here",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "rejected": {
      "description": "Entries refused: unsafe names, links or encryption",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "scanned": {
      "description": "Every entry has been read",
      "type": "boolean"
    },
    "size": {
      "description": "Declared archive size in bytes; zero for a directory",
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    }
  },
  "required": [
    "id",
    "kind",
    "name",
    "received",
    "rejected",
    "scanned",
    "size"
  ],
  "type": "object"
}