Update a Project Integration

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Updates a Project integration.

Security: Requires a valid user

Usage: PUT api/v1/projectIntegrations/{projectIntegrationId}

Produces: application/json

URL Parameters:

Parameter

Type

Description

Required/Optional

projectIntegrationId

Integer

Id of the Project integration.

Required

Request Parameters:

Parameter

Type

Description

Required/Optional

name

String

Name of the integration.

Mandatory

formJSONValues

Array

An array of objects with the values of the integration

Note

The value object does not allow empty values when isRecreated parameter is set to true.

Optional

propertyBag

Object

Object consisting of integration properties.

Optional

permissions

Object

An object containing allPipelineSourcesAllowed.

Optional

environments

Array

An array of environments to which the integration is to be available.

Optional

Sample Request

curl -L -X PUT 'https://pipe-master.jfrog-pipelines.com/pipelines/api/v1/projectIntegrations/4' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "name": "myGithub",
    "formJSONValues": [
        {
            "label": "envs",
            "value": {
                "val2": {
                    "value": "sddsfsdf",
                    "isSecure": false,
                    "isRecreated": true
                },
                "new": {
                    "value": "dfs",
                    "isSecure": false,
                    "isRecreated": false
                },
                "vsl3": {
                    "value": "dfs",
                    "isSecure": false,
                    "isRecreated": false
                }
            }
        }
    ],
    "permissions": {
        "pipelineSources": {
            "allPipelineSourcesAllowed": true
        }
    }
}'

Sample Response:

{
    "propertyBag": {},
    "id": 4,
    "name": "myGithub",
    "projectId": 1,
    "masterIntegrationId": 20,
    "masterIntegrationType": "scm",
    "masterIntegrationName": "github",
    "providerId": 34,
    "createdByUserName": "admin",
    "updatedByUserName": "admin",
    "createdBy": 3,
    "updatedBy": 3,
    "createdAt": "2019-09-25T20:32:03.753Z",
    "updatedAt": "2019-09-25T20:32:03.753Z",
    "formJSONValues": [
        {
            "label": "envs",
            "value": {
                "val2": {
                    "value": "sddsfsdf",
                    "isSecure": false,
                    "isRecreated": true
                },
                "new": {
                    "value": "dfs",
                    "isSecure": false,
                    "isRecreated": false
                },
                "vsl3": {
                    "value": "dfs",
                    "isSecure": false,
                    "isRecreated": false
                }
            }
        }
    ],
    "permissions": {
        "pipelineSources": {
            "allPipelineSourcesAllowed": true
        }
    }
}

Response Codes:

200: Success

400: Invalid parameters

404: If no Project integration is found for the supplied id