Pre-release. HostCraft is in testing and not yet for sale. These docs describe the current build and may change. Join the waitlist to hear when it launches.
Transfer API
Source: daemon/proto/hostcraft/v1/transfer.proto
TransferService
Section titled “TransferService”TransferService drives the live WHM transfer tool: remote cPanel/WHM sources reached over SSH, batch queues that pkgacct and restore each account, and the final delta sync before cutover. REST: /api/v1/restore/transfer.
| Method | REST route | Permission | Streaming |
|---|---|---|---|
ListTransferSources |
GET /api/v1/restore/transfer/sources |
RestoreTransferRead |
unary |
CreateTransferSource |
POST /api/v1/restore/transfer/sources |
RestoreTransferManage |
unary |
GetTransferSource |
GET /api/v1/restore/transfer/sources/{id} |
RestoreTransferRead |
unary |
DeleteTransferSource |
DELETE /api/v1/restore/transfer/sources/{id} |
RestoreTransferManage |
unary |
TestTransferSource |
POST /api/v1/restore/transfer/sources/{id}/test |
RestoreTransferManage |
unary |
RepinTransferSourceHostKey |
POST /api/v1/restore/transfer/sources/{id}/repin |
RestoreTransferManage |
unary |
ListTransferRemoteAccounts |
GET /api/v1/restore/transfer/sources/{id}/accounts |
RestoreTransferRead |
unary |
ListTransferBatches |
GET /api/v1/restore/transfer/batches |
RestoreTransferRead |
unary |
CreateTransferBatch |
POST /api/v1/restore/transfer/batches |
RestoreTransferManage |
unary |
GetTransferBatch |
GET /api/v1/restore/transfer/batches/{id} |
RestoreTransferRead |
unary |
CancelTransferBatch |
POST /api/v1/restore/transfer/batches/{id}/cancel |
RestoreTransferManage |
unary |
SyncTransferBatch |
POST /api/v1/restore/transfer/batches/{id}/sync |
RestoreTransferManage |
unary |
RetryTransferItem |
POST /api/v1/restore/transfer/items/{id}/retry |
RestoreTransferManage |
unary |
SyncTransferItem |
POST /api/v1/restore/transfer/items/{id}/sync |
RestoreTransferManage |
unary |
ListTransferSources
Section titled “ListTransferSources”/hostcraft.v1.TransferService/ListTransferSources
- Request: ListTransferSourcesRequest
- Response: ListTransferSourcesResponse
CreateTransferSource
Section titled “CreateTransferSource”/hostcraft.v1.TransferService/CreateTransferSource
- Request: CreateTransferSourceRequest
- Response: TransferSource
GetTransferSource
Section titled “GetTransferSource”/hostcraft.v1.TransferService/GetTransferSource
- Request: GetTransferSourceRequest
- Response: TransferSource
DeleteTransferSource
Section titled “DeleteTransferSource”/hostcraft.v1.TransferService/DeleteTransferSource
- Request: DeleteTransferSourceRequest
- Response: Empty
TestTransferSource
Section titled “TestTransferSource”/hostcraft.v1.TransferService/TestTransferSource
- Request: TestTransferSourceRequest
- Response: TransferSource
RepinTransferSourceHostKey
Section titled “RepinTransferSourceHostKey”/hostcraft.v1.TransferService/RepinTransferSourceHostKey
- Request: RepinTransferSourceHostKeyRequest
- Response: TransferSource
ListTransferRemoteAccounts
Section titled “ListTransferRemoteAccounts”/hostcraft.v1.TransferService/ListTransferRemoteAccounts
- Request: ListTransferRemoteAccountsRequest
- Response: ListTransferRemoteAccountsResponse
ListTransferBatches
Section titled “ListTransferBatches”/hostcraft.v1.TransferService/ListTransferBatches
- Request: ListTransferBatchesRequest
- Response: ListTransferBatchesResponse
CreateTransferBatch
Section titled “CreateTransferBatch”/hostcraft.v1.TransferService/CreateTransferBatch
- Request: CreateTransferBatchRequest
- Response: TransferBatch
GetTransferBatch
Section titled “GetTransferBatch”/hostcraft.v1.TransferService/GetTransferBatch
- Request: GetTransferBatchRequest
- Response: TransferBatch
CancelTransferBatch
Section titled “CancelTransferBatch”/hostcraft.v1.TransferService/CancelTransferBatch
- Request: CancelTransferBatchRequest
- Response: TransferBatch
SyncTransferBatch
Section titled “SyncTransferBatch”/hostcraft.v1.TransferService/SyncTransferBatch
- Request: SyncTransferBatchRequest
- Response: SyncTransferBatchResponse
RetryTransferItem
Section titled “RetryTransferItem”/hostcraft.v1.TransferService/RetryTransferItem
- Request: RetryTransferItemRequest
- Response: TransferItem
SyncTransferItem
Section titled “SyncTransferItem”/hostcraft.v1.TransferService/SyncTransferItem
- Request: SyncTransferItemRequest
- Response: TransferItem
Messages
Section titled “Messages”CancelTransferBatchRequest
Section titled “CancelTransferBatchRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
CreateTransferBatchRequest
Section titled “CreateTransferBatchRequest”| Field | Type | Number | Description |
|---|---|---|---|
source_id |
string |
1 | - |
accounts |
repeated TransferBatchAccount |
2 | - |
concurrency |
int64 |
3 | - |
target_plan_id |
string |
4 | - |
target_reseller_id |
string |
5 | - |
limit_overrides |
RestoreLimits |
6 | - |
include_mail |
bool |
7 | - |
include_dbs |
bool |
8 | - |
include_dns |
bool |
9 | - |
include_ssl |
bool |
10 | - |
include_cron |
bool |
11 | - |
include_ftp |
bool |
12 | - |
ssl_via_letsencrypt |
bool |
13 | - |
CreateTransferSourceRequest
Section titled “CreateTransferSourceRequest”| Field | Type | Number | Description |
|---|---|---|---|
name |
string |
1 | - |
host |
string |
2 | - |
ssh_port |
int64 |
3 | - |
ssh_user |
string |
4 | - |
password |
string |
5 | - |
private_key |
string |
6 | - |
passphrase |
string |
7 | - |
host_key_fingerprint |
string |
8 | - |
whm_token |
string |
9 | - |
whm_port |
int64 |
10 | - |
whm_insecure_tls |
bool |
11 | - |
DeleteTransferSourceRequest
Section titled “DeleteTransferSourceRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
Empty is returned by RPCs whose REST route answers with an empty object or 204 No Content.
No fields.
GetTransferBatchRequest
Section titled “GetTransferBatchRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
GetTransferSourceRequest
Section titled “GetTransferSourceRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
ListTransferBatchesRequest
Section titled “ListTransferBatchesRequest”No fields.
ListTransferBatchesResponse
Section titled “ListTransferBatchesResponse”| Field | Type | Number | Description |
|---|---|---|---|
batches |
repeated TransferBatch |
1 | - |
ListTransferRemoteAccountsRequest
Section titled “ListTransferRemoteAccountsRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
ListTransferRemoteAccountsResponse
Section titled “ListTransferRemoteAccountsResponse”| Field | Type | Number | Description |
|---|---|---|---|
accounts |
repeated TransferRemoteAccount |
1 | - |
ListTransferSourcesRequest
Section titled “ListTransferSourcesRequest”No fields.
ListTransferSourcesResponse
Section titled “ListTransferSourcesResponse”| Field | Type | Number | Description |
|---|---|---|---|
sources |
repeated TransferSource |
1 | - |
RepinTransferSourceHostKeyRequest
Section titled “RepinTransferSourceHostKeyRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
host_key_fingerprint |
string |
2 | - |
RestoreLimits
Section titled “RestoreLimits”| Field | Type | Number | Description |
|---|---|---|---|
disk_quota_bytes |
int64 |
1 | - |
bandwidth_quota_bytes |
int64 |
2 | - |
max_sites |
int64 |
3 | - |
max_mailboxes |
int64 |
4 | - |
max_databases |
int64 |
5 | - |
max_subdomains |
int64 |
6 | - |
max_addon_domains |
int64 |
7 | - |
max_subusers |
int64 |
8 | - |
max_cron_jobs |
int64 |
9 | - |
max_ftp_users |
int64 |
10 | - |
RetryTransferItemRequest
Section titled “RetryTransferItemRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
SyncTransferBatchRequest
Section titled “SyncTransferBatchRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
SyncTransferBatchResponse
Section titled “SyncTransferBatchResponse”| Field | Type | Number | Description |
|---|---|---|---|
started |
int64 |
1 | - |
SyncTransferItemRequest
Section titled “SyncTransferItemRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
TestTransferSourceRequest
Section titled “TestTransferSourceRequest”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
TransferBatch
Section titled “TransferBatch”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
source_id |
string |
2 | - |
concurrency |
int64 |
3 | - |
status |
string |
4 | - |
created_at |
google.protobuf.Timestamp |
5 | - |
finished_at |
google.protobuf.Timestamp |
6 | - |
counts |
map<string, int64> |
7 | - |
items |
repeated TransferItem |
8 | - |
TransferBatchAccount
Section titled “TransferBatchAccount”| Field | Type | Number | Description |
|---|---|---|---|
user |
string |
1 | - |
domain |
string |
2 | - |
TransferItem
Section titled “TransferItem”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
batch_id |
string |
2 | - |
remote_user |
string |
3 | - |
remote_domain |
string |
4 | - |
status |
string |
5 | - |
error |
string |
6 | - |
archive_bytes |
int64 |
7 | - |
restore_source_id |
string |
8 | - |
restore_job_id |
string |
9 | - |
account_id |
string |
10 | - |
started_at |
google.protobuf.Timestamp |
11 | - |
finished_at |
google.protobuf.Timestamp |
12 | - |
sync_status |
string |
13 | - |
sync_error |
string |
14 | - |
sync_workflow_id |
string |
15 | - |
last_sync_at |
google.protobuf.Timestamp |
16 | - |
TransferRemoteAccount
Section titled “TransferRemoteAccount”| Field | Type | Number | Description |
|---|---|---|---|
user |
string |
1 | - |
domain |
string |
2 | - |
owner |
string |
3 | - |
plan |
string |
4 | - |
email |
string |
5 | - |
disk_used_bytes |
int64 |
6 | - |
suspended |
bool |
7 | - |
TransferSource
Section titled “TransferSource”| Field | Type | Number | Description |
|---|---|---|---|
id |
string |
1 | - |
name |
string |
2 | - |
host |
string |
3 | - |
ssh_port |
int64 |
4 | - |
ssh_user |
string |
5 | - |
auth_method |
string |
6 | password | key |
host_key_fingerprint |
string |
7 | - |
whm_port |
int64 |
8 | - |
whm_insecure_tls |
bool |
9 | - |
has_whm_token |
bool |
10 | - |
created_at |
google.protobuf.Timestamp |
11 | - |
last_checked_at |
google.protobuf.Timestamp |
12 | - |
last_check_error |
string |
13 | - |