triggers

Gets Triggers list for target

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string
filter
string
page
integer <int32>
Default: 0
size
integer <int32>
Default: 25
sort
Array of strings
searchTerm
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/triggers
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/triggers?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&targetIdentifier=string&filter=string&page=0&size=25&sort=string&searchTerm=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Create Trigger

Request
Security:
ApiKey (readwrite)
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string
Request Body schema:
name
string
identifier
required
string
description
string
orgIdentifier
string
projectIdentifier
string
pipelineIdentifier
string
object
inputYaml
string
object (NGTriggerSourceV2)
enabled
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

post/pipeline/api/triggers
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "description": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "pipelineIdentifier": "string",
  • "tags": {
    },
  • "inputYaml": "string",
  • "source": {
    },
  • "enabled": true
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Gets Triggers list for target

Request
Security:
ApiKey (readwrite)
path Parameters
triggerIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/triggers/{triggerIdentifier}/details
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/triggers/:triggerIdentifier/details?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&targetIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Regenerate webhook token

Request
Security:
ApiKey (readwrite)
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/triggers/regenerateToken
Request samples
curl -i -X GET \
  https://app.harness.io/gateway/pipeline/api/triggers/regenerateToken \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "metaData": {
    },
  • "resource": "string",
  • "responseMessages": [
    ]
}

Update a trigger's status by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
triggerIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string
status
required
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/pipeline/api/triggers/{triggerIdentifier}/status
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/pipeline/api/triggers/:triggerIdentifier/status?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&targetIdentifier=string&status=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}

Gets a trigger by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
triggerIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

get/pipeline/api/triggers/{triggerIdentifier}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/triggers/:triggerIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&targetIdentifier=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Update a trigger by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
triggerIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string
header Parameters
If-Match
string
Request Body schema:
name
string
identifier
required
string
description
string
orgIdentifier
string
projectIdentifier
string
pipelineIdentifier
string
object
inputYaml
string
object (NGTriggerSourceV2)
enabled
boolean
Responses
200

successful operation

400

Bad Request

500

Internal server error

put/pipeline/api/triggers/{triggerIdentifier}
Request samples
{
  • "name": "string",
  • "identifier": "string",
  • "description": "string",
  • "orgIdentifier": "string",
  • "projectIdentifier": "string",
  • "pipelineIdentifier": "string",
  • "tags": {
    },
  • "inputYaml": "string",
  • "source": {
    },
  • "enabled": true
}
Response samples
{
  • "status": "SUCCESS",
  • "data": {
    },
  • "metaData": { },
  • "correlationId": "string"
}

Delete a trigger by identifier

Request
Security:
ApiKey (readwrite)
path Parameters
triggerIdentifier
required
string
query Parameters
accountIdentifier
required
string
orgIdentifier
required
string
projectIdentifier
required
string
targetIdentifier
required
string
header Parameters
If-Match
string
Responses
200

successful operation

400

Bad Request

500

Internal server error

delete/pipeline/api/triggers/{triggerIdentifier}
Request samples
curl -i -X DELETE \
  'https://app.harness.io/gateway/pipeline/api/triggers/:triggerIdentifier?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&targetIdentifier=string' \
  -H 'If-Match: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "data": true,
  • "metaData": { },
  • "correlationId": "string"
}