Harness

Migration State

This contains APIs for getting Migration State of Database Schema Entity

Fetch SQL changesets of a instance

Fetch SQL changesets

Securityx-api-key
Request
path Parameters
org
required
string

Organization identifier

project
required
string

Project identifier

dbschema
required
string <= 128 characters

Identifier of the database schema

dbinstance
required
string

database instance unique id

query Parameters
page
integer <int64>
Default: 0

Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.

limit
integer <= 100
Default: 10

Pagination: Number of items to return.

header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Request Body schema: application/json

Request Body for Fetching SQL statements

changesetFQN
required
string non-empty
Responses
200

Response Body for Fetching SQL statements

400

Error Response body

403

Error Response body

500

Error Response body

post/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/changeset/sql
Request samples
application/json
{
  • "changesetFQN": "string"
}
Response samples
application/json
{
  • "sql": [
    ]
}

ChangeSet deployment yaml for an instance

Securityx-api-key
Request
path Parameters
org
required
string

Organization identifier

project
required
string

Project identifier

dbschema
required
string <= 128 characters

Identifier of the database schema

dbinstance
required
string

database instance unique id

query Parameters
changeSet
required
string

FQN of the changeSet deployed. It is the combination of fileName, changeSetId and author separated by ::

Example: changeSet=folder1/fileName.yaml::changeSet1::author1
header Parameters
Harness-Account
string

Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.

Responses
200

Response body for changeSet deployment yaml for an instance

400

Error Response body

403

Error Response body

404

Error Response body

500

Error Response body

get/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/changeset/yaml
Request samples 
Response samples 
application/json
{
  • "yaml": "string"
}
Migration state of a instance
Migration state of a instance


Securityx-api-key 
Request 
path Parameters
org
required
string
Organization identifier


 
project
required
string
Project identifier


 
dbschema
required
string  <= 128 characters 
Identifier of the database schema


 
dbinstance
required
string
database instance unique id


 
query Parameters
page
integer <int64> 
 Default:  0
Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.


 
limit
integer  <= 100 
 Default:  10
Pagination: Number of items to return.


 
search_term
string
This would be used to filter resources having attributes matching the search term.


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Responses 
200
Response body for migration state of a instance


400
Error Response body


403
Error Response body


500
Error Response body


get/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/dbinstance/{dbinstance}/migrationstate
Request samples 
Response samples 
application/json
{
  • "changeSets": [
    ],
  • "instanceName": "string",
  • "schemaName": "string"
}
Migration state of a schema
Migration state of a schema


Securityx-api-key 
Request 
path Parameters
org
required
string
Organization identifier


 
project
required
string
Project identifier


 
dbschema
required
string
Identifier of the database schema


 
query Parameters
page
integer <int64> 
 Default:  0
Pagination page number strategy: Specify the page number within the paginated collection related to the number of items on each page.


 
limit
integer  <= 100 
 Default:  10
Pagination: Number of items to return.


 
search_term
string
This would be used to filter resources having attributes matching the search term.


 
header Parameters
Harness-Account
string
Identifier field of the account the resource is scoped to. This is required for Authorization methods other than the x-api-key header. If you are using the x-api-key header, this can be skipped.


 
Request Body schema: application/json
Inputs to get migration state of schema


object (MigrationStateInstanceIn) 
Get migration state request instance input


 
Responses 
200
Response body for migration state of a schema


400
Error Response body


403
Error Response body


500
Error Response body


post/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/migrationstate
Request samples 
application/json
{
  • "instanceFilter": {
    }
}
Response samples 
application/json
{
  • "changeSets": [
    ],
  • "instances": [
    ],
  • "schema": "string"
}
➔ Next to K8s Release Service Mapping [Beta]