Exporte über die API¶

Diese Seite richtet sich an alle, die einen Export mit einem eigenen Programm oder von der Kommandozeile aus nehmen: anfordern, warten, bis er fertig ist, seine Teile herunterladen und einen abgebrochenen Download fortsetzen. Was ein Export ist und was er enthält, steht unter Exporte. Wie Sie eine Anfrage an OS stellen (Adresse, Anmeldung, Seiten, Fehler), steht unter Die Zugriffs-API.

Einen Export Ihrer Organisation anfordern¶

curl -s -X POST "$OS/api/v1/organisations/$ORG/exports" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" -d '{}'

{"id": "xpt_...", "scope": "organisation", "membership_id": null, "include_core": false,
 "status": "queued", "size_bytes": null, "sha256": null, "counts": {}, "withheld": {},
 "core": null, "downloads": 0, "created_at": "2026-10-17T09:14:03Z", "completed_at": null,
 "expires_at": null, "allowed_actions": ["see", "use", "write"], "...": "..."}

• Mit "membership_id": "mem_..." fordern Sie den Export eines Mitglieds an.
• "include_core": true fordert auch den Teil der KI-Funktionen an; das darf nur Artific, für alle anderen antwortet OS mit 403.

Warten, bis er fertig ist¶

curl -s "$OS/api/v1/organisations/$ORG/exports/$EXPORT" -H "Authorization: Bearer $TOKEN"

Fragen Sie etwa jede Minute erneut, bis status ready ist. Die anfordernde Person erhält auch eine Benachrichtigung. Ein failed-Export nennt den Grund in error, etwa too_large (fragen Sie Artific) oder requester_lost_access; fordern Sie einen neuen an. GET .../exports listet die Exporte der Organisation, den neuesten zuerst.

Einen Teil herunterladen¶

curl -s -o export-os.zip "$OS/api/v1/organisations/$ORG/exports/$EXPORT/parts/os" \
  -H "Authorization: Bearer $TOKEN" -D headers.txt

• Die Teile sind os und, wenn er angefordert wurde, core.
• Digest: sha-256=<hex> ist der SHA-256 des ganzen Teils: vergleichen Sie ihn mit dem Ihrer Datei.
• Sie brauchen use auf export; ohne antwortet OS mit 403.

Einen abgebrochenen Download fortsetzen¶

size=$(wc -c < export-os.zip)
curl -s "$OS/api/v1/organisations/$ORG/exports/$EXPORT/parts/os" \
  -H "Authorization: Bearer $TOKEN" -H "Range: bytes=$size-" >> export-os.zip

Ein Download darf bis zu sechs Stunden dauern und endet, wenn eine Minute lang kein Byte ankommt. Setzen Sie ihn so oft fort, wie Sie brauchen, bis der Export abläuft.

Ihr eigener Export¶

curl -s -X POST "$OS/api/v1/me/exports" -H "Authorization: Bearer $TOKEN"
curl -s "$OS/api/v1/me/exports/$EXPORT" -H "Authorization: Bearer $TOKEN"

{"id": "pxp_...", "status": "ready", "size_bytes": 18230, "sha256": "...",
 "parts": [{"organisation_id": "org_...", "include_core": true, "ready": true}],
 "expires_at": "2026-10-20T09:21:40Z", "...": "..."}

Während Sie gelöscht werden, antwortet OS mit 409, und Sie fordern keinen neuen Export an.