Yugabyte voyager-info API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuthToken).
By default, every request must be authenticated.
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.
voyager-info 6
APIs for getting information about Voyager migrations
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are VoyagerMigrationDetails (13 properties), MigrationAssessmentReport (9 properties), MigrateSchemaTaskInfo (9 properties), ErrorsAndSuggestionsDetails (8 properties). Each schema is shown below with its type and property counts.
VoyagerMigrationsInfo
object
YB Voyager migrations Info
1 property
UnsupportedSqlWithDetails
object
Schema for Suggested refactoring tab in Migrate Schema page
3 properties
TargetRecommendationItem
object
Target recommendation table metadata information
3 properties
API_for_Plan_and_Asses_page
object
1 property
SourceDatabaseInfo
object
Source Database details
4 properties
Individual_Migration_Task_Info
object
1 property
AssessmentTargetRecommendationObject
object
Details about Target table recommendations
5 properties
SqlObjectMetadata
object
size, count, iops details of tables and indexes
5 properties
VoyagerMigrationDetails_voyager
object
5 properties
API_for_Target_Schema_recommendations_page
object
1 property
RefactoringCount
object
Count of automatic, manual and invalid SQL objects.
4 properties
ErrorsAndSuggestionsDetails
object
Errors and suggestions details
8 properties
TargetClusterSpec
object
schema for target cluster cpu, memory
5 properties
SourceEnvironmentInfo
object
Assessment source environment (node/VM) details
4 properties
AssessmentSourceDbObject
object
Details about Source DB's SQL Objects
2 properties
SqlObjectCount
object
Count of specific Sql Object type in the source DB
2 properties
TargetClusterRecommendationDetails
object
Recommendations for the Target YugabyteDB cluster
3 properties
ApiError_error
object
2 properties
RecommendedRefactoringGraph
object
Refectoring recommendations for migrating SQL objects
1 property
API_for_migration_assessment_page
object
1 property
AssessmentReportSummary
object
API for getting migration assessment summary
3 properties
VoyagerMigrationDetails_target_cluster
object
4 properties
TargetSchemaRecommendations
object
Target YugabyteDB cluster schema recommendations
4 properties
UnsupportedSqlObjectData
object
Unsupported SQL Object Data
2 properties
API_for_Source_DB_SQL_objects_metadata_page
object
1 property
ApiError
object
1 property
VoyagerMigrationDetails_source_db
object
6 properties
MigrateSchemaTaskInfo
object
Voyager data migration metrics details
9 properties
SqlObjectsDetails
object
Sql obejcts type and count
5 properties
MigrationAssessmentReport
object
Details of the migration assessment report
9 properties
AssesmentComplexityInfo
object
Assesment complexity details
4 properties
MigrationAssesmentInfo
object
Details for Voyager migrations assesment
5 properties
VoyagerMigrationDetails
object
Information regarding a specific voyager migration task
13 properties
UnsupportedSqlInfo
object
Unsupported SQL Info
4 properties
SchemaAnalysisReport
object
Voyager data migration metrics details
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
