albedo docs

internal transfer API reference

Generated from OpenAPI by go -C cli generate ./internal/daemon. Audience grouping does not grant or restrict access.

On this page: admitForwardedMail, collectForwardedMail, checkTransferShape, getTransferPreflight, getTransferProtocol, checkTransferProfiles, getTransfer, getTransferExport, exportTransfer, getTransferSegment, finishTransfer, getTransferImport, stageTransfer, cancelTransferImport, activateTransfer, recordTransferFamily, recordTransferOccurrences, readyTransfer, and putTransferSegment.

See API workflows for conditional edits and recovery.

admitForwardedMail

POST /mail/forwarded

Recovery: no-automatic-replay.

collectForwardedMail

POST /mail/forwarded/collect

Recovery: no-automatic-replay.

checkTransferShape

POST /transfers/check

Recovery: no-automatic-replay.

getTransferPreflight

GET /transfers/preflight

Recovery: safe-read.

getTransferProtocol

GET /transfers/protocol

Recovery: safe-read.

checkTransferProfiles

POST /transfers/runs-there

Recovery: no-automatic-replay.

getTransfer

GET /transfers/{transfer_id}

Recovery: safe-read.

getTransferExport

GET /transfers/{transfer_id}/export

Recovery: safe-read.

exportTransfer

POST /transfers/{transfer_id}/export

Recovery: no-automatic-replay.

getTransferSegment

GET /transfers/{transfer_id}/export/segments/{index}

Recovery: safe-read.

finishTransfer

POST /transfers/{transfer_id}/finish

Recovery: no-automatic-replay.

getTransferImport

GET /transfers/{transfer_id}/import

Recovery: safe-read.

stageTransfer

PUT /transfers/{transfer_id}/import

Recovery: no-automatic-replay.

cancelTransferImport

DELETE /transfers/{transfer_id}/import

Recovery: no-automatic-replay.

activateTransfer

POST /transfers/{transfer_id}/import/activate

Recovery: no-automatic-replay.

recordTransferFamily

POST /transfers/{transfer_id}/import/family

Recovery: no-automatic-replay.

recordTransferOccurrences

POST /transfers/{transfer_id}/import/occurrences

Recovery: no-automatic-replay.

readyTransfer

POST /transfers/{transfer_id}/import/ready

Recovery: no-automatic-replay.

putTransferSegment

PUT /transfers/{transfer_id}/import/segments/{index}

Recovery: no-automatic-replay.

Previous extension reference