Harness

Triggers [Beta]

This contains APIs for performing CRUD operations on Triggers.

Gets the paginated list of triggers for accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string

Identifier of the target pipeline

filter
string
page
integer <int32>
Default: 0
size
integer <int32>
Default: 25
sort
Array of strings
searchTerm
string
Request Body schema:

This contains details of Trigger filters based on Trigger Types and Trigger Names

triggerNames
Array of strings

This is the list of the Trigger names on which the filter will be applied.

triggerIdentifiers
Array of strings

This is the list of the Trigger identifiers on which the filter will be applied.

triggerTypes
Array of strings

This is the list of the Trigger types on which the filter will be applied.

Items Enum: "Webhook" "Artifact" "Manifest" "Scheduled" "MultiRegionArtifact"
object

Filter tags as a key-value pair.

filterType
required
string

This specifies the corresponding Entity of the filter.

Enum: "Connector" "Secret" "DelegateProfile" "Delegate" "PipelineSetup" "PipelineExecution" "Deployment" "Audit" "Template" "Trigger" "EnvironmentGroup" "FileStore" "CCMRecommendation" "Anomaly" "Environment" "RuleExecution" "Override" "InputSet"
Responses
400

Bad Request

500

Internal server error

default

Returns the paginated list of triggers for accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier.

get/pipeline/api/triggers
Request samples
{
  • "triggerNames": [
    ],
  • "triggerIdentifiers": [
    ],
  • "triggerTypes": [
    ],
  • "tags": {
    },
  • "filterType": "Connector"
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Creates Trigger for triggering target pipeline identifier.

Securityx-api-key
Request
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string

Identifier of the target pipeline

ignoreError
boolean
Default: false
withServiceV2
boolean
Default: false
Request Body schema:
required

Triggers YAML

string
Responses
400

Bad Request

500

Internal server error

default

Returns details of the created Trigger.

post/pipeline/api/triggers
Request samples

Sample Triggers YAML

"trigger:\n name: Trigger\n identifier: Trigger\n enabled: true\n orgIdentifier: default\n projectIdentifier: Terraform_Provider\n pipelineIdentifier: Terraform_NG_Acc_Tests_With_Notifications\n source:\n type: Scheduled\n spec:\n type: Cron\n spec:\n expression: 0 8,20 * * *\n inputYaml: |\n pipeline:\n identifier: Terraform_NG_Acc_Tests_With_Notifications\n properties:\n ci:\n codebase:\n build:\n type: branch\n spec:\n branch: main"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Gets the trigger by accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier and triggerIdentifier.

Securityx-api-key
Request
path Parameters
triggerIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string

Identifier of the target pipeline under which trigger resides

Responses
400

Bad Request

500

Internal server error

default

Returns the trigger with the accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier and triggerIdentifier.

get/pipeline/api/triggers/{triggerIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Updates trigger for pipeline with target pipeline identifier.
Securityx-api-key 
Request 
path Parameters
triggerIdentifier
required
string
 
query Parameters
accountIdentifier
required
string
 
orgIdentifier
required
string
 
projectIdentifier
required
string
 
targetIdentifier
required
string
Identifier of the target pipeline under which trigger resides


 
ignoreError
boolean
 Default:  false
 
header Parameters
If-Match
string
 
Request Body schema: 
required
Triggers YAML


string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns the updated trigger


put/pipeline/api/triggers/{triggerIdentifier}
Request samples 
Sample Triggers YAML


"trigger:\n  name: Trigger\n  identifier: Trigger\n  enabled: true\n  orgIdentifier: default\n  projectIdentifier: Terraform_Provider\n  pipelineIdentifier: Terraform_NG_Acc_Tests_With_Notifications\n  source:\n    type: Scheduled\n    spec:\n      type: Cron\n      spec:\n        expression: 0 8,20 * * *\n  inputYaml: |\n    pipeline:\n      identifier: Terraform_NG_Acc_Tests_With_Notifications\n      properties:\n        ci:\n          codebase:\n            build:\n              type: branch\n              spec:\n                branch: main"
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Deletes Trigger by identifier.
Securityx-api-key 
Request 
path Parameters
triggerIdentifier
required
string
 
query Parameters
accountIdentifier
required
string
 
orgIdentifier
required
string
 
projectIdentifier
required
string
 
targetIdentifier
required
string
Identifier of the target pipeline under which trigger resides.


 
header Parameters
If-Match
string
 
Responses 
400
Bad Request


500
Internal server error


default
Returns the boolean status.


delete/pipeline/api/triggers/{triggerIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Lists all Triggers
Lists all the Triggers for the given Account ID.


Securityx-api-key 
Request 
query Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal server error


default
Returns the Trigger catalogue response


get/pipeline/api/triggers/catalog
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Fetches Trigger details for a specific accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier, triggerIdentifier.
Securityx-api-key 
Request 
path Parameters
triggerIdentifier
required
string
Identifier of the target pipeline


 
query Parameters
accountIdentifier
required
string
 
orgIdentifier
required
string
 
projectIdentifier
required
string
 
targetIdentifier
required
string
 
Responses 
400
Bad Request


500
Internal server error


default
Fetches Trigger details for a specific accountIdentifier, orgIdentifier, projectIdentifier, targetIdentifier, triggerIdentifier.


get/pipeline/api/triggers/{triggerIdentifier}/details
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Get event history for a triggerDeprecated
Get event history for a trigger


Securityx-api-key 
Request 
path Parameters
triggerIdentifier
required
string
 
query Parameters
accountIdentifier
required
string
 
orgIdentifier
required
string
 
projectIdentifier
required
string
 
targetIdentifier
required
string
Identifier of the target pipeline under which trigger resides


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


 
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.


 
Responses 
400
Bad Request


500
Internal server error


default
Returns the Trigger catalogue response


get/pipeline/api/triggers/{triggerIdentifier}/eventHistory
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to TriggersEvents