MigrationParams

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-migration-params-schema.json",
  "title": "MigrationParams",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-data-migration-api-openapi.yml#/components/schemas/MigrationParams",
  "properties": {
    "bytes_migrated": {
      "description": "Total amount of data that has been succesfully migrated.",
      "readOnly": true,
      "type": "integer"
    },
    "bytes_to_migrate": {
      "description": "Total amount of data found in source bucket to migrate.",
      "readOnly": true,
      "type": "integer"
    },
    "created_at": {
      "description": "Time when data migration was created",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "eta": {
      "description": "Estimated time the migration will complete.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "Unique identifier for the data migration.",
      "readOnly": true,
      "type": "string"
    },
    "last_copy": {
      "description": "Time when data migration was last copied from the source.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "refresh": {
      "description": "If true, will continue to poll the source bucket to ensure new data is continually migrated over.",
      "type": "boolean"
    },
    "source_id": {
      "description": "ID of the Migration Source from which to migrate data.",
      "type": "string"
    },
    "speed": {
      "description": "Current speed of the migration.",
      "readOnly": true,
      "type": "integer"
    },
    "status": {
      "description": "Status of the migration.",
      "enum": [
        "pending",
        "checking",
        "migrating",
        "complete",
        "error",
        "stopped"
      ],
      "readOnly": true,
      "type": "string"
    },
    "target_bucket_name": {
      "description": "Bucket name to migrate the data into. Will default to the same name as the `source_bucket_name`.",
      "type": "string"
    },
    "target_region": {
      "description": "Telnyx Cloud Storage region to migrate the data to.",
      "type": "string"
    }
  },
  "required": [
    "source_id",
    "target_bucket_name",
    "target_region"
  ],
  "type": "object"
}