Yugabyte voyager-info API
APIs for getting information about Voyager migrations
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/yugabyte-voyager-info-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
email: support@yugabyte.com
name: Yugabyte Cloud Support
url: https://support.yugabyte.com/
description: YugabyteDB as a Service
license:
name: Properietary (TBD)
url: https://www.yugabyte.com/yugabyte-cloud-terms-of-service
termsOfService: https://www.yugabyte.com/yugabyte-cloud-terms-of-service
title: Yugabyte Cloud backup-info Voyager Info API
version: v1
servers:
- description: Endpoint of the API server
url: '{protocol}://{host_port}/api'
variables:
protocol:
default: http
enum:
- http
- https
host_port:
default: localhost:1323
security:
- BearerAuthToken: []
tags:
- description: APIs for getting information about Voyager migrations
name: voyager-info
paths:
/migrations:
get:
description: Get the list of Voyager migrations
operationId: GetVoyagerMigrationTasks
parameters:
- description: uuid of the voyager migration task
explode: false
in: query
name: uuid
required: false
schema:
format: uuid
type: string
style: form
- description: specify the migration phase for which details are required
explode: false
in: query
name: migration_phase
required: false
schema:
format: int64
minimum: 0
type: integer
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VoyagerMigrationsInfo'
description: List of the Voyager migrations
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get the list of Voyager migrations
tags:
- voyager-info
/migration_assesment:
get:
description: Get Voyager data migration metrics
operationId: GetVoyagerMigrationAssesmentDetails
parameters:
- description: uuid of the voyager migration task
explode: false
in: query
name: uuid
required: true
schema:
format: uuid
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/API_for_Plan_and_Asses_page'
description: Response for Plan and Asses page
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get Voyager data migration metrics
tags:
- voyager-info
/migrate_schema:
get:
description: Get Voyager data migration metrics
operationId: GetVoyagerMigrateSchemaTasks
parameters:
- description: uuid of the voyager migration task
explode: false
in: query
name: uuid
required: true
schema:
format: uuid
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Individual_Migration_Task_Info'
description: Response for individual migration task
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get Voyager data migration metrics
tags:
- voyager-info
/migration_assessment_v2:
get:
description: Get the Database assessment details
operationId: GetMigrationAssessmentInfo
parameters:
- description: uuid of the voyager migration task
explode: false
in: query
name: uuid
required: true
schema:
format: uuid
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/API_for_migration_assessment_page'
description: Response for migration assessment page
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get the Database assessment details
tags:
- voyager-info
/assessment_source_db_details:
get:
description: Get the Source Database SQL object details
operationId: GetAssessmentSourceDBInfo
parameters:
- description: uuid of the voyager migration task
explode: false
in: query
name: uuid
required: true
schema:
format: uuid
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/API_for_Source_DB_SQL_objects_metadata_page'
description: Response for migration assessment source db metadata page
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get the Source Database SQL object details
tags:
- voyager-info
/assessment_target_recommendation_details:
get:
description: Get the Target Database recommendation details
operationId: GetAssessmentTargetRecommendationInfo
parameters:
- description: uuid of the voyager migration task
explode: false
in: query
name: uuid
required: true
schema:
format: uuid
type: string
style: form
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/API_for_Target_Schema_recommendations_page'
description: Response for migration assessment target recommendation page
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
description: API Error
summary: Get the Target Database recommendation details
tags:
- voyager-info
components:
schemas:
Individual_Migration_Task_Info:
example:
data:
import_schema: import_schema
suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
migration_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
overall_status: overall_status
analyze_schema: analyze_schema
sql_objects:
- invalidCount: 2
totalCount: 5
objectNames: objectNames
objectDetails: objectDetails
objectType: objectType
- invalidCount: 2
totalCount: 5
objectNames: objectNames
objectDetails: objectDetails
objectType: objectType
export_schema: export_schema
analysis_history:
- unsupported_features:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
recommended_refactoring:
refactor_details:
- sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
- sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
unsupported_datatypes:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
unsupported_functions:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- unsupported_features:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
recommended_refactoring:
refactor_details:
- sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
- sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
unsupported_datatypes:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
unsupported_functions:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
current_analysis_report:
unsupported_features:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
recommended_refactoring:
refactor_details:
- sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
- sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
unsupported_datatypes:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
unsupported_functions:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
properties:
data:
$ref: '#/components/schemas/MigrateSchemaTaskInfo'
title: Individual Migration Task Info
type: object
MigrationAssesmentInfo:
description: Details for Voyager migrations assesment
example:
complexity_overview:
- schema: schema
table_count: 6
complexity: complexity
sql_objects_count: 0
- schema: schema
table_count: 6
complexity: complexity
sql_objects_count: 0
assesment_status: true
top_errors:
- top_errors
- top_errors
operating_system: operating_system
top_suggestions:
- top_suggestions
- top_suggestions
properties:
assesment_status:
type: boolean
top_errors:
items:
type: string
type: array
top_suggestions:
items:
type: string
type: array
complexity_overview:
items:
$ref: '#/components/schemas/AssesmentComplexityInfo'
type: array
operating_system:
type: string
title: Details for Voyager migrations assesment
type: object
AssessmentReportSummary:
description: API for getting migration assessment summary
example:
summary: summary
estimated_migration_time: estimated_migration_time
migration_complexity: migration_complexity
properties:
migration_complexity:
type: string
estimated_migration_time:
type: string
summary:
type: string
title: Migration assessment summary
type: object
ApiError_error:
properties:
detail:
description: Error message
type: string
status:
description: Error code
type: integer
type: object
AssesmentComplexityInfo:
description: Assesment complexity details
example:
schema: schema
table_count: 6
complexity: complexity
sql_objects_count: 0
properties:
schema:
type: string
sql_objects_count:
type: integer
table_count:
type: integer
complexity:
type: string
title: Assesment complexity details
type: object
TargetSchemaRecommendations:
description: Target YugabyteDB cluster schema recommendations
example:
no_of_colocated_tables: 2
total_size_colocated_tables: 4
total_size_sharded_tables: 1
no_of_sharded_tables: 7
properties:
no_of_colocated_tables:
format: int64
type: integer
total_size_colocated_tables:
format: int64
type: integer
no_of_sharded_tables:
format: int64
type: integer
total_size_sharded_tables:
format: int64
type: integer
title: Target YugabyteDB cluster schema recommendations
type: object
VoyagerMigrationDetails_voyager:
example:
os: os
avail_disk_bytes: avail_disk_bytes
machine_ip: machine_ip
exported_schema_location: exported_schema_location
export_dir: export_dir
properties:
machine_ip:
type: string
os:
type: string
avail_disk_bytes:
type: string
export_dir:
type: string
exported_schema_location:
type: string
type: object
AssessmentTargetRecommendationObject:
description: Details about Target table recommendations
example:
recommendation_details:
- schema_recommendation: schema_recommendation
disk_size: 5
table_name: table_name
- schema_recommendation: schema_recommendation
disk_size: 5
table_name: table_name
num_of_sharded_table: 1
total_size_colocated_tables: 6
total_size_sharded_tables: 5
num_of_colocated_tables: 0
properties:
num_of_colocated_tables:
type: integer
total_size_colocated_tables:
format: int64
type: integer
num_of_sharded_table:
type: integer
total_size_sharded_tables:
format: int64
type: integer
recommendation_details:
items:
$ref: '#/components/schemas/TargetRecommendationItem'
type: array
title: Details about Target table recommendations
type: object
RefactoringCount:
description: Count of automatic, manual and invalid SQL objects.
example:
sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
properties:
sql_object_type:
type: string
manual:
type: integer
automatic:
type: integer
invalid:
type: integer
title: Count of automatic, manual and invalid SQL objects
type: object
TargetClusterSpec:
description: schema for target cluster cpu, memory
example:
memory_per_node: 7
inserts_per_node: 3
vcpu_per_node: 2
connections_per_node: 9
num_nodes: 5
properties:
num_nodes:
format: int64
type: integer
vcpu_per_node:
format: int64
type: integer
memory_per_node:
format: int64
type: integer
connections_per_node:
format: int64
type: integer
inserts_per_node:
format: int64
type: integer
title: Target cluster size recommendations
type: object
API_for_Source_DB_SQL_objects_metadata_page:
example:
data:
sql_objects_metadata:
- size: 1
object_name: object_name
sql_type: sql_type
iops: 5
row_count: 6
- size: 1
object_name: object_name
sql_type: sql_type
iops: 5
row_count: 6
sql_objects_count:
- sql_type: sql_type
count: 0
- sql_type: sql_type
count: 0
properties:
data:
$ref: '#/components/schemas/AssessmentSourceDbObject'
title: API for Source DB SQL objects metadata page
type: object
SchemaAnalysisReport:
description: Voyager data migration metrics details
example:
unsupported_features:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
recommended_refactoring:
refactor_details:
- sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
- sql_object_type: sql_object_type
invalid: 5
automatic: 1
manual: 6
unsupported_datatypes:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
unsupported_functions:
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
- suggestions_errors:
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
- issueType: issueType
reason: reason
GH: GH
sqlStatement: sqlStatement
filePath: filePath
suggestion: suggestion
objectName: objectName
objectType: objectType
unsupported_type: unsupported_type
count: 0
properties:
unsupported_functions:
it
# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabyte-voyager-info-api-openapi.yml