Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/rest/{version}/remoteprovider/{remoteProviderId}/sync

Descriptor

Value

HTTP Method

POST

Description

Syncs ThreadFix Remote Provider Applications for the specified Remote Provider,

adding new ones and removing any that are no longer present in the Remote Provider.

Required Permission

Manage Remote Providers

Version Introduced

2.5.0.7

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.

Sample Calls:

Code Block
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {API Key}" -X POST http://localhost:8080/threadfix/rest/latest/remoteprovider/1/sync

Sample Output:

Code Block
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "removed": [
            {
                "id": 6,
                "nativeId": "13",
                "nativeName": "Reasonable Name (CxServer)",
                "customName": null,
                "versionsUrl": null,
                "remoteProviderEntity": {
                    "id": 1,
                    "name": "CX",
                    "remoteProviderType": {
                        "name": "Checkmarx",
                        "id": 7
                    }
                },
                "application": {
                    "id": 3,
                    "name": "Reasonable Name (CxServer)",
                    "url": null,
                    "applicationCriticality": {
                        "id": 2,
                        "name": "Medium"
                    },
                    "team": {
                        "name": "Test",
                        "id": 1
                    }
                },
                "lastImportTime": null,
                "lastImportAttemptTime": null,
                "lastImportStatus": "NOT_ATTEMPTED"
            }
        ],
        "added": [
            {
                "id": 7,
                "nativeId": "13",
                "nativeName": "Edited Name (CxServer)",
                "customName": null,
                "versionsUrl": null,
                "remoteProviderEntity": {
                    "id": 1,
                    "name": "CX",
                    "remoteProviderType": {
                        "name": "Checkmarx",
                        "id": 7
                    }
                },
                "application": null,
                "lastImportTime": null,
                "lastImportAttemptTime": null,
                "lastImportStatus": "NOT_ATTEMPTED"
            }
        ],
        "unchanged": [
            {
                "id": 4,
                "nativeId": "5",
                "nativeName": "ThreadFix Test (CxServer)",
                "customName": null,
                "versionsUrl": null,
                "remoteProviderEntity": {
                    "id": 1,
                    "name": "CX",
                    "remoteProviderType": {
                        "name": "Checkmarx",
                        "id": 7
                    }
                },
                "application": {
                    "id": 5,
                    "name": "ThreadFix Test (CxServer)",
                    "url": null,
                    "applicationCriticality": {
                        "id": 2,
                        "name": "Medium"
                    },
                    "team": {
                        "name": "Test",
                        "id": 1
                    }
                },
                "lastImportTime": null,
                "lastImportAttemptTime": null,
                "lastImportStatus": "NOT_ATTEMPTED"
            }
        ]
    }
}

Page Tree
rootRemote Providers 3.0 API