Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Data Migration

Create a Migration

Initiate a migration of data from an external provider into Telnyx Cloud Storage. Currently, only S3 is supported.

post/storage/migrations

Request body

bytes_migratedinteger

Total amount of data that has been succesfully migrated.

bytes_to_migrateinteger

Total amount of data found in source bucket to migrate.

created_atstring date-time

Time when data migration was created

etastring date-time

Estimated time the migration will complete.

idstring

Unique identifier for the data migration.

last_copystring date-time

Time when data migration was last copied from the source.

refreshboolean

If true, will continue to poll the source bucket to ensure new data is continually migrated over.

source_idstring required

ID of the Migration Source from which to migrate data.

speedinteger

Current speed of the migration.

status'pending' | 'checking' | 'migrating' | 'complete' | 'error' | 'stopped'

Status of the migration.

target_bucket_namestring required

Bucket name to migrate the data into. Will default to the same name as the source_bucket_name.

target_regionstring required

Telnyx Cloud Storage region to migrate the data to.

Example request

{
  "created_at": "2020-01-01T00:00:00Z",
  "eta": "2020-01-01T00:00:00Z",
  "last_copy": "2020-01-01T00:00:00Z"
}

Response

Create Migration Response

Example response

{
  "data": {
    "created_at": "2020-01-01T00:00:00Z",
    "eta": "2020-01-01T00:00:00Z",
    "last_copy": "2020-01-01T00:00:00Z"
  }
}