Exports via de API¶

Deze pagina is voor wie een export neemt met een eigen programma of vanaf de opdrachtregel: er een aanvragen, wachten tot hij klaar is, de delen downloaden en een afgebroken download hervatten. Wat een export is en wat erin zit staat in Exports. Hoe je een verzoek aan OS doet (adres, inloggen, pagina's, fouten) staat in De toegangs-API.

Een export van je organisatie aanvragen¶

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"], "...": "..."}

• Noem "membership_id": "mem_..." voor een export van één lid.
• "include_core": true vraagt ook het deel van de AI-functies aan; alleen Artific mag dat, dus voor ieder ander antwoordt OS 403.

Wachten tot hij klaar is¶

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

Vraag elke minuut of zo opnieuw tot status ready is. De aanvrager krijgt ook een melding. Een export met failed zegt in error waarom, zoals too_large (vraag Artific) of requester_lost_access; vraag een nieuwe aan. GET .../exports geeft de exports van de organisatie, de nieuwste eerst.

Een deel downloaden¶

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

• De delen zijn os en, als het is aangevraagd, core.
• Digest: sha-256=<hex> is de SHA-256 van het hele deel: vergelijk hem met die van je bestand.
• Je hebt use op export nodig; zonder antwoordt OS 403.

Een afgebroken download hervatten¶

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

Een download mag tot zes uur duren, en stopt als er een minuut geen byte komt. Hervat hem zo vaak als nodig tot de export verloopt.

Je eigen 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", "...": "..."}

Terwijl je gewist wordt antwoordt OS 409, en vraag je geen nieuwe export aan.