# \MigrationApi

All URIs are relative to *https://registry.example.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**assess_migration**](MigrationApi.md#assess_migration) | **POST** /api/v1/migrations/jobs/{id}/assess | Assess a migration
[**cancel_migration_job**](MigrationApi.md#cancel_migration_job) | **POST** /api/v1/migrations/jobs/{id}/cancel | Cancel a migration job
[**create_migration_connection**](MigrationApi.md#create_migration_connection) | **POST** /api/v1/migrations/connections | Create migration connection
[**create_migration_job**](MigrationApi.md#create_migration_job) | **POST** /api/v1/migrations | Create a migration job
[**delete_migration_connection**](MigrationApi.md#delete_migration_connection) | **DELETE** /api/v1/migrations/connections/{id} | Delete migration connection
[**delete_migration_job**](MigrationApi.md#delete_migration_job) | **DELETE** /api/v1/migrations/jobs/{id} | Delete a migration job
[**get_migration_assessment**](MigrationApi.md#get_migration_assessment) | **GET** /api/v1/migrations/jobs/{id}/assessment | Get migration assessment
[**get_migration_connection**](MigrationApi.md#get_migration_connection) | **GET** /api/v1/migrations/connections/{id} | Get migration connection
[**get_migration_job**](MigrationApi.md#get_migration_job) | **GET** /api/v1/migrations/jobs/{id} | Get a migration job
[**get_migration_report**](MigrationApi.md#get_migration_report) | **GET** /api/v1/migrations/jobs/{id}/report | Get migration report
[**list_migration_connections**](MigrationApi.md#list_migration_connections) | **GET** /api/v1/migrations/connections | List migration connections
[**list_migration_items**](MigrationApi.md#list_migration_items) | **GET** /api/v1/migrations/jobs/{id}/items | List migration items
[**list_migration_jobs**](MigrationApi.md#list_migration_jobs) | **GET** /api/v1/migrations | List migration jobs
[**list_remote_repositories**](MigrationApi.md#list_remote_repositories) | **GET** /api/v1/migrations/connections/{id}/repositories | List remote repositories
[**pause_migration_job**](MigrationApi.md#pause_migration_job) | **POST** /api/v1/migrations/jobs/{id}/pause | Pause a migration job
[**resume_migration_job**](MigrationApi.md#resume_migration_job) | **POST** /api/v1/migrations/jobs/{id}/resume | Resume a migration job
[**retry_migration_item**](MigrationApi.md#retry_migration_item) | **POST** /api/v1/migrations/jobs/{id}/items/{itemId}/retry | Retry failed item
[**start_migration_job**](MigrationApi.md#start_migration_job) | **POST** /api/v1/migrations/jobs/{id}/start | Start a migration job
[**stream_migration_progress**](MigrationApi.md#stream_migration_progress) | **GET** /api/v1/migrations/jobs/{id}/stream | Stream migration progress
[**test_migration_connection**](MigrationApi.md#test_migration_connection) | **POST** /api/v1/migrations/connections/{id}/test | Test migration connection
[**update_migration_connection**](MigrationApi.md#update_migration_connection) | **PATCH** /api/v1/migrations/connections/{id} | Update migration connection



## assess_migration

> models::AssessMigration202Response assess_migration(id)
Assess a migration

Triggers an asynchronous assessment of the migration to estimate size, duration, and potential issues.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

[**models::AssessMigration202Response**](assessMigration_202_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## cancel_migration_job

> models::MigrationJob cancel_migration_job(id)
Cancel a migration job

Cancels a running or paused migration job. Already-migrated artifacts are retained.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

[**models::MigrationJob**](MigrationJob.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_migration_connection

> models::MigrationConnection create_migration_connection(create_migration_connection_request)
Create migration connection

Creates a new connection to a remote artifact manager for migration.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_migration_connection_request** | [**CreateMigrationConnectionRequest**](CreateMigrationConnectionRequest.md) |  | [required] |

### Return type

[**models::MigrationConnection**](MigrationConnection.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_migration_job

> models::MigrationJob create_migration_job(create_migration_job_request)
Create a migration job

Creates a new migration job to transfer artifacts from a source system.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_migration_job_request** | [**CreateMigrationJobRequest**](CreateMigrationJobRequest.md) |  | [required] |

### Return type

[**models::MigrationJob**](MigrationJob.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_migration_connection

> delete_migration_connection(id)
Delete migration connection

Permanently deletes a migration connection. Fails if there are active migration jobs using this connection.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Connection UUID | [required] |

### Return type

 (empty response body)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_migration_job

> delete_migration_job(id)
Delete a migration job

Removes a completed or cancelled migration job and its records.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

 (empty response body)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_migration_assessment

> models::MigrationAssessment get_migration_assessment(id)
Get migration assessment

Returns the results of a previously triggered migration assessment.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

[**models::MigrationAssessment**](MigrationAssessment.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_migration_connection

> models::MigrationConnection get_migration_connection(id)
Get migration connection

Returns a single migration connection by its unique identifier.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Connection UUID | [required] |

### Return type

[**models::MigrationConnection**](MigrationConnection.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_migration_job

> models::MigrationJob get_migration_job(id)
Get a migration job

Returns full details and progress of a migration job.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

[**models::MigrationJob**](MigrationJob.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_migration_report

> models::MigrationReport get_migration_report(id)
Get migration report

Returns a comprehensive report of a completed or in-progress migration job.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

[**models::MigrationReport**](MigrationReport.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_migration_connections

> Vec<models::MigrationConnection> list_migration_connections()
List migration connections

Returns all configured migration source connections.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::MigrationConnection>**](MigrationConnection.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_migration_items

> models::ListMigrationItems200Response list_migration_items(id, status, page, per_page)
List migration items

Returns a paginated list of individual items in a migration job, optionally filtered by status.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |
**status** | Option<**String**> | Filter items by status (e.g. pending, completed, failed, skipped). |  |
**page** | Option<**i32**> | Page number for pagination |  |[default to 1]
**per_page** | Option<**i32**> | Number of items per page |  |[default to 20]

### Return type

[**models::ListMigrationItems200Response**](listMigrationItems_200_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_migration_jobs

> models::ListMigrationJobs200Response list_migration_jobs(status, page, per_page)
List migration jobs

Returns a paginated list of migration jobs, optionally filtered by status.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**status** | Option<**String**> | Filter by migration status (e.g. pending, running, completed, failed). |  |
**page** | Option<**i32**> | Page number for pagination |  |[default to 1]
**per_page** | Option<**i32**> | Number of items per page |  |[default to 20]

### Return type

[**models::ListMigrationJobs200Response**](listMigrationJobs_200_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_remote_repositories

> Vec<models::RemoteRepository> list_remote_repositories(id)
List remote repositories

Lists repositories available on the remote artifact manager for migration.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Connection UUID | [required] |

### Return type

[**Vec<models::RemoteRepository>**](RemoteRepository.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## pause_migration_job

> models::MigrationJob pause_migration_job(id)
Pause a migration job

Pauses a running migration job so it can be resumed later.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

[**models::MigrationJob**](MigrationJob.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## resume_migration_job

> models::MigrationJob resume_migration_job(id)
Resume a migration job

Resumes a paused migration job from where it left off.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

[**models::MigrationJob**](MigrationJob.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## retry_migration_item

> models::MigrationItem retry_migration_item(id, item_id)
Retry failed item

Retries a previously failed migration item.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job UUID | [required] |
**item_id** | **uuid::Uuid** | Migration item UUID | [required] |

### Return type

[**models::MigrationItem**](MigrationItem.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## start_migration_job

> models::MigrationJob start_migration_job(id)
Start a migration job

Begins executing a pending migration job asynchronously.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

[**models::MigrationJob**](MigrationJob.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## stream_migration_progress

> String stream_migration_progress(id)
Stream migration progress

Opens a Server-Sent Events stream for real-time migration progress updates.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Migration job ID. | [required] |

### Return type

**String**

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/event-stream, application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## test_migration_connection

> models::TestResultResponse test_migration_connection(id)
Test migration connection

Tests connectivity and authentication against the remote artifact manager.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Connection UUID | [required] |

### Return type

[**models::TestResultResponse**](TestResultResponse.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_migration_connection

> models::MigrationConnection update_migration_connection(id, update_migration_connection_request)
Update migration connection

Partially updates migration connection details.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Connection UUID | [required] |
**update_migration_connection_request** | [**UpdateMigrationConnectionRequest**](UpdateMigrationConnectionRequest.md) |  | [required] |

### Return type

[**models::MigrationConnection**](MigrationConnection.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

