Update a Pipeline Source

JFrog REST APIs

Products

JFrog Xray

Content Type

REST API

ft:sourceType

Paligo

Description: Updates a pipeline source.

Security: Requires admin credentials

Usage: PUT api/v1/pipelinesources

Produces: application/json

Required Parameters:

Parameter	Type	Description	Required/Optional
`projectIntegrationId`	Integer	Id of the Git integration to use to create the pipeline source. For more information, see Get Project Integrations.	Required
`environments`	Array	In a project, an array of environment names in which this pipeline source will be.	Optional
`templateId`	Integer	The id of a template to use for this pipeline source, in which case the fileFilter will only specify the values.yml.	Optional
`valuesYmlPropertyBag`	Object	An object containing values for the template as an alternative to the repository.	Optional
`branchExcludePattern`	String	For multi-branch pipeline sources, a regular expression of the branches to exclude.	Optional
`branchIncludePattern`	String	For multi-branch pipeline sources, a regular expression of the branches to include.	Optional
`fileFilter`	String	If no templateId was provided, a regular expression to determine which files to include in pipeline sync (the YML files), with default pipelines.yml. If a templateId was provided, it must be values.yml.
`isSyncing`	Boolean	True when the pipeline source is currently being synchronized, otherwise false.	Optional
`lastSyncStatusCode`	Integer	The status code of the last attempt to sync the pipeline source.	Optional
`lastSyncStartedAt`	String	The time that last sync started. Format: date-time	Optional
`lastSyncEndedAt`	String	The time the last sync ended. Format: date-time	Optional
`lastSyncLogs`	String	Logs from the last time the pipeline source was synchronized.	Optional

Sample Response:

{
  "id": 1,
  "projectId": 1,
  "templateId": 1,
  "integrationId": 1,
  "repositoryFullName": "ankul-able/sample_java",
  "branch": "master",
  "fileFilter": "pipelines.config",
  “environments”: [“DEV”, “PROD”],
  "isSyncing": false,
  "lastSyncStatusCode": 4002,
  "lastSyncStartedAt": "2019-04-15T05:39:29.627Z",
  "lastSyncEndedAt": "2019-04-15T05:39:43.478Z",
  "lastSyncLogs": "Successfully synced pipeline source\n\nSUMMARY:\n\nCreated 1 resources\nCreated 1 pipelines\nCreated 1 steps\n\nDETAILS:\n\npipelines.config: successfully created resource: sample_node\npipelines.config: successfully created pipeline: pipeline_1\npipelines.config: successfully created step: step_A\nSuccessfully created connection between step: step_A and sample_node",
  "resourceId": 1,
  "createdBy": "Service User",
  "updatedBy": "Service User",
  "createdAt": "2019-04-15T05:39:21.866Z",
  "updatedAt": "2019-04-15T05:39:43.485Z"
}

Response Codes:

200: Success

404: No pipeline found for the supplied ID