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

Harness Migration State API

This contains APIs for getting Migration State of Database Schema Entity

Harness Migration State API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Migration State. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

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

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

6 operations 6 paths 18 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Migration State API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Migration State 6

This contains APIs for getting Migration State of Database Schema Entity

POST
/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/changeset/sql
Fetch SQL changesets of a instance
V1FetchDeployedChangesetSql 7 params body → 200400403500
GET
/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/changeset/yaml
ChangeSet deployment yaml for an instance
V1ChangesetYamlProjDbInstance 6 params → 200400403404500
GET
/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/flyway/migrationstate
Flyway Migration state of an instance
V1MigrationStateFlywayInstance 8 params → 200400403500
GET
/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/migrationstate
Migration state of a instance
V1MigrationStateProjDbInstance 8 params → 200400403500
POST
/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/flyway/migrationstate
Migration state of a flyway schema
V1MigrationStateFlywaySchema 7 params body → 200400403500
POST
/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/migrationstate
Migration state of a schema
V1MigrationStateProjDbSchema 7 params body → 200400403500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are InstanceMigrationStateChangeSet (12 properties), MigrationStateInstance (8 properties), FlywayInstanceMigrationState (8 properties), MigrationStateChangeSet (7 properties). Each schema is shown below with its type and property counts.

InstanceDetail
object
Name and identifier of instance
2 properties 2 required
ChangeSetDeploymentStatus
string
Status of change set deployment
DeployedChangesetSqlOutput
object
Response Body for Fetching SQL statements
1 property
MigrationStateOut
object
Change Set deployment info for a schema
3 properties 1 required
MigrationStateIn
object
Get migration state request input
1 property
MigrationStateInstanceIn
object
Get migration state request instance input
3 properties
ChangeSetDeploymentYamlOutput
object
ChangeSet deployment yaml info for an instance
1 property 1 required
DbOpsError
object
Error Response
1 property 1 required
SortInstance
string
sort for instance entity
FlywayAppliedMigration
object
Flyway Migration Applied across instances
5 properties 4 required
OrderInstance
string
order of instance entity
MigrationStateChangeSet
object
Deployment info of Change Sets across instances
7 properties 7 required
InstanceMigrationStateChangeSet
object
Deployment info of Change Sets across instances
12 properties 9 required
FlywayInstanceMigrationState
object
Flyway Migration info across instances
8 properties 7 required
FlywayMigrationStateOutput
object
Flyway Migration Applied for a schema information
3 properties 1 required
MigrationStateInstance
object
Change Set Deployment info of instance
8 properties 5 required
InstanceMigrationStateOut
object
Change Set deployment info for a instance
3 properties 2 required
FlywayInstanceMigrationStateOutput
object
Flyway Migration info across schema and instance
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-migration-state-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Migration State 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.