As we reach the end of September 2024, ThreadFix version 3.x on-premises has officially reached its End-of-Life. Therefore, there is no longer support or updates for this version of the product. We have fully transitioned our product and development teams to focus ThreadFix SaaS and migrating all customers over from the on-premises versions. Our Customer Success and Support teams are here to help you in migrating to ThreadFix SaaS and maximizing the value you see from this improved offering from Coalfire. This is the next phase of ThreadFix and our team is looking forward to continuing to support you on this journey.
Add Remote Provider Application Mapping 3.0 - API
/rest/{version}/remoteprovider/remoteProviderApplication/{remoteProviderApplicationId}/addMapping
Descriptor | Value |
---|---|
HTTP Method | POST |
Description | Maps a ThreadFix application to the Remote Provider application. |
Required Permission | Manage Remote Providers |
Version Introduced | 2.5.0 |
Changes in 2.7.5 | Added "policyStatuses" to the REST call response. |
Changes in 2.7.5 | Added "testEnvironment", "releaseFrequency", and "isInternal" to the REST call response. |
Request Header Parameters
Parameter | Value | Required | Description |
---|---|---|---|
Accept | String | Yes | A value of ‘application/json’ must be provided. |
Request Parameters
Parameter | Value | Required | Description |
---|---|---|---|
applicationId | Integer | Yes | ID for the ThreadFix application to map to the Remote Provider application. |
reportUrl | URL | No | The version URL to use for Black Duck remote provider applications. Refer to the Get Remote Provider Application Versions API call to obtain the reportUrl value for the version to map. |
Sample Calls:
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apikey}" -X POST --data "applicationId={appid}&reportUrl=https://{hostname}.blackducksoftware.com/api/projects/{projectid}/versions/{versionid}/vulnerable-bom-components" http://localhost:8080/threadfix/rest/latest/remoteprovider/remoteProviderApplication/{remoteproviderid}/addMapping
Sample Output:
{
   "message": "",
   "success": true,
   "responseCode": -1,
   "object": {
       "id": 4,
       "nativeId": "Test Project",
       "nativeName": "Test Project",
       "customName": null,
       "versionsUrl": "https://{hostname}.blackducksoftware.com/api/projects/{projectid}/versions",
       "remoteProviderEntity": {
           "id": 2,
           "name": "BD",
           "remoteProviderType": {
               "name": "Black Duck",
               "id": 10
           }
       },
       "application": {
           "id": 1,
           "name": "Test App",
           "url": null,
           "applicationCriticality": {
               "id": 2,
               "name": "Medium"
           },
"policyStatuses": [
{
"id": 3
}
],
"description": null,
"releaseFrequency": "UNKNOWN",
"testEnvironment": null,
"isInternal": false,
"team": {
"name": "delete team",
"id": 9
}
           "team": {
               "name": "Test Team",
               "id": 1
           }
       },
       "lastImportTime": null,
       "lastImportAttemptTime": null,
       "lastImportStatus": "NOT_ATTEMPTED"
   }
}
www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.
This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.