Skip to content
SHC Docs

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.

MethodPathResponse modelOrigin
POST/api/method/shc.backup.createMethodResponse[BackupResult]handler
POST/api/method/shc.backup.create_async{message, operation_id, status}handler
POST/api/method/shc.backup.detect_snapshotMethodResponse[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.groupMethodResponse[CreateGroupResult]handler
GET/api/method/shc.backup.group_manifest/{consistency_id}GroupManifesthandler
POST/api/method/shc.backup.importMethodResponse[BackupInfo]handler
POST/api/method/shc.backup.mountMethodResponse[MountSubprocHandle]handler
GET/api/method/shc.backup.mountsMethodResponse[MountListResponse]handler
POST/api/method/shc.backup.recoverMethodResponse[RecoverPlan]handler
POST/api/method/shc.backup.recover_async{message, operation_id, status}handler
POST/api/method/shc.backup.restoreMethodResponse[RestoreResultLocal]handler
POST/api/method/shc.backup.restore_async{message, operation_id, status}handler
POST/api/method/shc.backup.restore_from_filemap[string]anyhandler
POST/api/method/shc.backup.restore_from_file_async{message, operation_id, status}handler
POST/api/method/shc.backup.restore_group/{consistency_id}MethodResponse[GroupRestoreResult]handler
POST/api/method/shc.backup.schedule.getMethodResponse[BackupScheduleResponse]handler
GET/api/method/shc.backup.schedule.listMethodResponse[BackupScheduleListResponse]handler
POST/api/method/shc.backup.schedule.listMethodResponse[BackupScheduleListResponse]handler
POST/api/method/shc.backup.schedule.setMethodResponse[BackupScheduleResponse]handler
POST/api/method/shc.backup.schedule.unsetMethodResponse[{ok}]handler
POST/api/method/shc.backup.syncMethodResponse[BackupSyncResponse]handler
POST/api/method/shc.backup.umountMethodResponse[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[string]handler
GET/api/method/shc.operation.state/{operation_id}OperationState or Statehandler
GET/api/method/shc.operation.stream/{operation_id}SSE stream of operation progress events (see sse-streaming.md)annotation
POST/api/method/shc.pod.mountMethodResponse[VolumeMountHandle]handler
POST/api/method/shc.stack.rollbackMethodResponse[RollbackResult]handler
POST/api/method/shc.stack.rollback.listMethodResponse[{backups}]handler
POST/api/method/shc.volume.mountMethodResponse[VolumeMountHandle]handler
GET/api/method/shc.volume.mountsMethodResponse[VolumeMountListResponse]handler
POST/api/method/shc.volume.umountMethodResponse[VolumeMountHandle]handler
GET/api/resource/BackupBackupListResponsehandler
DELETE/api/resource/Backup/{backup_id}MethodResponse[string]handler
GET/api/resource/Backup/{backup_id}BackupInfohandler
GET/api/resource/Backup/{backup_id}/manifestBackupManifesthandler
GET/internal/backup/export/{backup_id}application/x-shc-bak archive download (Content-Disposition attachment; peer mTLS bridge)annotation