Transfer
7 operations generated from the Engine OpenAPI schema. Request and response model names can be expanded in the interactive schema.
POST /api/v1/servers/{id}/transfer
Transfer configuration between servers.
Moves selected configuration inside the current engine instance. When VOD source or remux content is selected, the target server starts an asynchronous authenticated HTTP pull directly from the source server. Each VOD asset remains owned by the source until its staged files, metadata, SHA-256 checksums, and manifest are verified and committed on the target. The response contains a VOD job snapshot that can be polled and retried.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Source server ID |
request | body | app.ServerConfigTransferRequest | Yes | Transfer options |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
GET /api/v1/servers/{id}/transfers/{request_id}/vod
Get target-side VOD transfer progress.
Proxies the target server’s in-memory HTTP pull job snapshot. The response includes total bytes, percentage, completed/partial/failed counts, per-VOD stages, retained partial bytes, retry counts, and exact failure messages. Completed jobs remain available in target memory for 24 hours.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | Source server ID |
request_id | path | string | Yes | VOD transfer request ID |
target_server_id | query | integer | Yes | Target server ID that owns the in-memory transfer job |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/servers/{id}/transfers/{request_id}/vod/retry
Retry failed or partial VOD transfer assets.
Restarts only failed or partial assets in an existing target-side job. Matching staging files resume with HTTP Range from the retained byte offset; stale partial files are discarded when source size, mtime, ETag, or SHA-256 metadata changed. Successful assets are not transferred again.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | Source server ID |
request_id | path | string | Yes | VOD transfer request ID |
target_server_id | query | integer | Yes | Target server ID that owns the in-memory transfer job |
Responses
| Status | Description | Schema |
|---|---|---|
202 | Accepted | route.APIResponse + object |
POST /api/v1/streams/transfer
Copy or transfer streams to another instance.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
request | body | app.StreamTransferRequest | Yes | Target instance and stream transfer options |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
GET /api/v1/transfers/capabilities
Get transfer API capabilities.
Authentication: Authorization header (ApiKeyAuth)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/transfers/capabilities/check
Check a remote instance’s transfer capabilities.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
request | body | app.TransferCapabilityRequest | Yes | Remote instance and API key |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/transfers/streams/import
Import a stream transfer bundle.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
bundle | body | app.StreamTransferBundle | Yes | Stream transfer bundle |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |