Migrations

Start (or resume, same name and size) a chunked upload of a backup file: 16 MiB chunks, at most 25 GB per import by default

post/migrations/{migrationId}/artifacts

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/migrations/{migrationId}/artifacts
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

migrationIdstring uuid required
Example:3f2b8a4e-5c1d-4e8f-9a7b-2c6d1e0f4a5b

Request body

namestring required

File name, e.g. site.wpress, backup.sql.gz, wp-content.tar.gz

sizeinteger required

Total size in bytes

sha256string

SHA-256 of the whole file (verified after the last chunk)

role'backup' | 'database' | 'wp-content' | 'files' | 'other'

What the file contains; guessed from the name when omitted

Response

Upload started or resumed (missingChunks lists what to send)

idstring uuid required
namestring required
role'backup' | 'database' | 'wp-content' | 'files' | 'other' required
status'uploading' | 'complete' | 'failed' | 'deleted' required
sizeinteger required
receivedBytesinteger required
chunkSizeinteger required
totalChunksinteger required
missingChunksinteger[] required

chunk indexes still to upload (max 1000 listed)

sha256string nullable required

verified checksum once complete

createdAtstring required

ISO-8601 timestamp

expiresAtstring required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.