Deployed State

This contains APIs for tracking changeSet deployment status

Get Deployed State

Status of changeset deployment as part of execution with comparison to earlier state.

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
pipeline
required
string

identifier of the pipeline

planExecutionId
required
string
stageExecutionId
required
string
startTime
integer <int64>
Default: 0

start time of step execution

stepType
required
string (DBStepType)
Value: "DBSchemaApply"
Responses
200

Response

400

Error Response body

403

Error Response body

404

Error Response body

500

Error Response body

post/v1/orgs/{org}/projects/{project}/dbschema/{dbschema}/instance/{dbinstance}/deployedState
Request samples
application/json
{
  • "pipeline": "string",
  • "planExecutionId": "string",
  • "stageExecutionId": "string",
  • "startTime": 0,
  • "stepType": "DBSchemaApply"
}
Response samples
application/json
[
  • {
    }
]