Trigger Pipelines Steps

JFrog REST APIs

Products

JFrog Xray

Content Type

REST API

ft:sourceType

Paligo

Description: Trigger a pipeline step based on step Id.

Security: Requires a valid user

Usage: POST api/v1/pipelineSteps/:pipelineStepId/trigger

Produces: application/json

URL Parameters:

Parameter	Type	Description	Required/Optional
`pipelineStepId`	Integer	Numeric pipeline step Id.	Required

Request Parameters:

Parameter	Type	Description	Required/Optional
`reset`	Boolean	Trigger a step without any cache.	Optional
`overrideVersions`	String	The resource version you want to use for the run. It takes two values: resourceId: The numeric Id of the resource. resourceVersionId: The numeric Id of the resource version to be used.	Optional
`injectedPipeEnvs`	String	The environment variables declared here are available for all the steps in the pipeline.	Optional
`injectedEnvs`	String	The environment variables declared here apply only to the step that is being directly triggered.	Optional

Sample Request:

{
  "reset": true,
  "overrideVersions": [
    {
      "resourceId": 123,
      "resourceVersionId": 999
    }
  ],
  "injectedPipeEnvs": [
    {
      "key": "foo",
      "value": "bar"
    }
  ], 
  "injectedEnvs": [
    {
      "key": "string1",
      "value": "string1"
    },
    {
      "key": "string2",
      "value": "string2"
    }
  ]
}

Sample Response:

POST /pipelines/api/v1/pipelineSteps/136/trigger

{
  "ymlConfigPropertyBag": {},
  "ymlExecPropertyBag": {},
  "yml": {},
  "id": 190,
  "name": "promote",
  "masterResourceId": null,
  "typeCode": 2007,
  "latestStepId": 1098,
  "projectId": 1,
  "pipelineSourceId": 47,
  "pipelineId": 73,
  "isDeleted": false,
  "deletedAt": null,
  "isConsistent": true,
  "isStale": false,
  "staleAt": null,
  "isPaused": false,
  "createdBy": "1",
  "updatedBy": "1",
  "createdAt": "2022-02-01T18:47:49.133Z",
  "updatedAt": "2022-02-10T00:17:53.697Z"
}

Response Codes:

400: IfpipelineStepIdis not an integer orresetis in the request body and not a Boolean.

404: If nopipelineStepis found for thepipelineStepId.