Skip to main content
POST
/
storage
/
migrations
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const migration = await client.storage.migrations.create({
  source_id: 'source_id',
  target_bucket_name: 'target_bucket_name',
  target_region: 'target_region',
});

console.log(migration.data);
{
  "data": {
    "source_id": "<string>",
    "target_bucket_name": "<string>",
    "target_region": "<string>",
    "id": "<string>",
    "refresh": true,
    "last_copy": [
      "2020-01-01T00:00:00Z"
    ],
    "status": "pending",
    "bytes_to_migrate": 123,
    "bytes_migrated": 123,
    "speed": 123,
    "eta": [
      "2020-01-01T00:00:00Z"
    ],
    "created_at": [
      "2020-01-01T00:00:00Z"
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
source_id
string
required

ID of the Migration Source from which to migrate data.

target_bucket_name
string
required

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

target_region
string
required

Telnyx Cloud Storage region to migrate the data to.

refresh
boolean

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

Response

200 - application/json

Create Migration Response

data
object