Skip to main content

Stop a Migration

POST 
/storage/migrations/:id/actions/stop

Request ​

Path Parameters

    id stringrequired

    Unique identifier for the data migration.

Responses ​

200: Create Migration Response

Response Headers

    Schema

      data

      object

      id string

      Unique identifier for the data migration.

      source_id stringrequired

      ID of the Migration Source from which to migrate data.

      target_bucket_name stringrequired

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

      target_region stringrequired

      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.

      last_copy date-time

      Time when data migration was last copied from the source.

      status string

      Possible values: [pending, checking, migrating, complete, error, stopped]

      Status of the migration.

      bytes_to_migrate integer

      Total amount of data found in source bucket to migrate.

      bytes_migrated integer

      Total amount of data that has been succesfully migrated.

      speed integer

      Current speed of the migration.

      eta date-time

      Estimated time the migration will complete.

      created_at date-time

      Time when data migration was created

    Request samples

    curl -L -X POST 'https://api.telnyx.com/v2/storage/migrations/:id/actions/stop' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <TOKEN>'

    Response samples

    {
      "data": {
        "id": "string",
        "source_id": "string",
        "target_bucket_name": "string",
        "target_region": "string",
        "refresh": true,
        "last_copy": [
          "2020-01-01T00:00:00Z"
        ],
        "status": "pending",
        "bytes_to_migrate": 0,
        "bytes_migrated": 0,
        "speed": 0,
        "eta": [
          "2020-01-01T00:00:00Z"
        ],
        "created_at": [
          "2020-01-01T00:00:00Z"
        ]
      }
    }