Triggers

This contains APIs related to Triggers.

Activates or deactivate trigger for pipeline with target pipeline identifier.

SecurityApiKey
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

status
required
boolean
Responses
400

Bad Request

500

Internal server error

default

Returns the response status.

put/pipeline/api/triggers/{triggerIdentifier}/status
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Creates Trigger for triggering target pipeline identifier.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string

Identifier of the target pipeline

ignoreError
boolean
Default: false
Request Body schema:
string
Responses
400

Bad Request

500

Internal server error

default

Returns details of the created Trigger.

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

Deletes Trigger by identifier.

SecurityApiKey
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": [
    ]
}

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

SecurityApiKey
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": [
    ]
}

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

SecurityApiKey
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
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
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

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

SecurityApiKey
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.

SecurityApiKey
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:
string
Responses
400

Bad Request

500

Internal server error

default

Returns the updated trigger

put/pipeline/api/triggers/{triggerIdentifier}
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}