Pipeline Execution Details

This contains APIs for fetching Pipeline Execution Details

Fetch Execution DetailsDeprecated

Returns the Pipeline Execution Details for a Given PlanExecution ID

Securityx-api-key
Request
path Parameters
planExecutionId
required
string

Plan Execution Id for which we want to get the Execution details

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

stageNodeId
string

Stage Node Identifier for which Stage Graph needs to be Rendered

stageNodeExecutionId
string

Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field)

Responses
400

Bad Request

500

Internal server error

default

Return the Pipeline Execution details for given PlanExecution Id

get/pipeline/api/pipelines/execution/{planExecutionId}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch Execution Details

Returns the Pipeline Execution Details for a Given PlanExecution ID

Securityx-api-key
Request
path Parameters
planExecutionId
required
string

Plan Execution Id for which we want to get the Execution details

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

stageNodeId
string

Stage Node Identifier for which Stage Graph needs to be Rendered

stageNodeExecutionId
string

Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field)

childStageNodeId
string

Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field)

renderFullBottomGraph
boolean

Generate Graph for all the Stages including Steps in each Stage

Responses
400

Bad Request

500

Internal server error

default

Return the Pipeline Execution details for given PlanExecution Id without full graph if stageNodeId is null

get/pipeline/api/pipelines/execution/v2/{planExecutionId}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch Execution SubGraph for a Given NodeExecution ID

Returns the Pipeline Execution SubGraph for a Given NodeExecution ID

Securityx-api-key
Request
path Parameters
nodeExecutionId
required
string

Node Execution Id for which we want to get the Execution SubGraph

planExecutionId
required
string

Plan Execution Id for which we want to get the Execution details

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Return Execution subGraph for a Given NodeExecution ID

get/pipeline/api/pipelines/execution/subGraph/{planExecutionId}/{nodeExecutionId}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch Execution Url

Returns the Pipeline Execution Url for a Given PlanExecution ID

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

pipelineIdentifier
required
string

Pipeline Id for which we want to get the Execution url

planExecutionId
required
string

Plan Execution Id for which we want to get the Execution url

modules
Array of strings

Modules

Responses
400

Bad Request

500

Internal server error

default

Return the Pipeline Execution url for given Pipeline and PlanExecution Id

post/pipeline/api/pipelines/execution/url
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get the Input Set YAML used for given Plan Execution

Securityx-api-key
Request
path Parameters
planExecutionId
required
string

Plan Execution Id for which we want to get the Input Set YAML

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

resolveExpressions
boolean
Default: false

A boolean that indicates whether or not expressions should be resolved in input set yaml

resolveExpressionsType
string
Default: "UNKNOWN"

Resolve Expressions Type indicates what kind of expressions should be resolved in input set yaml. The default value is UNKNOWN in which case no expressions will be resolvedChoose a value from the enum list: [RESOLVE_ALL_EXPRESSIONS, RESOLVE_TRIGGER_EXPRESSIONS, UNKNOWN]

Enum: "RESOLVE_ALL_EXPRESSIONS" "RESOLVE_TRIGGER_EXPRESSIONS" "UNKNOWN"
Responses
400

Bad Request

500

Internal server error

default

Return the Input Set YAML used for given Plan Execution

get/pipeline/api/pipelines/execution/{planExecutionId}/inputsetV2
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

List Execution Identifier

Returns a List of Pipeline Executions Identifier with Specific Filter

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

pipelineIdentifier
string

Pipeline Identifier filter if exact pipelines needs to be filtered.

page
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

size
integer <int32>
Default: 10

Results per page

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Responses
400

Bad Request

500

Internal server error

default

Returns all the Executions Identifier of pipelines for given filter

post/pipeline/api/pipelines/execution/executionSummary
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

List Executions

Returns a List of Pipeline Executions with Specific Filter

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

searchTerm
string

Search term to filter out pipelines based on pipeline name, identifier, tags.

pipelineIdentifier
string

Pipeline Identifier filter if exact pipelines needs to be filtered.

page
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

size
integer <int32>
Default: 10

Results per page

sort
Array of strings

Sort criteria for the elements.

filterIdentifier
string
showAllExecutions
boolean
Default: false
module
string
status
Array of strings
Items Enum: "Running" "AsyncWaiting" "TaskWaiting" "TimedWaiting" "Failed" "Errored" "IgnoreFailed" "NotStarted" "Expired" "Aborted" "Discontinuing" "Queued" "Paused" "ResourceWaiting" "InterventionWaiting" "ApprovalWaiting" "WaitStepRunning" "QueuedLicenseLimitReached" "QueuedExecutionConcurrencyReached" "Success" "Suspended" "Skipped" "Pausing" "ApprovalRejected" "InputWaiting" "AbortedByFreeze" "NOT_STARTED" "INTERVENTION_WAITING" "APPROVAL_WAITING" "APPROVAL_REJECTED" "Waiting"
myDeployments
boolean
branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Request Body schema: application/json

Returns a List of Pipeline Executions with Specific Filters

Responses
400

Bad Request

500

Internal server error

default

Returns all the Executions of pipelines for given filter

post/pipeline/api/pipelines/execution/summary
Request samples
application/json

Sample List Pipeline Executions JSON Payload

{
  • "filterType": "PipelineExecution",
  • "pipelineTags": [
    ]
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get Notes for a pipelineExecution

Securityx-api-key
Request
path Parameters
planExecutionId
required
string

ExecutionId of the execution for which we want to get notes

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Returns Notes of a pipelineExecution

get/pipeline/api/pipelines/execution/{planExecutionId}/notes
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Updates Notes for a pipelineExecution

Securityx-api-key
Request
path Parameters
planExecutionId
required
string

ExecutionId of the execution for which we want to update notes

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

notesForPipelineExecution
required
string

Notes of a Pipeline Execution

Responses
400

Bad Request

500

Internal server error

default

Returns Notes of a pipelineExecution

put/pipeline/api/pipelines/execution/{planExecutionId}/notes
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}