backup response models
Generated file. Do not edit by hand. Regenerate from the repo root with
CGO_ENABLED=0 go run scripts/gen-response-models-md.go.
Part of the API response model reference, which explains the Response model and Origin columns. Route inventory: routes.md. Named payload structs: payload-shapes.md.
| Method | Path | Response model | Origin |
|---|---|---|---|
POST | /api/method/shc.backup.create | MethodResponse[BackupResult] | handler |
POST | /api/method/shc.backup.create_async | {message, operation_id, status} | handler |
POST | /api/method/shc.backup.detect_snapshot | MethodResponse[SnapshotCapability] | handler |
GET | /api/method/shc.backup.export/{backup_id} | application/x-shc-bak archive download (Content-Disposition attachment) | annotation |
POST | /api/method/shc.backup.group | MethodResponse[CreateGroupResult] | handler |
GET | /api/method/shc.backup.group_manifest/{consistency_id} | GroupManifest | handler |
POST | /api/method/shc.backup.import | MethodResponse[BackupInfo] | handler |
POST | /api/method/shc.backup.import_async | {message, operation_id, status} | handler |
POST | /api/method/shc.backup.import_store | MethodResponse[StoreSweepReport] | handler |
POST | /api/method/shc.backup.import_store_async | {message, operation_id, status} | handler |
GET | /api/method/shc.backup.key.ls | MethodResponse[KeyListResponse] | handler |
POST | /api/method/shc.backup.key.rm | MethodResponse[string] | handler |
POST | /api/method/shc.backup.key.rotate | MethodResponse[KeyRotateResult] | handler |
POST | /api/method/shc.backup.mirror | MethodResponse[MirrorResult] | handler |
POST | /api/method/shc.backup.mirror_async | {message, operation_id, status} | handler |
POST | /api/method/shc.backup.mount | MethodResponse[MountSubprocHandle] | handler |
GET | /api/method/shc.backup.mounts | MethodResponse[MountListResponse] | handler |
GET | /api/method/shc.backup.orphan.list | OrphanPage | handler |
POST | /api/method/shc.backup.orphan.scan | {operation_id} | handler |
POST | /api/method/shc.backup.prune | MethodResponse[PruneResult] | handler |
POST | /api/method/shc.backup.recover | MethodResponse[RecoverPlan] | handler |
POST | /api/method/shc.backup.recover_async | {message, operation_id, status} | handler |
POST | /api/method/shc.backup.relocate | MethodResponse[RelocateResult] | handler |
POST | /api/method/shc.backup.restore | MethodResponse[RestoreResultLocal] | handler |
POST | /api/method/shc.backup.restore_as_new | {message, operation_id, status} | handler |
POST | /api/method/shc.backup.restore_async | {message, operation_id, status} | handler |
POST | /api/method/shc.backup.restore_from_file | MethodResponse[RestoreResultLocal] | handler |
POST | /api/method/shc.backup.restore_from_file_async | {message, operation_id, status} | handler |
GET | /api/method/shc.backup.restore_from_file_check | MethodResponse[RestoreFromFileCheck] | handler |
POST | /api/method/shc.backup.restore_group/{consistency_id} | MethodResponse[GroupRestoreResult] | handler |
POST | /api/method/shc.backup.restore_group_async/{consistency_id} | {message, operation_id, status} | handler |
POST | /api/method/shc.backup.schedule.get | MethodResponse[BackupScheduleResponse] | handler |
GET | /api/method/shc.backup.schedule.list | MethodResponse[BackupScheduleListResponse] | handler |
POST | /api/method/shc.backup.schedule.list | MethodResponse[BackupScheduleListResponse] | handler |
POST | /api/method/shc.backup.schedule.run | MethodResponse[BackupScheduleRunResponse] | handler |
POST | /api/method/shc.backup.schedule.set | MethodResponse[BackupScheduleResponse] | handler |
POST | /api/method/shc.backup.schedule.unset | MethodResponse[{ok}] | handler |
POST | /api/method/shc.backup.sync | MethodResponse[BackupSyncResponse] | handler |
POST | /api/method/shc.backup.umount | MethodResponse[MountSubprocHandle] | handler |
POST | /api/method/shc.backup.ungroup/{group_id} | no success body; always the 501 coded error X501400UNGFIL (endpoint intentionally unimplemented) | annotation |
POST | /api/method/shc.backup.verify/{backup_id} | MethodResponse[VerifyReport] | handler |
POST | /api/method/shc.operation.cancel/{operation_id} | MethodResponse[OperationCancelResponse] | handler |
GET | /api/method/shc.operation.state/{operation_id} | OperationState or RawMessage or State | handler |
GET | /api/method/shc.operation.stream/{operation_id} | SSE stream of operation progress events (see sse-streaming.md) | annotation |
POST | /api/method/shc.pod.mount | MethodResponse[VolumeMountHandle] | handler |
POST | /api/method/shc.stack.rollback | MethodResponse[RollbackResult] | handler |
POST | /api/method/shc.stack.rollback.list | MethodResponse[{backups}] | handler |
POST | /api/method/shc.stack.rollback_async | {message, operation_id, status} | handler |
GET | /api/method/shc.volume.files.get | the file’s bytes, a download (Content-Disposition attachment; a Range header answers 206) | annotation |
GET | /api/method/shc.volume.files.ls | MethodResponse[VolumeFileListing] | handler |
POST | /api/method/shc.volume.files.mv | MethodResponse[VolumeFilesWriteResult] | handler |
POST | /api/method/shc.volume.files.put | MethodResponse[VolumeFilesWriteResult] | handler |
POST | /api/method/shc.volume.files.rm | MethodResponse[VolumeFilesRmResult] | handler |
GET | /api/method/shc.volume.files.volumes | MethodResponse[VolumeFilesVolumesResult] | handler |
POST | /api/method/shc.volume.mount | MethodResponse[VolumeMountHandle] | handler |
GET | /api/method/shc.volume.mounts | MethodResponse[VolumeMountListResponse] | handler |
POST | /api/method/shc.volume.umount | MethodResponse[VolumeMountHandle] | handler |
GET | /api/resource/Backup | BackupListResponse | handler |
DELETE | /api/resource/Backup/{backup_id} | MethodResponse[string] | handler |
GET | /api/resource/Backup/{backup_id} | BackupInfo | handler |
GET | /api/resource/Backup/{backup_id}/manifest | BackupManifest | handler |
shc@docs:~$