How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yugabyte voyager-info API

APIs for getting information about Voyager migrations

Yugabyte voyager-info API is one of 10 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include voyager-info. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, {protocol}://{host_port}/api.

6 operations 6 paths 35 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

GET
/migrations
Get the list of Voyager migrations
GetVoyagerMigrationTasks 2 params → 200400500
GET
/migration_assesment
Get Voyager data migration metrics
GetVoyagerMigrationAssesmentDetails 1 param → 200400500
GET
/migrate_schema
Get Voyager data migration metrics
GetVoyagerMigrateSchemaTasks 1 param → 200400500
GET
/migration_assessment_v2
Get the Database assessment details
GetMigrationAssessmentInfo 1 param → 200400500
GET
/assessment_source_db_details
Get the Source Database SQL object details
GetAssessmentSourceDBInfo 1 param → 200400500
GET
/assessment_target_recommendation_details
Get the Target Database recommendation details
GetAssessmentTargetRecommendationInfo 1 param → 200400500

Schemas 35

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.

Individual_Migration_Task_Info
object
1 property
MigrationAssesmentInfo
object
Details for Voyager migrations assesment
5 properties
AssessmentReportSummary
object
API for getting migration assessment summary
3 properties
ApiError_error
object
2 properties
AssesmentComplexityInfo
object
Assesment complexity details
4 properties
TargetSchemaRecommendations
object
Target YugabyteDB cluster schema recommendations
4 properties
VoyagerMigrationDetails_voyager
object
5 properties
AssessmentTargetRecommendationObject
object
Details about Target table recommendations
5 properties
RefactoringCount
object
Count of automatic, manual and invalid SQL objects.
4 properties
TargetClusterSpec
object
schema for target cluster cpu, memory
5 properties
API_for_Source_DB_SQL_objects_metadata_page
object
1 property
SchemaAnalysisReport
object
Voyager data migration metrics details
4 properties
UnsupportedSqlWithDetails
object
Schema for Suggested refactoring tab in Migrate Schema page
3 properties
SourceDatabaseInfo
object
Source Database details
4 properties
VoyagerMigrationDetails_source_db
object
6 properties
RecommendedRefactoringGraph
object
Refectoring recommendations for migrating SQL objects
1 property
UnsupportedSqlObjectData
object
Unsupported SQL Object Data
2 properties
ErrorsAndSuggestionsDetails
object
Errors and suggestions details
8 properties
TargetClusterRecommendationDetails
object
Recommendations for the Target YugabyteDB cluster
3 properties
VoyagerMigrationsInfo
object
YB Voyager migrations Info
1 property
API_for_Target_Schema_recommendations_page
object
1 property
SourceEnvironmentInfo
object
Assessment source environment (node/VM) details
4 properties
TargetRecommendationItem
object
Target recommendation table metadata information
3 properties
SqlObjectMetadata
object
size, count, iops details of tables and indexes
5 properties
VoyagerMigrationDetails_target_cluster
object
4 properties
API_for_migration_assessment_page
object
1 property
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
API_for_Plan_and_Asses_page
object
1 property
MigrateSchemaTaskInfo
object
Voyager data migration metrics details
9 properties
SqlObjectsDetails
object
Sql obejcts type and count
5 properties
UnsupportedSqlInfo
object
Unsupported SQL Info
4 properties
VoyagerMigrationDetails
object
Information regarding a specific voyager migration task
13 properties
MigrationAssessmentReport
object
Details of the migration assessment report
9 properties
ApiError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-voyager-info-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
Yugabyte backup-info API
Yugabyte cluster API
Yugabyte cluster-info API
Yugabyte pitr-info API
Yugabyte restore-info API
Yugabyte voyager-metrics API
Yugabyte Xcluster Metrics API
Yugabyte Xcluster Namespace Details API
Where this information came from

This is an independent, third-party profile of Yugabyte voyager-info API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.